POST /messages

This is the mobile number you want to send your message to. Write Australian numbers in national format (e.g. 0412345678) and international numbers (paid plans only) in E.164 format (e.g. +441234567890).

Use a string for a single recipient, and an array of string of multiple recipients, e.g. "to": ["0412345678", "+441234567890"]. If you're using the Free Trial, you can include up to 5 recipient numbers in the array. If you're using a paid plan, you can bulk send up to 500 messages at once.

Don't want to send the message right away? Tell us what time you want to add it to the queue for sending instead.

Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2019-08-24T15:39:00Z".

You can schedule a message up to 10 days into the future. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error.

If the message is queued or unable to reach the recipient's device, tell us how many minutes the network should keep trying. Use an integer between 10 and 1440. If you don't set a value, we'll retry for 10 minutes.

Default value: 10

To receive a notification when your SMS has been delivered, set this parameter to true and make sure you provide a statusCallbackUrl (paid feature).

Default value: false

Create your own tags and use them to fetch and sort your messages through our other endpoints. You can assign up to 10 tags per message.

Use this field to send an MMS. Add your image, video or audio content here.

Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text.

Include a JSON payload with:

type: the type of multimedia content file you're sending (image, audio, video or pdf) followed by the file type. Use the format "multimedia type/file type", e.g. "image/PNG", "audio/MP3", "application/pdf". Supported file types: JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP, US-ASCII, VCARD and PDF.

fileName: the name of your multimedia file.

payload: the base64 encoded content. You can use this online tool to encode an image, or Base64 Guru to encode a video or audio file.

The base64 encoded content. You can use this online tool to encode an image, or Base64 Guru to encode a video or audio file.

the type of multimedia content file you're sending (image, audio, video or pdf) followed by the file type. Use the format "multimedia type/file type", e.g. "image/PNG", "audio/MP3" or "application/pdf". Supported file types:JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP, US-ASCII, VCARD and PDF.

The name of the multimedia file.

Use this field to send an SMS. Your text message goes here.

Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text.

Tell us the URL you want the API to call when the status of your SMS updates.

To receive a status update, this field must be provided and deliveryNotification must be set to true.

The status will be either:

• queued - the message is in the queue for sending (default).
• sent - your message has been sent from the server.
• expired - we weren't able to send the message within the retryTimeout timeframe.
• delivered - the message has successfully reached the recipient's device. Note that we will only be able to return this status if you set deliveryNotification to true (paid feature).
• undeliverable - the delivery of your message failed (paid feature).

Sample callback response:

{
  "to":"0476543210", 
  "from":"0401234567",  
  "timestamp":"2022-11-10T05:06:42.823Z", 
  "messageId":"1520b774-46b0-4415-a05f-7bcb1c032c59", 
  "status":"delivered" 
}

When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the from field.

• 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number.
• senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature).