Quick-start Guide

Which API should I use?

If you’re a skilled developer, we recommend our REST API.

Alternatively, for a quick integration, we recommend our HTTP API.

Sending Messages

Messages can be sent in batches of 1,000 in a single API call.

Or, if you use our Campaign endpoints, you can send to a single list with up to 20,000 recipients.

The response will return status=’Success’ for each recipient, which means we’ve queued your message for delivery. You’ll need to use the delivery report endpoints to get the final status of the message.

Receiving Messages

There are many options for receiving incoming SMS and replies.

Option 1: Email the reply

With this option, the reply can be emailed to a nominated address or back to the user who sent the original message.

Option 2: Poll our server for replies (Pull)

Poll our server periodically to check for new replies. You can poll our server and retrieve new Messages at a time that suits you.

  1. Log into your account.
  2. Click on ‘SMS’ then ‘Settings’ tab.
  3. Click on the ‘Inbound SMS Settings’ menu.
  4. Select Action: ‘POLL’ and click ‘Save’.

Option 3: Push replies as a web-hook

We can push replies as a HTTP POST to your web server/URL.

  1. Log into your account.
  2. Click on ‘SMS’ then ‘Settings’ tab.
  3. Click on the ‘Inbound SMS Settings’ menu.
  4. Add a new rule to and select Action: ‘URL’.
  5. Enter the URL and click ‘Save’.

Delivery reports

Delivery reports are optional and are normally sent out a few seconds after sending the message.

Option 1: Poll our server for replies (Pull)

Poll our server periodically to check for new delivery reports. You can poll our server and retrieve delivery reports at a time that suits you.

  1. Log into your account.
  2. Click on ‘SMS’ then ‘Settings’ tab.
  3. Click on the ‘SMS Delivery Report Settings’ menu.
  4. Select ‘Poll our server’ and click ‘Save’.

Option 2: Push replies as a web-hook

We can push delivery reports s as a HTTP POST to your web server/URL.

  1. Log into your account.
  2. Click on ‘SMS’ then ‘Settings’ tab.
  3. Click on the ‘SMS Delivery Report Settings’ menu.
  4. Select ‘Forward to URL’.
  5. Enter the URL and click ‘Save’.