SMS Aggregation - API Documentation

Transcription

1 SMS Aggregation - API Documentation Wireless Logic Version Issue Date - 20th February 2014 Wireless Logic Ltd Grosvenor House Horseshoe Crescent Beaconsfield, Buckinghamshire HP9 1LJ Tel: +44 (0) Web :

2 Section 1. Wireless Logic Quality Control 1.1 Document Properties Client Assignment Document Title Wireless Logic Reference Client Reference Document Status Wireless Logic SMS Aggregation API Documentation None None Working Draft 1.2 Version History Author Date Version Paul Mansell 19th December Paul Mansell 27th February Matt Thomas 14th March Paul Mansell 20th February Company Confidential Page 2

3 Section 2. Contents Section 1. Wireless Logic Quality Control Document Properties Version History... 2 Section 2. Contents... 3 Section 3. Overview... 4 Section 4. Mobile Terminated Messages SOAP Request REST Request... 9 Section 5. Delivery receipt SOAP API REST API Section 6. Mobile Originated Messages SOAP API REST API Section 7. Testing Section 8. Code examples Sending an SMS SOAP REST Sending a wake-up message SOAP REST Receiving a Delivery Receipt SOAP REST Receiving an SMS SOAP REST Company Confidential Page 3

4 Section 3. Overview The Wireless Logic SMS API allows SMS messages to be sent to and from mobile devices. Sending a message to a mobile device, which is called a Mobile Terminated (MT) message, involves a simple request to the Wireless Logic API. The option of receiving a delivery receipt is also available for MT messages. Receiving a message from a mobile device, which is called a Mobile Originated (MO) message, requires you to create an API that you host to receive requests from the Wireless Logic SMS API. The following diagram shows you this in more detail All communication with the Wireless Logic SMS API must use Transport Layer Security (TLS) to ensure that network communication is encrypted. Details and examples of the above follow in this document. For further help please contact Wireless Logic on support@wirelesslogic.com. Company Confidential Page 4

5 Section 4. Mobile Terminated Messages Sending an SMS to a mobile device requires a call to the Wireless Logic SMS API. The API supports SOAP and REST request formats, with the REST request allowing both XML and JSON data formats. To make a call to the API you need to include a user Id and password these will be provided when you register to use the API. The API supports sending an SMS message using the send method and sending a wake-up message using the wakeup method. The Wireless Logic SMS API will respond to your API call by immediately returning either a success or failure result this is to indicate whether or not the message has been sent. To receive notification regarding the delivery status of that message you can implement a delivery receipt API and receive notification when the message either expires or is delivered. This is covered later in this section. Each of the requests to the Wireless Logic SMS API allow flexibility in identifying the recipient of the SMS Message by allowing you to specify either an ICCID, IMSI or MSISDN. Please note that when specifying the MSDISN it should include both the country code and subscriber number, for example for a UK SIM. The following sections give details on how to connect to the SMS API and what information should be sent and what you should expect to receive in response. 4.1 SOAP Request The Wireless Logic SMS API supports SOAP and supplies a Web Services Description Language (WSDL) file for easy interaction. The WSDL is available at There are 3 SOAP functions available - SendWakeup, which sends a wake-up message in the form of an SMS to the mobile device, SendSMS which sends a Text SMS message to a mobile device and SendBinarySMS which sends a Binary SMS Message to a mobile device. Currently the SendWakeup request is only available on SIMs using the Vodafone Global network. The WSDL and the calls to the functions defined within the WSDL require HTTP Basic Authentication using the user id and password you have been supplied Company Confidential Page 5

