Send SMS API V2

Table of Contents

Request: JSON

{	
      "action":"sendsms",
      "api-key":"API KEY",
      "to":"PHONE NUMBER",
      "from":"SHORT CODE",
      "message-text":"MESSAGE TEXT"
}

Request Parameters:

PARAM REQUIRED/OPTIONALDESCRIPTION
actionrequiredsendsms
api-keyrequiredAuthentication key from your account. 
torequiredDestination Phone number with country code
fromrequiredShortcode, or Toll Free or 10DLC with country code
message-textrequiredSMS Message text. Character limits are 160, 140, 70 characters for GSM, UTF-8, Unicode respectively. Messages above the limit are concatenated and billed as multiple messages.  
campaign-refconditionalMandatory only if the “Enforce Campaign Check” is enabled on the account requiring a number to be actively subscribed.
operator-idoptionalWe will perform a carrier lookup for you unless this is passed in the API request. 
from-maskoptionalOnly carriers in certain countries allow Alphanumeric senders. Not supported in the USA.  
click-trackingoptional. By default we send the message as is without replacing it with any short link. Accepts Boolean value.true = Any Link or URL in the SMS will be replaced with the auto generated Short links. Total number of clicks for each link will be tracked and counted in our database. false = Links or URLs in the SMS will be sent as is without any replacement.

Response Parameters:

PARAM PresenceDESCRIPTION
statusAlways“Success” or “Failure” 
status-detailsSuccess response onlyMore details about the status
tracking-idSuccess response only Transaction ID for the request. Use it to match the postbacks received for this API request.
toAlwaysDestination Phone number with country code
fromSuccess response onlyShortcode, or Toll Free or 10DLC with country code
error-codeError response onlyError Code associated with the error
error-infoError response onlyError Message explaining the error code

Request Examples

Example 1:
{
      "action":"sendsms",
      "api-key":"Y6r74u6Br4hAVgrolveksjEiiu8yJX",
      "to":"15551234888",
      "from":"000002",
      "message-text":"Testing123"
}

Example 2:
{
      "action":"sendsms",
      "api-key":"Y6r74u6Br4hAVgrolveksjEiiu8yJX",
      "to":"15551234888",
      "from":"000002",
      "message-text":"Visit https://www.skycore.com/ for more info.",
      "from-mask":"Skycore",
      "operator-id":"0001470",
      "campaign-ref":"skycore-campaign2345",

Response Example: Success

{
      "status": "Success",
      "tracking-id": "U01TX0FycmF5",
      "to": "+16179593061",
      "from": "000002",
      "status-details": "SMS request accepted and queued for delivery"
}

Response Example: Failure

{
      "status": "Failure",
      "error-code": "E111",
      "error-info": "Invalid From",
      "to": 16179593061
}
Go to Top