HTTP API (Legacy)

<api_result>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

<api_result>
		<entries_failed>
			<numto/>
			<customerid/>
			<reason>numto invalid</reason>
		</entries_failed>
		<entries_success>
			<numto>2782*******</numto>
			<customerid>UnqiueValue1</customerid>
		</entries_success>
		<entries_success>
			<numto>2782*******</numto>
			<customerid>UnqiueValue1</customerid>
			</entries_success>
			<numto>2782*******</numto>
			<customerid>example1</customerid>
		</entries_success>
	<send_info>
		<eventid>9876543210</eventid>
		<credits>39763</credits>
		<msgs_credits_used>3</msgs_credits_used>
		<msgs_success>3</msgs_success>
		<msgs_failed>1</msgs_failed>
	</send_info>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

<senddata>
	<settings>
		<live>True</live>
		<return_credits>True</return_credits>
		<return_msgs_credits_used>True</return_msgs_credits_used>
		<return_msgs_success_count>True</return_msgs_success_count>
		<return_msgs_failed_count>True</return_msgs_failed_count>
		<return_entries_success_status>True</return_entries_success_status>
		<return_entries_failed_status>True</return_entries_failed_status>
		<default_senderid/>
		<default_date>01/Jan/2018</default_date>
		<default_time>11:15</default_time>
		<default_curdate>01/Jan/2018</default_curdate>
		<default_curtime>12:00</default_curtime>
		<default_data1>This is a default msg</default_data1>
		<default_type>SMS</default_type>
    <default_costcentre>NA</default_costcentre>
    <default_campaignname>NA</default_campaignname>
		<mo_forwardemail>[email protected]</mo_forwardemail>
		<default_validityperiod>24</default_validityperiod>
	</settings>
		<entries>
			<numto>082*******</numto>
			<customerid>UnqiueValue1</customerid>
			<senderid>Test me</senderid>
			<time>12:00</time>
			<data1>This is a test message 1!</data1>
			<type>SMS</type>
			<costcentre>NA</costcentre>
      <campaignname>NA</campaignname>
			<validityperiod>48</validityperiod>
		</entries>
</senddata>

<api_result>
    <entries_failed>
        <numto/>
        <customerid/>
        <reason>numto invalid</reason>
        </entries_failed>
        <entries_success>
        <numto>2782*******</numto>
        <customerid>UnqiueValue1</customerid>
        </entries_success>
        <entries_success>
        <numto>2782*******</numto>
        <customerid>UnqiueValue1</customerid>
    </entries_success>
    <entries_success>
        <numto>27832297941</numto>
        <customerid>example</customerid>
    </entries_success>
    <send_info>
        <eventid>9876543210</eventid>
        <credits>39763</credits>
        <msgs_credits_used>3</msgs_credits_used>
        <msgs_success>3</msgs_success>
        <msgs_failed>1</msgs_failed>
    </send_info>
    <call_result>
        <result>True</result>
        <error/>
    </call_result>
</api_result>

<api_result>
	<data>
		<changeid>21437610891</changeid>
		<sentid>67393185816</sentid>
		<eventid>6403219457</eventid>
		<smstype>Sms</smstype>
		<numto>278********</numto>
		<data>This is a test msg</data>
		<customerid>UnqiueValue1</customerid>
		<status>DELIVRD</status>
		<statusdate>1/Jan/2024 07:53:09</statusdate>
	</data>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

<api_result>
	<data>
		<replyid>509871807</replyid>
		<eventid>6414283881</eventid>
		<numfrom>278********</numfrom>
		<receiveddata>Reply Received</receiveddata>
		<sentid>67758922377</sentid>
		<sentdata>my test msg reply</sentdata>
		<sentcustomerid>UnqiueValue1</sentcustomerid>
		<received>19/Jan/2024 13:40:58</received>
		<sentdatetime>19/Jan/2024 13:40:49</sentdatetime>
		<optout>false</optout>
	</data>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

<sent>
	<settings>
		<id>0</id>
		<max_recs>100</max_recs>
		<cols_returned>sentid,eventid,numto,data</cols_returned>
		<date_format>dd/MMM/yyyy HH:mm:ss</date_format>
	</settings>
</sent>

<reply>
	<settings>
		<id>0</id>
		<max_recs>100</max_recs>
		<cols_returned>sentid,sentdata,received,sentdatetime,optout</cols_returned>
		<date_format>dd/MMM/yyyy HH:mm:ss</date_format>
	</settings>
</reply>

<api_result>
	<data>
		<replyid>509871807</replyid>
		<eventid>6414283881</eventid>
		<numfrom>278*******</numfrom>
		<receiveddata>Testing</receiveddata>
		<sentid>67758922377</sentid>
		<sentdata>Testing Replies</sentdata>
		<sentcustomerid>UnqiueValue1</sentcustomerid>
		<received>19/Jan/2024 13:40:58</received>
		<sentdatetime>19/Jan/2024 13:40:49</sentdatetime>
		<optout>false</optout>
	</data>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

<api_result>
	<data>
		<credits>xxxxx</credits>
	</data>
	<call_result>
		<result>True</result>
		<error/>
	</call_result>
</api_result>

package co.za.smsportal.sample;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

/**
 * SampleCreditChecker is an example that demonstrates how to connect to 
 * MyMobileApi. It by no means is a complete and robust solution and should not
 * be used in any production code.
 */
public class SampleCreditChecker {

	public static final String MY_MOBILE_API_URL = 
		"http://api.smsportal.com/api5/http5.aspx?";
	private URLConnection urlConnection;
	