6 The SOAP Body for the SendSMS function must contain the following parameters ident Identification e.g. Mobile phone number (MSISDN) / IMSI or String ICCID identtype The type of the ident. Options are IMSI, MSISDN or ICCID String IMSI message The message text to send. Limited to 160 characters String Text Message messageid A correlation Id this will be included on the response and String 1234 on delivery receipts should you wish to enable this feature inbox Optional the inbox name you want replies sent to String inboxname The response from the SendSMS function is Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 The SOAP Body for the SendBinarySMS function must contain the following parameters ident Identification e.g. Mobile phone number (MSISDN) / String IMSI or ICCID identtype The type of the ident. Options are IMSI, MSISDN or String IMSI ICCID udh The User Data Header in HEX format d10000 message The message text to send in HEX format. Limited to 140 String 0B747A6163 characters messageid A correlation Id this will be included on the response String 1234 and on delivery receipts should you wish to enable this feature inbox Optional the inbox name you want replies sent to String inboxname The response from the SendBinarySMS function is Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 The SOAP Body for the SendWakeup function must contain the following parameters Ident Identification e.g. mobile phone number (MSISDN) / IMSI or String ICCID identtype The type of the ident. Options are IMSI, MSISDN or ICCID String IMSI messageid A correlation Id this will be included on the response String 1234 Company Confidential Page 6

7 The response from the SendWakeup function is Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 Company Confidential Page 7

8 The following SOAP request example sends an SMS to a mobile device <soapenv:envelope xmlns:soapenv=" xmlns:con=" <soapenv:header> </soapenv:header> <soapenv:body> <con:sendsms> <SendSMSRequest> <ident> </ident> <identtype>imsi</identtype> <message>test Message</message> <messageid>1</messageid> </SendSMSRequest> </con:sendsms> </soapenv:body> </soapenv:envelope> The above would send the message Test Message to a mobile device using a SIM with the IMSI of The response would be <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:ns1=" <SOAP-ENV:Body> <ns1:sendsmsresponse> <return> <status>true</status> <messageid>1</messageid> </return> </ns1:sendsmsresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> The above response shows a successful SMS message being sent (status = true) and the message Id from the request. There are code examples showing how to use the Wireless Logic SMS API available in the Code Examples section at the end of this document Company Confidential Page 8

9 4.2 REST Request The Wireless Logic SMS API supports both XML and JSON request formats for REST requests, the response format will be in the same format as the request. There are 3 REST functions available - wakeup, which sends a wake-up message in the form of an SMS to the mobile device, send which sends a Text SMS message to a mobile device and send_binary which sends a Binary SMS message to a mobile device. Currently the wakeup function is only available on SIMs using the Vodafone Global network. The URL for REST requests is For example to send an SMS message using a JSON request format the URL would be The REST API requires you to authenticate using HTTP Basic Authentication using the user id and password supplied by Wireless Logic. A send request must contain the following parameters ident Identification e.g. Mobile phone number (MSISDN) / IMSI or String ICCID identtype The type of the ident. Options are IMSI, MSISDN or ICCID String IMSI message The message text to send. Limited to 160 characters String Text Message messageid A correlation Id this will be included on the response and String 1234 on the delivery receipt if you enable this feature inbox Optional the inbox name you want replies sent to String inboxname The response to a send request will contain the following parameters Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 A send_binary request must contain the following parameters ident Identification e.g. Mobile phone number (MSISDN) / String IMSI or ICCID identtype The type of the ident. Options are IMSI, MSISDN or String IMSI ICCID udh The User Data Header in HEX format d10000 message The message text to send in HEX format. Limited to 140 String 0B747A6163 characters messageid A correlation Id this will be included on the response String 1234 Company Confidential Page 9

10 and on the delivery receipt if you enable this feature inbox Optional the inbox name you want replies sent to String inboxname The response to a send_binary request will contain the following parameters Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 Company Confidential Page 10

11 The request to the wakeup function must contain the following parameters Ident Identification e.g. mobile phone number (MSISDN) or IMSI String identtype The type of the ident. Options are IMSI, MSISDN or ICCID String IMSI messageid A correlation Id this will be included on the response String 1234 The response parameters from the wakeup request are Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN messageid The correlation id from the request String 1234 The following JSON example sends an SMS to a mobile device "ident": " ", "identtype": "imsi", "message": "Test Message", "messageid": "1" This would send the message Test Message to the mobile device with a SIM having an IMSI of The response would be "status": true, "status_message": "", "message_id": "1" The above response shows a successful SMS message being sent (status = true) and the message Id from the request. Company Confidential Page 11

