SMS SOAP - API
Preface
Welcome to the GuidebyCell SOAP - API. This document provides a reference for all features available to you via the SOAP Web Service for sending SMS.
Overview
The SOAP - API allows you to integrate your Client Application (Client) to GuidebyCell (Vendor) using the SOAP protocol. SOAP exchanges XML based messages over
HTTP(S).
Methods
Please find below a list of methods for this API.
Sending a SOAP Request
SOAP methods can be called by sending a SOAP formatted XML document via HTTP POST to the following URL:
URL:https://ws.guidebycell.com/SMSService
WSDL
The WSDL for this service can be found here:
https://ws.guidebycell.com/SMSService?wsdl
Send SMS
Send SMS Request
To send an SMS, call the method smsSend
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| phone |
string array |
One ore more phones to receive text message |
| message |
string |
Text Message,160 maximum texts allowed |
Send SMS Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description
- Data Texts sent
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsSend>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<phone>4155098135</phone>
<message>test</message>
</sms:smsSend>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsSendResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<status>Success</status>
<data>1 message has sent</data>
</return>
</ns2:smsSendResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Sending SMS To list
Send SMS to list Request
To send an SMS to list, call the method smsSendToList
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| listName |
int |
list name |
| message |
string |
Text Message,160 maximum texts allowed |
Send SMS to list Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description
- Data Texts sent
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsSendToList>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<listName>list1</listName>
<message>test</message>
</sms:smsSendToList>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsSendToListResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<status>Success</status>
<data>1 message has sent</data>
</return>
</ns2:smsSendToListResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Create New List
Create New List Request
To create a new List, call the method smsCreateList
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| listName |
string |
New list name |
Create New List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description or list id
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsSendToList>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<listName>newList</listName>
</sms:smsSendToList>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsSendToListResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<status>Success</status>
<description>23</description>
</return>
</ns2:smsSendToListResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Get Lists
Get Lists Request
To get lists, call the method smsGetLists
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
Get Lists Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description
- Date lists xml string
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsGetLists>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
</sms:smsGetLists>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Body>
<sms:smsGetListsResponse>
<return>
<status>Success</status>
<data xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"><![CDATA[<list>
<list>
<id>953</id>
<name>jun test</name>
</list>
<list>
<id>955</id>
<name>testing</name>
</list>
</list>]]]]><![CDATA[></data>
</return>
</sms:smsGetListsResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Delete A List
Delete A List Request
To delete a list, call the method smsDeleteList
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| listName |
string |
listName to delete |
Delete List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error or success description
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsDeleteList>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<listName>list1</listName>
</sms:smsDeleteList>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsDeleteListResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<description>Success</description>
<status>The list is deleted</status>
</return>
</ns2:smsDeleteListResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Get Contact List Of A List
Get Contact List Request
To get contact list, call the method smsGetContacts
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| listName |
string |
listName of contacts |
Get Contact List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description
- Data Contact list xml string
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsGetContacts>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<listName>list1</listName>
</sms:smsGetContacts>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsGetContactsResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<data xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"><![CDATA[<list>
<contact>
<id>626</id>
<firstName>Christopher</firstName>
<lastName>Bailey</lastName>
<phone>4152134566</phone>
</contact>
<contact>
<id>5946</id>
<firstName>Annie</firstName>
<lastName>Jones</lastName>
<phone>4155098135</phone>
</contact>
</list>]]]]><![CDATA[></data>
<status>Success</status>
</return>
</ns2:smsGetContactsResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Create New Contact Of A List
Create New Contact Request
To create new contact, call the method smsAddContact
| Parameter |
Type |
Description |
| data |
string |
json format,like this
{"user":"example@guidebycell.com","password":"12345678","entryId":"123","listName":"list1",data:{["phone":"4155098135","firstName":"Christopher","lastName":"Bailey"],["phone":"4155098136","firstName":"Annie","lastName":"Jones"]}}
|
Get Contact List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error description
- Data Contact list xml string
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsAddContact>
<data>
{"user":"example@guidebycell.com","password":"12345678","entryId":"123","listName":"list1",data:{["phone":"4155098135","firstName":"Christopher","lastName":"Bailey"],["phone":"4155098136","firstName":"Annie","lastName":"Jones"]}}
</data>
</sms:smsAddContact>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsAddContactResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<status>Success</status>
<description>2 contacts added</description>
</return>
</ns2:smsAddContactResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Delete A Contact
Delete A Contact Request
To delete a contact, call the method smsDeleteContact
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| listName |
int |
list name |
| phone |
string |
phone number |
Delete Contact Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error or success description
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsDeleteContact>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<listName>list1</listName>
<contactId>123</contactId>
</sms:smsDeleteContact>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsDeleteContactResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<description>Success</description>
<status>The contact is deleted</status>
</return>
</ns2:smsDeleteContactResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Get Inbound List
Get Inbound List Request
To get inbound list, call the method smsReceived
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| starttime |
string |
Start time like this 2015-08-25 |
| endtime |
string |
End time like this 2015-08-25 |
Get Inbound List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error or success description
- Data Inbound list xml string
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsReceived>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<starttime>2015-01-01</starttime>
<endtime>2015-08-25</endtime>
</sms:smsReceived>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsReceivedResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<data xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"><![CDATA[<list>
<message>
<id>17530</id>
<phone>4155098136</phone>
<message>test</message>
<dateTime>2015-02-13 18:32:31</dateTime>
<status>1</status>
</message>
<message>
<id>17529</id>
<phone>4155098135</phone>
<message>test2</message>
<dateTime>2015-02-13 18:20:58</dateTime>
<status>1</status>
</message>
</list>]]]]><![CDATA[></data>
<status>Success</status>
</return>
</ns2:smsReceivedResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
Get Outbound List
Get Outbound List Request
To get outbound list, call the method smsSent
| Parameter |
Type |
Description |
| user |
string |
user email |
| password |
string |
password |
| entryId |
number |
entryId |
| starttime |
string |
Start time like this 2015-08-25 |
| endtime |
string |
End time like this 2015-08-25 |
Get Outbound List Response
The SOAP Response from GuidebyCell contains the following:
- Status: Text message status
- Description Error or success description
- Data Outbound list xml string
Example
Below is an example to send sms using the SOAP interface.
| Request |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sms="http://apps.guidebycell.com/sms">
<soapenv:Header/>
<soapenv:Body>
<sms:smsSent>
<user>example@guidebycell.com</user>
<password>12345678</password>
<entryId>123</entryId>
<starttime>2015-01-01</starttime>
<endtime>2015-08-25</endtime>
</sms:smsSent>
</soapenv:Body>
</soapenv:Envelope>
]]>
|
| Response |
<![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:smsSentResponse xmlns:ns2="http://apps.guidebycell.com/sms">
<return>
<data xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"><![CDATA[<list>
<message>
<id>11627</id>
<phone>4155098136</phone>
<message>hi</message>
<dateTime>2015-02-13 18:32:31</dateTime>
<status>1</status>
</message>
<message>
<id>11626</id>
<phone>4155098135</phone>
<message>hello</message>
<dateTime>2015-02-13 17:49:22</dateTime>
<status>1</status>
</message>
</list>]]]]><![CDATA[></data>
<status>Success</status>
</return>
</ns2:smsSentResponse>
</soapenv:Body>
</soapenv:Envelope>
]]>
|