Sends a text or unicode message.
Base URL
All requests to TheTexting must be submitted to the base URL. TheTexting provides you with an option of a response as a JSON object, or an XML string - you get to choose which response by selecting the appropriate base URL for your request.
JSON end point
https://www.thetexting.com/rest/sms/json
XML end point
https://www.thetexting.com/rest/sms/xml
HTTP Methods
All requests are submitted through the HTTP POST or GET method using UTF-8 encoding and URL encoded values.
Expected "Content-Type" for POST is "application/x-www-form-urlencoded", however we also support "application/json", "application/jsonrequest", "application/x-javascript", "text/json", "text/javascript", "text/x-javascript", "text/x-json" when posting parameters as a JSON object.
Parameters
All requests require your API credentials (api_key & api_secret), which you can find under "API Settings" in TheTexting Dashboard.
Parameter | Description |
---|---|
api_key | Required. Your API Key. Ex: api_key=2f0ihf5656lfu03jl |
api_secret | Required. Your API Secret. Ex: api_secret=cluol3434qwfc0lg |
from | Required (Paid) / Optional (Trial). For Paid Account: The number that has been purchased and associated to your account. For Trial Account: Either skip this parameter, or use 'test' or 'sandbox' and your message will be sent using a shared number. |
to | Required. Mobile number in international format, and one recipient per request. Ex: to=17327572923 when sending to CA (USA). |
text | Required. Body of the text message (with a maximum length of 3200 characters), UTF-8 and URL encoded value. |
type | Optional. This can be omitted for text (default), but is required when sending a Unicode message (unicode) message. |
Sample URL
https://www.thetexting.com/rest/sms/json/Message/Send?api_key=your_api_Key&api_secret=your_api_secret&from=test&to=1234567890&text=Hello
JSON Response (Success)
{
"Response": {
"message_id": "10011",
"message_count": 1,
"price": 0.0055
},
"ErrorMessage": "",
"Status": 0
}
XML Response (Success)
<TheTexting xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ErrorMessage/><Status>0</Status></TheTexting>
JSON Response (Failure)
{
"Response": null,
"ErrorMessage": "Parameters Missing",
"Status": 2
}
XML Response (Failure)
<TheTexting xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ErrorMessage>Parameters Missing</ErrorMessage><Response i:nil="true"/><Status>2</Status></TheTexting>
Respond Codes
Code | Meaning |
---|---|
0 | Request is successful |
1 | Request has failed. |
2 | Parameters are missing. |
3 | Credentials are invalid. |
4 | Parameters are invalid. |
5 | Result has returned empty. |
6 | Status is invalid. |
Callback Response
If you have set delivery callback URL in your profile, we will send you the following parameters.
Parameter | Description |
---|---|
msgid | TheTexting message ID for this message. |
message-timestamp | Date & Time when this message was sent. |
status | Status of the message. Either 'sent','delivered','rejected' or 'failed'. |
cost | Cost of the message. |