12 The equivalent XML request would be <?xml version="1.0" encoding="utf-8"?> <document> <ident> </ident> <identtype>imsi</identtype> <message>test Message</message> <messageid>1</messageid> </document> The response would be <?xml version="1.0" encoding="utf-8"?> <result> <status>true</status> <status_message> <![CDATA[]]> </status_message> <message_id> <![CDATA[1]]> </message_id> </result> There are code examples showing how to use the Wireless Logic SMS API available in the Code Examples section at the end of this document Company Confidential Page 12

13 Section 5. Delivery receipt The Wireless Logic SMS API will respond to your API call by immediately returning either a success or failure result this is to indicate whether or not the message has been sent. To receive notification regarding the delivery status of that message you can implement a delivery receipt API and receive notification when the message either expires or is delivered. The details of your API (format accepted and URL details) will be agreed when your setup your agreement with Wireless Logic to use the SMS API. We currently support making a SOAP or REST (XML or JSON data format) request to your API. The following sections details how the call will be made to your API and what data you can expect to receive SOAP API If you wish to receive delivery receipts to your SOAP API you must accept a SOAP request for the method DeliveryReceipt that contains a WLAuth object within the SOAP Header with the following userid Userid* String User password Password* String Pass *These parameters will be agreed upon setup of the SMS API. And a SOAP Body containing a DeliveryReceiptRequest object with the following parameters messageid The correlation Id you specified when sending the message String 1234 status The status of the message either delivered or expired String delivered Your API must respond with the following DeliveryReceiptResponse object Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to process request If your API responds with a status of false then the request will be attempted up to a maximum of 3 times, first after 1 minute then after 5 minutes and then finally after 30 minutes of the original request. Company Confidential Page 13

14 An example SOAP request sent to your API would be <soapenv:envelope xmlns:soapenv=" xmlns:con=" <soapenv:header> <WLAuth> <userid>user</userid> <password>pass</password> </WLAuth> </soapenv:header> <soapenv:body> <con:deliveryreceipt> <DeliveryReceiptRequest> <messageid>1234</ messageid > <status>delivered</ status > </ DeliveryReceiptRequest > </con: DeliveryReceipt > </soapenv:body> </soapenv:envelope> An example response would be <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:ns1=" <SOAP-ENV:Body> <ns1: DeliveryReceiptResponse> <return> <status>true</status> <statusmessage/> </return> </ns1: DeliveryReceiptResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> The code examples section contains an example SOAP Server for receiving and responding to requests from the Wireless Logic SMS API REST API If you wish to receive delivery receipts to your REST API you must accept either JSON or XML within the request body. All transactions from the Wireless Logic SMS API will be sent using an HTTP POST. The request from the Wireless Logic SMS API will contain the following elements. WLAuth element with the following parameters userid Userid* String User password Password* String Pass *These parameters will be agreed upon setup of the SMS API. Company Confidential Page 14

15 And the following POST data messageid The correlation Id you specified when sending the message String 1234 status The status of the message either delivered or expired String delivered A response must be sent back to the Wireless Logic SMS API and must contain the following status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to process request If your API responds with a status of false then the request will be attempted up to a maximum of 3 times, first after 1 minute then after 5 minutes and then finally after 30 minutes of the original request. An example JSON request sent to your API would be "wlauth": "userid": "user", "password": "pass", "messageid": "1234", "status": "delivered" With the expected response of "status": true, "statusmessage": "" And an example XML request sent to your API would be <?xml version="1.0" encoding="utf-8"?> <document> <wlauth> <userid>user</userid> <password>pass</password> </wlauth> <messageid>1234</ messageid > <status>delivered</status> </document> Company Confidential Page 15

16 With the expected response of <?xml version="1.0" encoding="utf-8"?> <result> <status>true</status> <statusmessage> <![CDATA[]]> </statusmessage> </result> The code examples section contains an example for receiving and responding to REST requests from the Wireless Logic SMS API. Company Confidential Page 16

