Authentication

Every API request is authenticated with your API token. Send it as a Bearer header (recommended) or as an api_token field.

Getting Your Token

Two Ways to Send the Token

Bearer header

curl https://sms.dataflows.com.au/api/http/balance \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

api_token field

On GET and DELETE requests, send api_token as a query parameter. On POST and PATCH requests, send it in the JSON body.

curl 'https://sms.dataflows.com.au/api/http/contacts?api_token=YOUR_API_TOKEN' \
  -H 'Accept: application/json'

Which Method Each Endpoint Accepts

Request Format

Send request bodies as JSON with Content-Type: application/json, and include Accept: application/json on every request. See Responses and Errors for the response format.

Dedicated Numbers and Two-Way SMS

A dedicated number lets your customers reply to your messages. Replies land in your DataFlows inbox, and integrations use the number for two-way messaging.

Sender IDs and Dedicated Numbers

Getting a Number

Integrations That Use a Dedicated Number

• HighLevel: two-way SMS through HighLevel Conversations
• Cliniko: patient replies, confirmations, waitlist offers and the AI SMS receptionist
• ServiceM8: campaign replies and the AI receptionist
• Microsoft Teams: a receiving number for each Teams channel

Email to SMS

Send an SMS from Outlook, Gmail or any email app by emailing the recipient's number at our Email to SMS domain.

How It Works

Rules

• Up to 10 recipients per email, counted across To, Cc and Bcc
• The sending domain has to pass email authentication (DKIM or DMARC), otherwise it is not sent. Gmail, Outlook and most business email do this automatically
• Works from any email app (Gmail, Outlook, Apple Mail or a phone), with no plugin or mailbox connection
• Turn off automatic signatures such as "Sent from Outlook for Android": they become part of the SMS
• Messages use your standard DataFlows SMS credits

Settings

Click Email to SMS in the dashboard menu, or go to sms.dataflows.com.au/email-to-sms.

• Authorized Email Addresses: click Add Email to let another address send SMS by email
• Default SMS Settings: choose the sender ID or number used for email sends

ChatGPT

Send, schedule and track SMS from your DataFlows account by asking ChatGPT in plain language, with the DataFlows SMS app in ChatGPT.

Setup

What You Can Do

• Send SMS from your own sender ID or number
• Preview before you send: recipients, SMS parts and credits needed
• Schedule messages, and cancel them before they send
• Check delivery status, read replies and check your balance

ChatGPT asks you to confirm before any message is sent. Full details are on the ChatGPT integration page.

Claude

Send, schedule and track SMS from your DataFlows account by asking Claude in plain language. Works in Claude on the web, desktop and mobile apps, and Claude Code.

Connect in Claude

Claude Code

Install the plugin

The DataFlows SMS plugin (dataflows-sms@dataflows) adds the connector plus skills that confirm every send and preview costs before campaigns.

/plugin marketplace add dataflows-au/dataflows-sms-claude-plugin
/plugin install dataflows-sms@dataflows

Or add only the connector

claude mcp add --transport http dataflows-sms https://sms.dataflows.com.au/mcp/claude

Then type /mcp in Claude Code and sign in when prompted.

Claude asks you to confirm before any message is sent. Full details are on the Claude integration page.

Gemini CLI

Send, schedule and track SMS from your DataFlows account by asking Gemini in plain language, with the DataFlows SMS extension for Gemini CLI.

Setup

gemini extensions install https://github.com/dataflows-au/dataflows-sms-gemini

Gemini asks you to confirm before any message is sent. Full details are on the Gemini integration page.

Zapier Integration

Automate SMS workflows with thousands of apps, no code required. Trigger SMS from CRM events, form submissions, calendar reminders and more.

Setup

Actions

Send SMS

Send an SMS to one or more recipients from a Zap trigger.

Create Contact

Add a contact to a DataFlows contact group when a Zap trigger fires, for example a new form submission or a new CRM contact.

Analyze SMS Sentiment With AI

Run AI sentiment analysis on inbound SMS text and return a sentiment result (positive, neutral or negative). Use it with the New SMS Received trigger to route or tag conversations.

Categorize SMS With AI

Classify inbound SMS into your own categories using AI. Define category labels (for example "Booking Request", "Complaint", "Opt-out") and the AI returns the best match.

Searches

Get Account Balance

Look up your current DataFlows SMS credit balance, for example to check you have enough credits before a Zap sends.

Search Contacts

Find an existing contact in your DataFlows contact groups, for example to check whether someone is already on a list.

Triggers

New SMS Received

Fires when an inbound SMS arrives in your DataFlows inbox. The payload includes the sender number, message body, timestamp and the number it was sent to.

Keyword Matched in SMS

Fires when an inbound SMS contains a keyword you choose (for example "INFO" or "YES"). Configure the keyword in the trigger settings.

