SMS API

URL Callbacks & Automation

Delivery webhooks, triggers, actions, and opt-in/opt-out flows

URL Callbacks

Specify a callback URL when sending an SMS to receive delivery status notifications as JSON.

{"query":{"id":"12345","status":"Delivered","timestamp":"2024-03-22 05:44:48"}}

Automation Overview

Automation is built around 2 key elements: a trigger and an action. Activate automation in Services > SMS > Manage > Automation ON.

Available Actions

Update Address Book: add or remove contacts from an address book. Forward to Email: messages are forwarded from sms@atomtelecom.com.au. Forward to Webhook: sends an HTTPS request with JSON containing to, from, timestamp, type, and message fields. Send another SMS: configure an auto-reply or forward the message to another number.

Triggers

Select a VMN and filter by content using contains or equals matching, then attach actions. Multiple triggers can be configured per VMN.

Example: Opt-In/Opt-Out

Reply "Yes" to subscribe or "Stop" to unsubscribe. Create Address Book actions for add and delete, then create triggers with filter matching for each keyword.

Back to API Documentation