sendSMS

Synopsis:

This API function sends an SMS containing text from the specified account and shortcode to a recipient’s mobile number. If the aggregator allows masking longcode/sender with some brand or string, from_mask can be set in the API. from_mask is limited to 11 characters beyond which it will be cut-off. If “Enforce Campaign Check” is turned ON, then this function will require the campaign reference ID of the messaging campaign that the recipient’s phone number is subscribed into to be passed inside the campaignref node.

Request: XML

<REQUEST>
    <ACTION>sendSMS</ACTION>
    <API_KEY>apiKey</API_KEY>
    <OPERATORID>OPERATORID</OPERATORID>
    <TO>Recipient phone number</TO>
    <FROM>shortcode</FROM>
    <FROM_MASK>senderName</FROM_MASK>
    <CAMPAIGNREF>CampaignReferenceID</CAMPAIGNREF>
    <TEXT>SMS Text message text</TEXT>
</REQUEST>

Request: GET

API_URL?action=sendsms
&api_key=API key
&operatorid=operator ID
&to=recipient phone number
&from=shortcode
&from_mask=sender name
&campaignref=campaign reference ID
&text=SMS Text message text

Request Parameters:

If "Enforce Campaign Check" is NOT enabled:
Mandatory: action, api_key, to, from, text
Optional: operatorid, from_mask, campaignRef

If "Enforce Campaign Check" IS enabled:
Mandatory: action, api_key, to, from, campaignRef, text
Optional: operatorid, from_mask

Response Parameters:

status, trackingId, to, errorCode, errorInfo

Request Example: XML

<REQUEST>
    <ACTION>sendSMS</ACTION>
    <API_KEY>Y6r74u6Br4hAVgrolveksjEiiu8yJX</API_KEY>
    <TO>15551234888</TO>
    <FROM>60856</FROM>
    <CAMPAIGNREF>Campaign123</CAMPAIGNREF>
    <TEXT>Hello Jerry, Greetings from Marc</TEXT>
</REQUEST>

Request Example: GET

https://secure.skycore.com/API/wxml/1.3/index.php?action=sendsms
&api_key=Y6r74u6Br4hAVgrolveksjEiiu8yJX
&to=15551234888
&from=60856
&campaignref=Campaign123
&text=Hello+Jerry%2C+Greetings+from+Marc

Response Example: Success

<RESPONSE>
    <STATUS>Success</STATUS>
    <TRACKINGID>U01TXzc2Nzg2Nw==</TRACKINGID>
    <TO>15551234888</TO>
 </RESPONSE>

Response Example: Failure

<RESPONSE>
    <STATUS>Failure</STATUS>
    <ERRORCODE>E713</ERRORCODE>
    <ERRORINFO>There is billing problem on your account</ERRORINFO>
    <TO>15551234888</TO>
</RESPONSE>

Postback Notification:

When the SMS is sent we will generate a Postback notification. When we get an SMS delivery receipt we will generate another Postback notification. Not all carriers provide SMS delivery receipts. For more details please visit the SMS MT Delivery Status section of the Delivery Report Postback documentation.


General Error Codes:

Code Description
E100 Invalid request. Make a valid request via GET/POST/XML with all the required variables.
E104 User Authentication Failed.
E105 This account has no API rights.
E106 You can call API every X seconds.
E107 This account has no rights to use this action.
E108 XML Parse error: $error.
E109 API not activated.
E112 IP was not whitelisted. API call rejected.
E113 Set throughput exceeded for this API action. API call rejected.
E114 Phone number is blacklisted. API call rejected.
E120 Account has reached the API request limit.
E503 Internal error.


Code Description
E110 Invalid receiver number.
E111 Invalid shortcode.
E628 Operator Not supported.
E712 The ‘text’ is required.
E713 There is billing problem on your account.
E715 Number is not subscribed in this campaign
E718 The ‘campaignref’ is required
E721 Invalid campaignref


Key Term Definitions:

Term Description
ACTION This is the name of the function you want to execute with the API.
API_KEY Random key that is assigned to an account that can be used for authorization instead of USER/PASS. You can find and regenerate this key on the ‘API Settings’ page.
CAMPAIGNREF Depending on your API settings, you may be required to subscribe users into a campaign first before sending them messages. If you are required to subscribe a user first, then a valid Campaign Reference is required. This would be the campaign reference ID (string) to which the user is subscribed.
FROM A valid shortcode or longcode for the sender address(string). When sending to a list of many numbers using the ‘sendSavedContent’ function and if the ‘FROM’ value cannot be used for a certain country, then the system will re-write the sender address to use a valid shortcode for those numbers.
TEXT The SMS message limit is 160 characters(string).
TO This is the message recipient’s phone number in an international format.
TRACKINGID On success, the API returns with the tracking ID to identify sent messages. Upon API call failure, no tracking ID is returned. Once the message sending is processed you shall receive a postback containing TRACKINGID and the message status.