SMS Delivery Status Changed

Fires when a sent SMS changes delivery status (Delivered, Failed, Pending). Use it to update CRM records or trigger follow-up actions.

Low Balance Alert

Fires when your SMS credit balance drops below a threshold you set. Use it to alert your team.

More detail on each trigger and action is on the Zapier integration page.

Power Automate Integration

Send and receive SMS from Microsoft Power Automate, Power Apps, Copilot Studio and Logic Apps with the DataFlows SMS connector, without writing code.

Setup

Actions

Trigger

When SMS received

Starts a flow when an SMS arrives at your dedicated number, for example to send an automatic reply, post the message to Teams or log it in SharePoint.

Common Flow Ideas

Alternative: HTTP Action

You can also call the API directly with the built-in HTTP action (also Premium):

{
  "recipient": "@{triggerBody()?['PhoneNumber']}",
  "sender_id": "YourBrand",
  "type": "plain",
  "message": "Hi @{triggerBody()?['FirstName']}, your appointment is confirmed."
}

More Guides

See the Power Automate integration page, the advanced guide and use cases.

Microsoft Teams Integration

Turn Teams channels into shared two-way SMS inboxes. Receive customer SMS in a channel and reply from Teams, with no app switching.

Before You Start

• A DataFlows account. Sign up at sms.dataflows.com.au/register
• A dedicated number to receive SMS in a channel

Setup

Using It

• Team members see incoming SMS in the channel and can reply
• Send Team SMS to send a new message
• Reports for your message activity
• Compose extension: More actions → Send DataFlows SMS
• Bot: type @DataFlows SMS help

Shopify Integration

Automated order notifications, abandoned cart recovery, a two-way inbox and bulk SMS campaigns, all inside Shopify Admin.

Setup

Automated Notifications

Each notification type can be turned on or off on its own and is sent in real time through Shopify webhooks.

Two-Way Inbox

The inbox shows conversation threads grouped by customer phone number. View inbound messages and reply directly from Shopify Admin. Customers can only reply if you send from a dedicated number.

Bulk Campaigns

Broadcast to opted-in subscribers with AI-generated copy variants. Target from 9 audience segments, including All Subscribers, VIP, Lapsed, At-Risk, Abandoned Cart and Loyalty Members.

Shopify Flow

The app adds a Send SMS action and an Add to SMS List action to Shopify Flow, so you can send SMS from any Flow event, such as loyalty points earned or a tag added.

WordPress / WooCommerce Integration

Automated SMS order notifications for WooCommerce stores: order confirmation, shipping updates, abandoned cart recovery and more.

Setup

Automated Notifications

Plugin Features

• Test Connection button that confirms the connection and shows your account name
• Sender ID dropdown loaded from your DataFlows account, no copy and paste
• International number support that strips spaces, dashes and brackets automatically
• Default country code setting for local numbers
• Dedicated DataFlows SMS menu in WordPress Admin

More on the WordPress integration page.

HighLevel (GoHighLevel)

Send SMS from HighLevel workflows with a DataFlows Send SMS action, and run two-way SMS through HighLevel Conversations.

What It Does

• Send SMS workflow action: send an SMS from any workflow step, such as contact created, form submitted or appointment booked
• Two-way SMS in Conversations: customer replies come back into HighLevel Conversations, and you can answer from there
• Built for agencies: works across many sub-accounts, and each sub-account can have its own number
• Personalise messages with HighLevel custom values such as {{contact.first_name}}

Setup

The setup guide covers connecting sub-accounts and setting up two-way Conversations. More on the HighLevel integration page.

Cliniko

Appointment reminders and confirmations, two-way patient replies handled by an AI SMS receptionist, waitlist offers, recalls and campaigns for Cliniko clinics.

What It Does

• AI SMS receptionist: reads patient replies, confirms appointments in Cliniko, and passes cancellations, reschedules and questions to your staff
• Appointment reminders and confirmations: booking confirmations, rolling or fixed daily reminders, and cancellation and reschedule notices
• Two-way patient replies: every conversation in one threaded inbox, where staff can reply
• Waitlist offers: when a slot frees up, matching waitlist patients are texted and the first to reply CLAIM gets it
• Recalls: reminders for patients due for a follow-up visit
• Campaigns: filter patients by appointment date and outcome and send a campaign

Setup

More on the Cliniko integration page.

ServiceM8

Send SMS straight from ServiceM8 jobs and customers, run campaigns to win back past customers, and let an AI receptionist handle the replies.

What It Does