17 Section 6. Mobile Originated Messages Mobile Originated (MO) messages are SMS messages that are sent from a mobile device to the Wireless Logic SMS API, the SMS API will then log the request and make a call to your API. The Wireless Logic SMS API supports SOAP and REST calls to your API. The details of your API (format accepted and URL details) will be agreed when your setup your agreement with Wireless Logic to use the SMS API. We currently support making a SOAP or REST (XML or JSON data format) request to your API. To enable the Wireless Logic SMS API to make the call to your API you need to setup your API to accept a request and send a response that matches the parameters detailed below. 6.1 SOAP API If you wish to receive MO messages to your SOAP API you must accept a SOAP request for the method SendSMS that contains a WLAuth object within the SOAP Header with the following userid Userid* String User password Password* String Pass *These parameters will be agreed upon setup of the SMS API. And a SOAP Body containing a SMSRequest object with the following parameters ident Identification e.g. Mobile phone number (MSISDN) String or IMSI identtype The type of the ident. Options are IMSI, MSISDN or String IMSI ICCID message The message text sent this will be base64 encoded String VGVzdCBNZXNzYWdl Your API must respond with the following SMSResponse object Status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN If your API responds with a status of false then the request will be attempted up to a maximum of 3 times, first after 1 minute then after 5 minutes and then finally after 30 minutes of the original request. An example SOAP request sent to your API would be <soapenv:envelope xmlns:soapenv=" xmlns:con=" <soapenv:header> Company Confidential Page 17

18 <WLAuth> <userid>user</userid> <password>pass</password> </WLAuth> </soapenv:header> <soapenv:body> <con:sendsms> <SMSRequest> <ident> </ident> <identtype>imsi</identtype> <message>vgvzdcbnzxnzywdl</message> </SMSRequest> </con:sendsms> </soapenv:body> </soapenv:envelope> An example response would be <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:ns1=" <SOAP-ENV:Body> <ns1:sendsmsresponse> <return> <status>true</status> <statusmessage/> </return> </ns1:smsresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> The code examples section contains an example SOAP Server for receiving and responding to requests from the Wireless Logic SMS API. 6.2 REST API If you wish to receive MO messages to your REST API you must accept either JSON or XML within the request body. All transactions from the Wireless Logic SMS API will be sent using an HTTP POST. The request from the Wireless Logic SMS API will contain the following elements. WLAuth element with the following parameters Company Confidential Page 18

19 Userid Userid* String User password Password* String Pass *These parameters will be agreed upon setup of the SMS API. And the following POST data Ident Identification e.g. Mobile phone number (MSISDN) / String IMSI or ICCID identtype The type of the ident. Options are IMSI, MSISDN or String IMSI ICCID message The message text sent this will be base64 encoded String VGVzdCBNZXNzYWdl A response must be sent back to the Wireless Logic SMS API and must contain the following status If the execution was successful or not. True or Boolean True False is returned. statusmessage If status is false then this will contain error information String Unable to find MSISDN If your API responds with a status of false then the request will be attempted up to a maximum of 3 times, first after 1 minute then after 5 minutes and then finally after 30 minutes of the original request. An example JSON request sent to your API would be "wlauth": "userid": "user", "password": "pass", "ident": " ", "identtype": "imsi", "message": "VGVzdCBNZXNzYWdl" With the expected response of "status": true, "statusmessage": "" Company Confidential Page 19

20 And an example XML request sent to your API would be <?xml version="1.0" encoding="utf-8"?> <document> <wlauth> <userid>user</userid> <password>pass</password> </wlauth> <ident> </ident> <identtype>imsi</identtype> <message>vgvzdcbnzxnzywdl</message> </document> With the expected response of <?xml version="1.0" encoding="utf-8"?> <result> <status>true</status> <statusmessage> <![CDATA[]]> </statusmessage> </result> The code examples section contains an example for receiving and responding to REST requests from the Wireless Logic SMS API. Company Confidential Page 20

