SmsDestination v1.2

Retrieve or set the keyword for any destination active in your account.

What can I do with smsDestination?

smsDesitination allows you to manage keywords used for smsAutomation:

  • Retrieve or set the keyword for your account.
  • Retrieve the destination number that subscribers will send an SMS message to in order to trigger an smsAutomation.
  • Determine whether a destination number is a shortcode a standard number.

GET /smsDestination or /smsDestination/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the destination.
keyword
string/nullNoNoSMS messages starting with this string will be accepted. Not case-sensitive; must not contain spaces; must be 4-64 characters in length.
destination
stringNoNoThe MSISDN or shortcode to which SMS messages must be sent.
isshortcode
booleanYesYesWhether the destination is a shortcode.
mdate
decimal/nullNoNoLast modification timestamp.

keyword and mdate will initially be "null".

HEAD /smsDestination or /smsDestination/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the destination.
isshortcode
booleanOptionalWhether the destination is a shortcode.

POST /smsDestination

This method is not supported.

SMS destinations cannot be created or deleted by the client. The POST and DELETE verbs are therefore not available.

PUT /smsDestination or /smsDestination/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the destination.
keyword
string/nullOptionalSMS messages starting with this string will be accepted. Not case-sensitive; must not contain spaces; must be 4-64 characters in length.

The keyword can only be set by the admin.

DELETE /smsDestination or /smsDestination/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":          12345,
    "destination": "44712345678",
    "keyword":     "Example",
    "isshortcode": false,
    "mdate":       1234966741,
}