	/**
	 * Initializes a new SampleCreditChecker which will check the number of 
	 * credits available for a given username and password.
	 * 
	 * @param urlConnection	A URLConnection containing a URL to the API.
	 */
	public SampleCreditChecker(URLConnection urlConnection) {
		this.urlConnection = urlConnection;
	}
	
	/**
	 * Gets the number of credits available for the specified username and 
	 * password.
	 * 
	 * @param username	The username.
	 * @param password	The password for the username.
	 * @return			A integer value indicating how many credits the user has
	 * @throws Exception 
	 */
	public int getCredits(String username, String password) throws Exception {
		try {
			//Set DoInput to true so that we can write to the server.
			urlConnection.setDoInput(true);
			//Set DoOutput to true so that we can read from the server.
			urlConnection.setDoOutput(true);
			
			//Create a writer to the server.
			OutputStream raw = urlConnection.getOutputStream();
			OutputStream buffered = new BufferedOutputStream(raw);
			OutputStreamWriter writer = new OutputStreamWriter(buffered, 
					"8859_1");
			
			//Write the following to the server via the URL.
			writer.write("type=credits&username=" + username 
					+ "&password=" + password);
			
			//Don't forget to flush and close the writer.
			writer.flush();
			writer.close();
			
			//Parse the returned XML. Use the InputStream from the connection.
			return parseXmlForCredits(urlConnection.getInputStream());
		} catch (ParserConfigurationException e) {
			System.out.println("Parser Configuration Exception");
			e.printStackTrace();
		} catch (SAXException e) {
			System.out.println("SAX Exception");
			e.printStackTrace();
		}
		return -1;
	}
	
	private int parseXmlForCredits(InputStream stream) 
	throws Exception {
		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
		DocumentBuilder builder = factory.newDocumentBuilder();
		Document document = builder.parse(stream);
		
		//First check if there are any errors.
		NodeList errors = document.getElementsByTagName("error");
		if (errors.getLength() > 0) {
			Node errorNode = errors.item(0);
			String errorMsg = errorNode.getTextContent();
			if (!errorMsg.isEmpty()) 
				throw new Exception("Error getting credits. " + errorMsg);
		}
		
		//Now check for the number of credits.
		NodeList nodes = document.getElementsByTagName("credits");
		Node creditNode = nodes.item(0);
		return Integer.parseInt(creditNode.getTextContent());
	}
	
	/**
	 * Main entry point for sample.
	 * 
	 * @param args	Command line arguments.
	 */
	public static void main(String[] args) {
		URL url;
		try {
			url = new URL(MY_MOBILE_API_URL);
			URLConnection urlConnection = url.openConnection();
			SampleCreditChecker client = new SampleCreditChecker(urlConnection);
			
			//Please note that xxx and yyy are NOT real usernames and passwords
			//Susbsitute your own username and password.
			int nrCredits = client.getCredits("xxx", "yyy");
			System.out.println("Number of credits = " + nrCredits);
		} catch (MalformedURLException me) {
			System.out.println("The URL is malformed. " + MY_MOBILE_API_URL);
			me.printStackTrace();
		} catch (IOException ioe) {
			System.out.println("An IO Exception has occured.");
			ioe.printStackTrace();
		} catch (Exception e) {
			System.out.append(e.getMessage());
			e.printStackTrace();
		}
	}
}

<?php
    
class MyMobileAPI
{

    public function __construct() {
        $this->url = 'http://api.smsportal.com/api5/http5.aspx';
        $this->username = 'someusername'; //your login username
        $this->password = 'somepassword'; //your login password
      //$this->validityperiod = '24'; //optional- set desired validity (represents hours)
    }
    
    public function checkCredits() {
        $data = array(
            'Type' => 'credits', 
            'Username' => $this->username,
            'Password' => $this->password
        );
        $response = $this->querySmsServer($data);
        // NULL response only if connection to sms server failed or timed out
        if ($response == NULL) {
            return '???';
        } elseif ($response->call_result->result) {
	    echo '</br>Credits: ' .  $response->data->credits;
            return $response->data->credits;
        }
    }
    
   public function sendSms($mobile_number, $msg) {
        $data = array(
            'Type' => 'sendparam', 
            'Username' => $this->username,
            'Password' => $this->password,
            'numto' => $mobile_number, //phone numbers (can be comma seperated)
            //'validityperiod' => $this->validityperiod, //the duration of validity
            'data1' => $msg //your sms message
	   			
        );
        $response = $this->querySmsServer($data);
        return $this->returnResult($response);
    }
    
    // query API server and return response in object format
    private function querySmsServer($data, $optional_headers = null) {

        $ch = curl_init($this->url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        // prevent large delays in PHP execution by setting timeouts while connecting and querying the 3rd party server
        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT_MS, 2000); // response wait time
        curl_setopt($ch, CURLOPT_TIMEOUT_MS, 2000); // output response time
        $response = curl_exec($ch);
        if (!$response) return NULL;
        else return new SimpleXMLElement($response);
    }

    // handle sms server response
    private function returnResult($response) {
        $return = new StdClass();
        $return->pass = NULL;
        $return->msg = '';
        if ($response == NULL) {
            $return->pass = FALSE;
            $return->msg = 'SMS connection error.';
        } elseif ($response->call_result->result) {
            $return->pass = 'CallResult: '.TRUE . '</br>';
	    $return->msg = 'EventId: '.$response->send_info->eventid .'</br>Error: '.$response->call_result->error;
        } else {
            $return->pass = 'CallResult: '.FALSE. '</br>';
            $return->msg = 'Error: '.$response->call_result->error;
        }
	echo $return->pass; 
	echo $return->msg; 
        return $return; 
    }
    
}


//Execute script
$test = new MyMobileAPI();
$test->sendSms('0810000000','Test Message'); //Send SMS
$test->checkcredits(); //Check your credit balance


?>