21 Section 7. Testing To test the API you can send messages to specific numbers detailed below. These test numbers allow you to test both delivery receipts and MO messages. To enable testing the API you need to send a message to any of the following numbers SendTo Action/Effect Message is received and a delivery receipt is generated with the status of delivered Message is received and a delivery receipt is generated with the status of expired Message is received and a Mobile Originated message is generated the MO message is sent to An example JSON request to generate a delivered delivery receipt would be: "ident": " ", "identtype": "imsi", "message": "Test Message", "messageid": "1" Company Confidential Page 21

22 Section 8. Code examples This section contains code examples for use with the Wireless Logic SMS API 8.1 Sending an SMS The following examples show how to send an SMS message to a mobile device SOAP This example is written in PHP and sends an SMS message to a mobile device using the SOAP interface // init soap client $service = new SoapClient(' // call sendsms and get result $result = $service->sendsms(array( 'ident' => ' ', 'identtype' => 'imsi', 'message' => 'Test Message', 'messageid' => '123' )); // output result if ($result->status) echo "Message sent"; else // output error message echo "Error sending message - ". $result->statusmessage; Company Confidential Page 22

23 8.1.2 REST This example is written in PHP and sends an SMS message to a mobile device using the REST interface using JSON data format // setup parameters $params = array( 'ident' => ' ', 'identtype' => 'imsi', 'message' => 'JSON Test', 'messageid' => '1' ); // setup url $url = ' // json encode params $data_string = json_encode($params); // make request $ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/json', 'Content-Length: '. strlen($data_string) ) ); $result = curl_exec($ch); // output result print_r($result); This example is written in PHP and sends an SMS message to a mobile device using the REST interface using XML data format // parameters $params = <<<XML <?xml version="1.0" encoding="utf-8"?> <document> <ident> </ident> <identtype>imsi</identtype> <message>test Message</message> <messageid>1</messageid> </document> XML; // convert string to xml $xml = simplexml_load_string($params); // setup url $url = ' // make request $ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml->asxml()); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/xml', Company Confidential Page 23

24 'Content-Length: '. strlen($xml->asxml()) ) ); $result = curl_exec($ch); // output result print_r($result); 8.2 Sending a wake-up message The following examples show how to send an SMS message to a mobile device SOAP This example is written in PHP and sends a wake-up message to a mobile device using the SOAP interface // init soap client $service = new SoapClient(' // call sendsms and get result $result = $service->sendwakeup(array( 'ident' => ' ', 'identtype' => 'imsi', 'messageid' => '123' )); // output result if ($result->status) echo "Message sent"; else // output error message echo "Error sending message - ". $result->statusmessage; REST This example is written in PHP and sends a wake-up message to a mobile device using the REST interface and XML data format // parameters $params = <<<XML <?xml version="1.0" encoding="utf-8"?> <document> <ident> </ident> <identtype>imsi</identtype> <messageid>1</messageid> </document> XML; // convert string to xml $xml = simplexml_load_string($params); // setup url $url = ' Company Confidential Page 24

25 // make request $ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml->asxml()); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/xml', 'Content-Length: '. strlen($xml->asxml()) ) ); $result = curl_exec($ch); // output result print_r($result); Company Confidential Page 25

26 This example is written in PHP and sends a wake-up message to a mobile device using the REST interface and XML data format // setup parameters $params = array( 'ident' => ' ', 'identtype' => 'imsi', 'messageid' => '1' ); // setup url $url = ' // json encode params $data_string = json_encode($params); // make request $ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/json', 'Content-Length: '. strlen($data_string) ) ); $result = curl_exec($ch); // output result print_r($result); 8.3 Receiving a Delivery Receipt The following examples show how to receive a delivery receipt from the Wireless Logic SMS API SOAP This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response // define a class to handle request class MyClass public $user; public $password; public $authenticated = false; // this will process the request public function DeliveryReceipt($DeliveryReceiptRequest) // check authenticated if (!$this->authenticated) $response = new stdclass(); $response->status = false; $response->statusmessage = 'Incorrect User and Pass'; return $response; // Array $DeliveryReceiptRequest gives you access to the incoming data Company Confidential Page 26