• Send SMS from a job or customer: a note is added to the job so your team can see what was sent
• Campaigns: pick customers from your ServiceM8 data, for example customers with no job in the last 12 months, and send from your DataFlows dashboard
• AI receptionist: reads replies, creates a Quote in ServiceM8 for booking requests, alerts your team, and removes customers who reply STOP
• Automatic booking (optional): offers the customer real time slots from a staff member's ServiceM8 schedule and books the one they choose
• Customers, jobs and job changes sync from ServiceM8 to DataFlows automatically

Setup Summary

Every step, setting and troubleshooting answer is in the ServiceM8 guide.

Supabase Integration

Send Supabase Auth phone OTP codes through DataFlows, using Supabase's Send SMS auth hook and our Edge Function.

Before You Start

• A DataFlows account, your API token from Developers, and your Sender ID (business name or number)
• A Supabase project
• The Supabase CLI

Setup

supabase secrets set DATAFLOWS_API_KEY=your_api_token_here
supabase secrets set DATAFLOWS_SENDER_ID=YourSenderID
supabase functions deploy dataflows-sms-hook

supabase secrets set SEND_SMS_HOOK_SECRET="v1,whsec_your_secret_here"
supabase functions deploy dataflows-sms-hook

Environment Variables

supabase secrets set OTP_MESSAGE_TEMPLATE="Your MyApp code is: {otp}. Valid for 10 minutes."

Test It in Your App

const { error } = await supabase.auth.signInWithOtp({ phone: '+61404235133' })

const { data, error: verifyError } = await supabase.auth.verifyOtp({
  phone: '+61404235133',
  token: '123456',
  type: 'sms'
})

Troubleshooting

• OTP not received: check the logs with supabase functions logs dataflows-sms-hook, check your API token and credit balance, and make sure numbers include the country code
• Signature errors: SEND_SMS_HOOK_SECRET must match the Dashboard secret, in the format v1,whsec_...
• Deploy fails: update the CLI with supabase update and check your project is linked with supabase link

More on the Supabase integration page.

Auth0 Integration

Add SMS MFA and passwordless login to your Auth0 applications, with DataFlows sending the codes through an Auth0 Action.

Use Cases

Setup

Account API

Check your account profile, credit balance and the sender IDs and numbers you can send from.

View Profile

curl https://sms.dataflows.com.au/api/http/me \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

Check Balance

curl https://sms.dataflows.com.au/api/http/balance \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

List Sender IDs

curl https://sms.dataflows.com.au/api/http/sender-ids \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

SMS API

Send SMS to one or more numbers, now or at a scheduled time, and view the messages you have sent.

Send SMS

curl -X POST https://sms.dataflows.com.au/api/http/sms/send \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "recipient": "61404235133",
    "sender_id": "YourBrand",
    "message": "Hello from DataFlows!"
  }'

curl -X POST https://sms.dataflows.com.au/api/http/sms/send \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "recipient": "61404235133,YOUR_SECOND_NUMBER",
    "sender_id": "YourBrand",
    "type": "plain",
    "message": "Hello from DataFlows!",
    "schedule_time": "2026-12-01 09:00"
  }'

Send an OTP or Verification Code

There is no separate OTP endpoint. A code goes out as a normal SMS through /api/http/sms/send, and your own system generates and checks it.

curl -X POST https://sms.dataflows.com.au/api/http/sms/send \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "recipient": "61404235133",
    "sender_id": "YourBrand",
    "message": "Your verification code is 483920. Valid for 10 minutes."
  }'

For OTP inside an authentication platform, see the Supabase and Auth0 guides.

List Sent Messages

View a Message

curl https://sms.dataflows.com.au/api/http/sms/MESSAGE_UID \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

Contact Groups API

Create and manage contact groups. Use a group's UID when adding contacts.

List All Groups

curl https://sms.dataflows.com.au/api/http/contacts \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

Create a Group

curl -X POST https://sms.dataflows.com.au/api/http/contacts \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"name": "Newsletter Subscribers"}'

View a Group

Update a Group

Delete a Group

Contacts API

Add, view, update and remove contacts in a contact group.

List Contacts in a Group

Add a Contact

curl -X POST https://sms.dataflows.com.au/api/http/contacts/GROUP_UID/store \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "PHONE": "61404235133",
    "FIRST_NAME": "Jane",
    "LAST_NAME": "Smith"
  }'

View a Contact

Update a Contact

Delete a Contact

Responses and Errors

Every endpoint returns JSON with a status field. Always check status, not just the HTTP status code.

Standard Response Format

{
  "status": "success",
  ...
}

{
  "status": "error",
  "message": "A human-readable description of the error."
}

HTTP Status Codes

Don't rely on the HTTP status code. Some errors come back as HTTP 200 with "status": "error", and others as a 4xx code (for example, a missing sender ID returns 404). Check whether status is "success" or "error".

SDKs

Node.js

npm install @dataflows/sms

npm and GitHub

PHP

composer require dataflows-au/dataflows-sms

Packagist and GitHub

Postman