Send SMS API V2

Synopsis

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

Request: JSON

curl -X POST \
     -H "x-api-key: {Api Key}" \
     -H "content-type: application/json" -d '
      {
          "action": "sendsms",
          "message-text": "{Message text}",
          "to": "{Receiver phone number with country code}",
          "from": "{Sender number}",
          "from-mask": "{Sender mask}",
          "campaign-ref": "{Campaign reference}",
          "click-tracking": true/false
      }' \
  "{Api Endpoint URL}"

Request Parameters

Response Parameters

Request Examples

Example 1:
curl -X POST \
     -H "x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     -H "content-type: application/json" -d '
      {
          "action": "sendsms",
          "message-text": "This message is sent for testing purposes only.",
          "to": "+10000000001",
          "from": "00000"
      }' \
  "{Api Endpoint URL}"

Example 2:
curl -X POST \
     -H "x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     -H "content-type: application/json" -d '
      {
          "action": "sendsms",
          "message-text": "Visit https://www.fakeurl.com/ for more info.",
          "to": "+10000000001",
          "from": "00000",
          "from-mask": "Dunder Mifflin",
          "campaign-ref": "campaign2345",
          "click-tracking": true
      }' \
  "{Api Endpoint URL}"

Response Example: Success

{
    "status": "Success",
    "tracking-id": "xxxxxx-xxxxx-xxx",
    "to": "+10000000001",
    "from": "00000",
    "status-details": "SMS request accepted and queued for delivery"
}

Response Example: Failure

{
    "status": "Failure",
    "error-code": "E111",
    "error-info": "Invalid Shortcode",
    "to": "10000000001"
}