27 $messageid = $DeliveryReceiptRequest ->messageid; $status= $DeliveryReceiptRequest->status; // create and response $response = new stdclass(); $response->status = true; $response->statusmessage = ''; return $response; // this function will process the header with the same name public function WLAuth($wlauth) $this->user = $wlauth->userid; $this->password = $wlauth->password; // check if userid / password are correct if ($this->user == 'user' $this->password == 'pass') $this->authenticated = true; // setup SOAPServer and handle request $server = new SOAPServer( NULL, array( 'uri' => ' ) ); // specify the class that will handle request $server->setclass('myclass'); $server->handle(); REST This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response using the JSON data format // get request body $post_body = file_get_contents('php://input'); // decode json $DeliveryReceiptRequest = json_decode($post_body); // check header If ($DeliveryReceiptRequest ->wlauth->userid!= user && $DeliveryReceiptRequest ->wlauth- >password!= pass) // handle authentication failure // extract values $messageid = $DeliveryReceiptRequest ->messageid; $status = $DeliveryReceiptRequest->status; // create a response $response = array( 'status' => true, 'statusmessage' => '' ); // encode and output echo json_encode($response); Company Confidential Page 27

28 This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response using the XML data format // get request body $post_body = file_get_contents('php://input'); error_log($post_body); $DeliveryReceiptRequest = simplexml_load_string($post_body); // check header If ($DeliveryReceiptRequest ->wlauth->userid!= user && $DeliveryReceiptRequest ->wlauth- >password!= pass) // handle authentication failure // extract values $messageid = $DeliveryReceiptRequest ->messageid; $status = $DeliveryReceiptRequest->status; // create a response $xml = <<<XML <?xml version="1.0" encoding="utf-8"?> <result> <status>true</status> <statusmessage> <![CDATA[]]> </statusmessage> </result> XML; $response = simplexml_load_string($xml); // encode and output echo $response->asxml(); Company Confidential Page 28

29 8.4 Receiving an SMS The following examples show how to receive an SMS message from the Wireless Logic SMS API SOAP This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response // define a class to handle request class MyClass public $user; public $password; public $authenticated = false; // this will process the request public function sendsms($smsrequest) // check authenticated if (!$this->authenticated) $response = new stdclass(); $response->status = false; $response->statusmessage = 'Incorrect User and Pass'; return $response; // Array $SMSRequest gives you access to the incoming data $message = base64_decode($smsrequest->message); // create and response $response = new stdclass(); $response->status = true; $response->statusmessage = ''; return $response; // this function will process the header with the same name public function WLAuth($wlauth) $this->user = $wlauth->userid; $this->password = $wlauth->password; // check if userid / password are correct if ($this->user == 'user' $this->password == 'pass') $this->authenticated = true; // setup SOAPServer and handle request $server = new SOAPServer( NULL, array( 'uri' => ' ) ); // specify the class that will handle request $server->setclass('myclass'); $server->handle(); Company Confidential Page 29

30 8.4.2 REST This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response using the JSON data format // get request body $post_body = file_get_contents('php://input'); // decode json $SMSRequest = json_decode($post_body); // check header If ($SMSRequest->wlauth->userid!= user && $SMSRequest->wlauth->password!= pass) // handle authentication failure // extract values $message = base64_decode($smsrequest->message); // create a response $response = array( 'status' => true, 'statusmessage' => '' ); // encode and output echo json_encode($response); This example is written in PHP receives a request from the Wireless Logic SMS API and sends back a response using the XML data format // get request body $post_body = file_get_contents('php://input'); error_log($post_body); $SMSRequest = simplexml_load_string($post_body); // check header If ($SMSRequest->wlauth->userid!= user && $SMSRequest->wlauth->password!= pass) // handle authentication failure // extract values $message = base64_decode($smsrequest->message); // create a response $xml = <<<XML <?xml version="1.0" encoding="utf-8"?> <result> <status>true</status> <statusmessage> <![CDATA[]]> </statusmessage> </result> XML; $response = simplexml_load_string($xml); // encode and output echo $response->asxml(); Company Confidential Page 30