Getting started with the txtConsole SMS API

Use the RESTful SMS API to send SMS messages to mobiles. The API can be used to send a message to a single mobile, a message to many mobiles, or a set of scheduled messages.

For frequently used message content that will be merged with details relevant to the recipient, use templates that contain your prepared message content and field placeholders. Phonebooks and distribution lists can also be used to define mobile recipients.

txtConsole's message sending applications can be used via the API to send broadcasts, or send messages to phonebook entries or distribution lists.

Send a single message

Send a message by specifying a mobile number and message text.

JSON
{  
  "destination": "447700123123",  
  "text": "Hello World"  
}

Response:

JSON
{
  "transactionID": "4b54a300-3a0b-4ab1-97e9-865b31f5464f",
  "messageID": [
    "00000010-00000000038f2b83"
  ]
}

Where the message text does not fit in a single SMS, multiple message IDs will be returned for the message sent to the mobile number:

JSON
{
  "transactionID": "4b54a300-3a0b-4ab1-97e9-865b31f547de",
  "messageID": [
    "00000010-00000000038f2ba1",
    "00000010-00000000038f2ba2"
  ]
}

Send to multiple mobiles

Send a message to multiple mobiles by specifying each mobile number and the message text.

JSON
{
     "destinations": [
          "447700000000",
          "447700000001",
          "447700000002"
     ],
     "text": "Hello World"
}

Response:

JSON
{
  "transactionID": "39217ada-08d7-460d-9f1d-337c40607d14",
  "messageID": [
    [
      "00000011-0000000003f9d6bf"
    ],
    [
      "00000011-0000000003f9d6c0"
    ],
    [
      "00000011-0000000003f9d6c1"
    ]
  ]
}

Where the message text does not fit in a single SMS, multiple message IDs will be returned for each message to a destination mobile number:

JSON
{
  "transactionID": "39217ada-08d7-460d-9f1d-337c40607e26",
  "messageID": [
    [
      "00000011-0000000003f9d6df",
      "00000011-0000000003f9d6e0"
    ],
    [
      "00000011-0000000003f9d6e1",
      "00000011-0000000003f9d6e2"
    ]
  ]
}