Vobiz Messaging API - SMS, MMS and RCS

Vobiz Messaging lets you send and receive SMS, MMS and RCS messages through one REST API, from numbers or RCS senders you own on Vobiz. The same credentials you use for voice work here, and every resource is scoped to your account automatically.

Quickstart

Send your first SMS in four steps.

Send a message

The one endpoint for SMS, MMS and RCS.

Compliance and registration

US 10DLC, toll-free verification and India DLT.

Webhooks

Signed delivery and inbound events to your server.

What you can do

Capability	What it does
Send SMS, MMS and RCS	One endpoint. Choose the `channel`. Several recipients in one call, each with its own message record.
RCS rich messages	Text plus suggestion buttons: reply, open URL, dial, show or request location.
SMS fallback for RCS	`failoverToSms: true` sends the same text as SMS when the recipient cannot receive RCS.
RCS reachability check	Ask whether a number can receive RCS before you send.
Cost preview	Price a message (segments x rate) before sending.
Scheduling	`scheduledAt` holds a message with status `scheduled`.
Idempotency	`idempotencyKey` makes retries safe. The same key never sends twice.
Tags	A free-text `tag` on a message to group and filter.
Broadcasts	Upload a CSV, personalise with variables, send at a set rate, track each recipient, export results.
Conversations and inbox	Two-way threads per contact, unread counts, mark as read.
Opt-outs	Automatic STOP handling and manual lists, per channel.
Numbers	Search, buy and release messaging-capable numbers by API or console.
Compliance	US 10DLC brand and campaign registration, US toll-free verification, India DLT IDs.
Webhooks	Signed delivery-status and inbound-message events.
WebSocket	Live message, broadcast, registration and number events for dashboards.

Channels

SMS

Text to any mobile. Long messages are split into segments and billed per segment.

MMS

Text plus media to US and Canadian numbers.

RCS

Branded rich messages with buttons, from a verified RCS sender.

Base URL and authentication

Base URL

https://api.vobiz.ai/api/v1/sms

Every path in this section is relative to the base URL. POST /messages means POST https://api.vobiz.ai/api/v1/sms/messages. Send your account credentials on every request:

X-Auth-ID: MA_XXXXXXXX
X-Auth-Token: YOUR_AUTH_TOKEN
Content-Type: application/json

The account is taken from your credentials. You never put an account ID in a path or body. Find your Auth ID and Auth Token on the Vobiz Console dashboard, and see Authentication for how to keep them safe.

Field names in the Messaging API are camelCase (failoverToSms, idempotencyKey, scheduledAt). The voice API uses snake_case. Keep each API’s casing as documented.

Endpoints

Area	Endpoints
Messages	Send, List, Retrieve, Cost preview, RCS reachability
Numbers	List yours, Countries, Search inventory, Purchase, Purchases, Release
Coverage	All countries, One country
Conversations	List, Retrieve, Messages, Mark read, Unread count
Opt-outs	Add, List, Check, Remove
Webhooks	Create, List, Retrieve, Update, Delete
Broadcasts	Create, Upload recipients, Preview, Launch, Pause, Resume, Cancel, Recipients, Export
RCS senders	Create, List, Status, Templates
10DLC	Brands, Campaigns, Toll-free, Documents

Message lifecycle

Status	Direction	Meaning
`scheduled`	out	Held for `scheduledAt`.
`sent`	out	Accepted by the network and on its way.
`delivered`	out	Delivery receipt received from the handset or network.
`failed`	out	Rejected, undeliverable or expired. See `errorCode` and `errorMessage`.
`received`	in	A message, or an RCS button tap, sent to you.
`unknown`	out	The network reported a state outside the list above. Retrieve the message for its status history.

A 2xx on send means accepted, not delivered. Delivery outcomes arrive later through webhooks or the WebSocket, or by polling Retrieve a message.

Before you send in production

Get a messaging number

Buy one or bring your own. India uses DLT sender IDs instead of long codes.

US local numbers need a 10DLC campaign. US toll-free numbers need toll-free verification. Indian traffic needs DLT IDs on every message.

Subscribe to events

Create a webhook subscription so delivery receipts and replies reach your server.

Honour opt-outs

STOP replies are recorded automatically and sends to opted-out numbers return 422. See Opt-outs.

Console

Everything in this section is also in the Vobiz Console under SMS & RCS: Overview, Send, Inbox, Broadcasts, Numbers (Buy a number, Bring your numbers), Registration (Brands, Campaigns, Toll-free), RCS agents and templates, Opt-outs, and Webhooks.

Pricing

SMS is billed per segment. Use Cost preview to see the segment count and price before you send. RCS and MMS have their own rates, and an RCS message that falls back to SMS is billed as SMS. Numbers carry a setup fee and a monthly fee in your account currency. See the pricing page for current rates.

Vobiz WhatsApp Business API - messaging on WhatsApp.
Voice API reference - calls, numbers for voice, SIP trunks.
Errors - status codes and error bodies for this API.

Getting Started

API Reference

Guides

Vobiz Messaging API - SMS, MMS and RCS

Quickstart

Send a message

Compliance and registration

Webhooks

What you can do

Channels

SMS

MMS

RCS

Base URL and authentication

Endpoints

Message lifecycle

Before you send in production

Console

Pricing

Quickstart

Send a message

Compliance and registration

Webhooks

​What you can do

​Channels

SMS

MMS

RCS

​Base URL and authentication

​Endpoints

​Message lifecycle

​Before you send in production

​Console

​Pricing

​Related

What you can do

Channels

Base URL and authentication

Endpoints

Message lifecycle

Before you send in production

Console

Pricing

Related