v1

latestOpenAPI 3.0.02026-07-244771176.5 KB

SMS

Send SMS

You can elect to pass us the recipient numbers from your database each time you make a call, or you can elect to store recipient data in a contact list and submit only the list_id to trigger the send. This is best for large databases. To add a list please refer to the add-list call.

post/send-sms.json

Response

message_idinteger

Numeric ID assigned to the message sent. This can be used in conjunction with other calls to retrieve information and reporting about the message sent.

send_atstring date-time

Date and time that message was sent from your account Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.

recipientsinteger

Recipient count. Count of number of recipients message was sent to either in list or to parameter.

costnumber

Total cost of all messages. Returned as value per account currency to 3 decimal places 0.000

smsinteger

Total number of message parts delivered. If the message is longer than 160 characters this will return count of all parts. Eg. if a 180 character message is delivered to 2 recipients. Value returned will be 4.

CODE	HEADER	DESCRIPTION
LEDGER_ERROR	400	There was a problem with payment. Please check the output for more details.
LIST_EMPTY	400	The list you provided doesn't have active recipients.
RECIPIENTS_ERROR	400	No valid recipients left after validation.

Example response

{
  "message_id": 339683245,
  "send_at": "2020-06-18T02:42:06Z",
  "recipients": 1,
  "cost": 0.087,
  "sms": 1,
  "error": {
    "code": "SUCCESS",
    "description": "OK"
  }
}

All 47 operations