Sms v1.2

Quickly send an SMS message to a single recipient without an smsMessage or task.

What can I do with sms?

Send an SMS message to one recipient at a scheduled time.

  • Quickly create and send your message to the msisdn provided.
  • Use senddate to schedule your send.
  • Be sure to set a recognisable fromaddress, this can be an msisdn or alphanumeric characters.
  • Use dispatched and failed to check if a message sent successfully.

Combine the smsMessage and task endpoints to schedule a message to multiple subscribers.

GET /sms or /sms/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the message.
msisdn
stringYesNoMSISDN to which the message should be delivered.
dispatched
boolNoNoTrue if the message has been dispatched; false if it is awaiting dispatch.
failed
boolNoNoTrue if the message could not be delivered; false otherwise.
fromaddress
stringYesNoSource address for the message. This can be a MSISDN or up to 11 alphanumeric characters.
message
stringNoNoMessage body. N.B. messages longer than 160 GSM characters will incur additional SMS credit cost.
senddate
decimal/nullNoNoTimestamp at which the message should be sent. If null or omitted in POST, the message will be sent immediately.
user_id
intYesNoUnique ID of the user who submitted this message. Corresponds to the "id" attribute in the /user endpoint.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast update timestamp.

Undeliverable messages with valid destinations time out after two weeks.

Admin users may view messages sent by any user_id; sub-users can only view messages sent by themselves.

HEAD /sms or /sms/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the message.
msisdn
stringOptionalMSISDN to which the message should be delivered.
fromaddress
stringOptionalSource address for the message. This can be a MSISDN or up to 11 alphanumeric characters.
user_id
intOptionalUnique ID of the user who submitted this message. Corresponds to the "id" attribute in the /user endpoint.

POST /sms

AttributeTypePresenceDescription
msisdn
stringRequiredMSISDN to which the message should be delivered.
fromaddress
stringRequiredSource address for the message. This can be a MSISDN or up to 11 alphanumeric characters.
message
stringRequiredMessage body. N.B. messages longer than 160 GSM characters will incur additional SMS credit cost.
senddate
decimal/nullOptionalTimestamp at which the message should be sent. If null or omitted in POST, the message will be sent immediately.

No contact or bounce records are generated through this endpoint.

You will be charged one or more SMS credits per send, depending on the length of your message. See smsMessage for more information on character limits and cost.

PUT /sms or /sms/:id

This method is not supported.

DELETE /sms or /sms/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":                 16838,
    "msisdn":             "446000111222",
    "dispatched":         true,
    "failed":             false,
    "fromaddress":        "446111222333",
    "message":            "This is a reminder of your appointment at 3.30pm today.",
    "senddate":           1234966745,
    "user_id":            1234,
    "cdate":              1234966741,
    "mdate":              1234966747
 }