> ## Documentation Index
> Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vobiz Docs Sitemap - API Reference: SMS & RCS

> Every page in the API Reference: SMS & RCS section of the Vobiz documentation, grouped as it appears in the sidebar, with a one line summary of each.

Every page in the **API Reference: SMS & RCS** section of the Vobiz documentation (99 pages), grouped as it appears in the sidebar, with a one line summary of each. The other sections are listed on the [documentation sitemap](https://www.vobiz.ai/docs/resources/sitemap).

## Getting Started

* [Vobiz Messaging API: SMS, MMS and RCS](https://www.vobiz.ai/docs/sms/overview.md) — Send and receive SMS, MMS, and RCS through one Vobiz API - buy numbers, register for 10DLC, run broadcasts, and receive events by webhook or..
* [Send your first SMS with Vobiz](https://www.vobiz.ai/docs/sms/quickstart.md) — Send an SMS through the Vobiz Messaging API in four steps - get credentials, pick a messaging number, call POST /messages, and track delivery
* [Vobiz Messaging API Errors](https://www.vobiz.ai/docs/sms/errors.md) — Error reference for the Vobiz Messaging API - the error response body, HTTP status codes, the providerError diagnostic, retries, and 201, 202, and..

## API Reference

* **Messages**
  * [Vobiz Messaging API: Messages](https://www.vobiz.ai/docs/sms/api/messages) — Send SMS, MMS and RCS messages with the Vobiz Messaging API, list and retrieve them with their status history, preview the cost and check RCS..
  * [Send a message](https://www.vobiz.ai/docs/sms/api/messages/send-message.md) — Sends an SMS, MMS or RCS message from one of your numbers or RCS senders to one or more recipients
  * [List messages](https://www.vobiz.ai/docs/sms/api/messages/list-messages.md) — Returns the messages on your account, sent and received, newest first
  * [Retrieve a message](https://www.vobiz.ai/docs/sms/api/messages/get-message.md) — Returns one message with its full status history
  * [Preview message cost](https://www.vobiz.ai/docs/sms/api/messages/cost-preview.md) — Prices a message before you send it, without sending anything
  * [Check RCS reachability](https://www.vobiz.ai/docs/sms/api/messages/rcs-reachability.md) — Checks whether a phone number can receive RCS from your RCS sender, without sending anything
* **Numbers**
  * [Vobiz Messaging API: Numbers](https://www.vobiz.ai/docs/sms/api/numbers) — List the SMS and MMS numbers on your Vobiz account, see where each can send, search inventory by country and area code, and buy and release numbers
  * [List your numbers](https://www.vobiz.ai/docs/sms/api/numbers/list-numbers.md) — Returns every number on your account routed for SMS or MMS, with its US registration state, last message sent, and a `sendable` summary
  * [List countries in stock](https://www.vobiz.ai/docs/sms/api/numbers/list-countries.md) — Returns the countries where you can buy messaging numbers, with the number types and capabilities in stock in each
  * [Search available numbers](https://www.vobiz.ai/docs/sms/api/numbers/search-available-numbers.md) — Searches the inventory for numbers to buy in one country, with setup and monthly prices in your wallet currency
  * [Purchase a number](https://www.vobiz.ai/docs/sms/api/numbers/purchase-number.md) — Buys a number returned by `GET /numbers/available` and routes it to your account for messaging
  * [List number purchases](https://www.vobiz.ai/docs/sms/api/numbers/list-purchases.md) — Returns the numbers you bought through Vobiz, newest first, each with its wallet charges
  * [Release a number](https://www.vobiz.ai/docs/sms/api/numbers/release-number.md) — Cancels a number you bought through Vobiz and removes it from your account
* **Coverage**
  * [Vobiz Messaging API: Coverage](https://www.vobiz.ai/docs/sms/api/coverage) — Look up SMS rules by destination country with the Vobiz Messaging API - sender types, registration, two-way support, opt-outs, link rules, and..
  * [List coverage](https://www.vobiz.ai/docs/sms/api/coverage/list-coverage.md) — Returns one summary row per destination country: accepted sender types, whether registration is required, two-way support, and opt-out rules
  * [Retrieve country coverage](https://www.vobiz.ai/docs/sms/api/coverage/get-coverage.md) — Returns the full coverage record for one country: sender types, registration and lead time, link rules, prohibited topics, and the sending window
* **Conversations**
  * [Vobiz Messaging API: Conversations](https://www.vobiz.ai/docs/sms/api/conversations) — List and read two-way SMS, MMS and RCS threads with the Vobiz Messaging API, track unread counts and mark conversations read to build an inbox
  * [List conversations](https://www.vobiz.ai/docs/sms/api/conversations/list-conversations.md) — Returns your conversations, ordered by `lastMessageAt`
  * [Retrieve a conversation](https://www.vobiz.ai/docs/sms/api/conversations/get-conversation.md) — Returns one conversation with its participants, channel, and counters
  * [List conversation messages](https://www.vobiz.ai/docs/sms/api/conversations/list-conversation-messages.md) — Returns the messages in one conversation, in both directions, newest first
  * [Mark a conversation read](https://www.vobiz.ai/docs/sms/api/conversations/mark-conversation-read.md) — Marks a conversation as read: sets `unreadCount` to `0` and `lastReadAt` to the current time
  * [Count unread messages](https://www.vobiz.ai/docs/sms/api/conversations/unread-count.md) — Returns the total of `unreadCount` across all your conversations
* **Opt-outs**
  * [Vobiz Messaging API: Opt-outs](https://www.vobiz.ai/docs/sms/api/opt-outs) — Add, list, check and remove numbers on your Vobiz opt-out list by API, and learn how STOP, START and HELP replies and sends to opted-out numbers are..
  * [Create an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/create-opt-out.md) — Adds a phone number to your opt-out list for one channel
  * [List opt-outs](https://www.vobiz.ai/docs/sms/api/opt-outs/list-opt-outs.md) — Returns the numbers on your opt-out list, newest first, including entries created from STOP, START and HELP keyword replies and the ones you added
  * [Check an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/check-opt-out.md) — Tells you whether a phone number is on your opt-out list for a channel
  * [Delete an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/delete-opt-out.md) — Removes a phone number from your opt-out list for one channel so you can message it again
* **Webhooks**
  * [Vobiz Messaging API: Webhooks](https://www.vobiz.ai/docs/sms/api/webhooks) — Create and manage Vobiz Messaging webhook (callback) subscriptions - choose SMS, MMS, RCS, and broadcast events, and sign with X-Webhook-Signature
  * [Create a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/create-webhook.md) — Registers an HTTPS endpoint that receives subscribed events as signed `POST` requests
  * [List webhooks](https://www.vobiz.ai/docs/sms/api/webhooks/list-webhooks.md) — Returns all of your webhook subscriptions, newest first, as a bare JSON array
  * [Retrieve a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/get-webhook.md) — Returns one webhook subscription with its URL, events, `active` flag, and signing secret
  * [Update a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/update-webhook.md) — Changes any subset of `url`, `secret`, `events`, and `active` on a webhook
  * [Delete a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/delete-webhook.md) — Removes the subscription and stops all deliveries to its URL
* **Broadcasts**
  * [Vobiz Messaging API: Broadcasts](https://www.vobiz.ai/docs/sms/api/broadcasts) — The Vobiz Broadcasts API sends one personalised SMS template to up to 10,000 recipients at a controlled rate - draft, upload, preview, launch, and..
  * [Create a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/create-broadcast.md) — Creates a broadcast in `draft` status with no recipients
  * [List broadcasts](https://www.vobiz.ai/docs/sms/api/broadcasts/list-broadcasts.md) — Returns the broadcasts on your account, newest first, each with freshly counted `stats`
  * [Retrieve a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/get-broadcast.md) — Returns one broadcast with its configuration, `status`, and freshly counted `stats`
  * [Update a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/update-broadcast.md) — Changes a `draft` broadcast. Send only the fields to change; omitted or `null` fields keep their value, except `scheduledAt`, where `null` clears the..
  * [Delete a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/delete-broadcast.md) — Permanently removes a `draft` or `cancelled` broadcast together with its recipient list and returns `204` with no body
  * [Upload recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/upload-recipients.md) — Sets the recipient list of a `draft` broadcast; each upload replaces the previous list
  * [List recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/list-recipients.md) — Returns the broadcast's recipients in upload order, with template `variables` and send state
  * [Preview a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/preview-broadcast.md) — Renders the template for the first pending recipients so you can check personalisation, encoding, and segments before launch
  * [Export results as CSV](https://www.vobiz.ai/docs/sms/api/broadcasts/export-broadcast.md) — Downloads every recipient with its send result as a CSV file (`text/csv`), named `broadcast-<id>.csv`
  * [Launch a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/launch-broadcast.md) — Starts sending real SMS to every `pending` recipient and charges your account per segment
  * [Pause a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/pause-broadcast.md) — Pauses a `running` broadcast. Sending stops after in-flight messages, pending recipients stay `pending`, and any other status returns `409`
  * [Resume a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/resume-broadcast.md) — Continues sending to pending recipients of a `paused` broadcast and moves it back to `running`
  * [Cancel a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/cancel-broadcast.md) — Stops a broadcast for good and sets `completedAt`
* **RCS Senders**
  * [Vobiz Messaging API: RCS Senders](https://www.vobiz.ai/docs/sms/api/senders) — The Vobiz RCS Senders API registers your branded RCS agent, tracks its launch status on the RCS platform, and manages its message templates
  * [Create an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/create-sender.md) — Registers a new RCS sender (agent) with the RCS platform and stores it on your account with status `pending`
  * [List RCS senders](https://www.vobiz.ai/docs/sms/api/senders/list-senders.md) — Returns the RCS senders on your account as a bare JSON array
  * [Retrieve an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/get-sender.md) — Returns one RCS sender as stored on your account, with its full profile
  * [Update an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/update-sender.md) — Updates the RCS sender's profile on the RCS platform and your account, and returns it
  * [Refresh sender status](https://www.vobiz.ai/docs/sms/api/senders/get-sender-status.md) — Asks the RCS platform for the sender's launch status, stores it, and returns the sender
  * [Create a template](https://www.vobiz.ai/docs/sms/api/senders/create-template.md) — Registers a message template on an RCS sender with the RCS platform and returns it with status `pending`
  * [List templates](https://www.vobiz.ai/docs/sms/api/senders/list-templates.md) — Returns the templates on one RCS sender as a bare JSON array
  * [Retrieve a template](https://www.vobiz.ai/docs/sms/api/senders/get-template.md) — Returns one RCS template as stored on your account, including its `content`
  * [Delete a template](https://www.vobiz.ai/docs/sms/api/senders/delete-template.md) — Removes the template from the RCS platform and your account, and returns `204` with no body
  * [Refresh template status](https://www.vobiz.ai/docs/sms/api/senders/get-template-status.md) — Asks the RCS platform for the template's approval status, stores it, and returns the full template
* **10DLC Registration**
  * [Vobiz Messaging API: 10DLC registration](https://www.vobiz.ai/docs/sms/api/10dlc) — Register US brands, 10DLC campaigns and toll-free verifications with the Vobiz Messaging API, upload supporting documents and track registry review
  * [Create a brand](https://www.vobiz.ai/docs/sms/api/10dlc/create-brand.md) — Creates a brand, the business identity that US carriers associate with your 10DLC traffic, and mirrors it to the US 10DLC registry in `DRAFT` stage
  * [List brands](https://www.vobiz.ai/docs/sms/api/10dlc/list-brands.md) — Returns every 10DLC brand on your account as a bare JSON array, newest first
  * [Retrieve a brand](https://www.vobiz.ai/docs/sms/api/10dlc/get-brand.md) — Returns one brand after refreshing its `stage`, `registrationStatus`, `brandIdentityStatus` and `rejectionReasons` from the US 10DLC registry
  * [Update a brand](https://www.vobiz.ai/docs/sms/api/10dlc/update-brand.md) — Replaces the 10DLC brand with the body you send and pushes the change to the registry
  * [Delete a brand](https://www.vobiz.ai/docs/sms/api/10dlc/delete-brand.md) — Deletes the brand from your account and from the US 10DLC registry and returns `204` with no body
  * [Register a brand](https://www.vobiz.ai/docs/sms/api/10dlc/register-brand.md) — Submits the brand to the US 10DLC registry for identity verification
  * [List brand registrar statuses](https://www.vobiz.ai/docs/sms/api/10dlc/brand-registrar-statuses.md) — Returns the brand's state at each registrar that has reviewed it, read live from the US 10DLC registry
  * [Request brand authentication](https://www.vobiz.ai/docs/sms/api/10dlc/brand-auth-verification.md) — Starts the registry's brand authentication for a brand whose `brandType` is `TENDLC_PUBLIC_COMPANY`
  * [Resend brand 2FA verification](https://www.vobiz.ai/docs/sms/api/10dlc/resend-2fa.md) — Asks the registry to resend brand-authentication verification to `businessContactEmail`, for a `TENDLC_PUBLIC_COMPANY` brand that is `PENDING_2FA`
  * [Vet a brand](https://www.vobiz.ai/docs/sms/api/10dlc/vet-brand.md) — Requests an external vet of a registered brand from the US 10DLC registry
  * [List brand vets](https://www.vobiz.ai/docs/sms/api/10dlc/list-brand-vets.md) — Returns the brand's vetting records from the US 10DLC registry, one page at a time, with each registry vetting record passed through as received
  * [10DLC: Create a Campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-campaign.md) — Creates a 10DLC campaign under one of your brands and mirrors it to the US 10DLC registry in `DRAFT` stage
  * [Create a toll-free campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-toll-free-campaign.md) — Starts toll-free verification for one or more toll-free numbers
  * [10DLC: List Campaigns](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaigns.md) — Returns every 10DLC and toll-free campaign on your account as a bare JSON array, newest first
  * [List campaign priorities](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-priorities.md) — Returns the priority options at the US 10DLC registry
  * [10DLC: Retrieve a Campaign](https://www.vobiz.ai/docs/sms/api/10dlc/get-campaign.md) — Returns one campaign after refreshing its `stage` and `rejectionReasons` from the US 10DLC registry
  * [10DLC: Update a Campaign](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign.md) — Replaces the editable fields of a 10DLC campaign and pushes the change to the registry
  * [Delete a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/delete-campaign.md) — Deletes the campaign from your account and from the US 10DLC registry and returns `204` with no body
  * [Register a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/register-campaign.md) — Submits the campaign to the US 10DLC registry for review
  * [Deregister a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/deregister-campaign.md) — Withdraws a registered campaign from the US 10DLC registry and returns the campaign
  * [Appeal a campaign rejection](https://www.vobiz.ai/docs/sms/api/10dlc/appeal-campaign.md) — Asks the US 10DLC registry to reconsider a `REJECTED` campaign and returns the campaign after the appeal is filed
  * [Update a campaign registration](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign-registration.md) — Asks the US 10DLC registry to update the set of numbers covered by a registered campaign, without deregistering it
  * [List campaign network statuses](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-network-statuses.md) — Returns the campaign's status at each US carrier network, read live from the US 10DLC registry, with its `state` and any reported class and..
  * [List campaign numbers](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaign-numbers.md) — Returns the numbers attached to the campaign at the US 10DLC registry, each with its country and the `numberKey` you can pass on the number endpoints
  * [Add numbers to a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/add-campaign-numbers.md) — Attaches numbers to the campaign at the US 10DLC registry and adds them to the campaign's `numbers` list
  * [Remove numbers from a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/remove-campaign-numbers.md) — Detaches numbers from the campaign at the US 10DLC registry and removes the `numbers` values from the campaign's `numbers` list on your account
  * [Upload a document](https://www.vobiz.ai/docs/sms/api/10dlc/upload-document.md) — Uploads a supporting document or MMS sample file for campaign registration and stores it at the US 10DLC registry
  * [Download a document](https://www.vobiz.ai/docs/sms/api/10dlc/get-document.md) — Downloads a document you uploaded with `POST /10dlc/documents`

## Guides

* [Send SMS with Vobiz](https://www.vobiz.ai/docs/sms/channels/sms.md) — Send and receive SMS with the Vobiz Messaging API - the send request, segments and encoding, cost preview, idempotency, scheduling, and two-way..
* [Send MMS with Vobiz](https://www.vobiz.ai/docs/sms/channels/mms.md) — Send MMS to US and Canadian numbers with the Vobiz Messaging API - media URL rules, text limits, the optional title, and automatic upgrades from SMS
* [Send RCS with Vobiz](https://www.vobiz.ai/docs/sms/channels/rcs.md) — Send RCS business messages with the Vobiz Messaging API - register a sender, add media and suggestion buttons, fall back to SMS, and check..
* [Vobiz RCS Senders and Templates](https://www.vobiz.ai/docs/sms/rcs-senders.md) — Create and manage RCS senders (agents) on Vobiz - the verified brand identity with name, logo, colour, and contact links - and their message..
* [Vobiz Messaging Broadcasts](https://www.vobiz.ai/docs/sms/broadcasts.md) — Send bulk SMS with Vobiz broadcasts - personalise a template, upload recipients from CSV, XLSX, or JSON, preview, launch at a controlled rate, and..
* [Vobiz Messaging Conversations and Inbox](https://www.vobiz.ai/docs/sms/conversations.md) — Read two-way SMS, MMS, and RCS threads on Vobiz - how inbound messages create conversations, listing threads, marking as read, and the console Inbox
* [Vobiz Messaging Opt-outs](https://www.vobiz.ai/docs/sms/opt-outs.md) — How Vobiz records STOP, HELP, and other keyword replies as opt-outs, how to add, list, check, and remove them by API, and how broadcasts honour the..
* [Vobiz Messaging Webhooks](https://www.vobiz.ai/docs/sms/webhooks.md) — Receive SMS, MMS, and RCS events on your server - create Vobiz webhook subscriptions, verify the X-Webhook-Signature HMAC, and de-duplicate on..
* [Vobiz Messaging WebSocket: Real-Time Events](https://www.vobiz.ai/docs/sms/websocket.md) — Stream live messaging events from Vobiz over a WebSocket - inbound messages, delivery status, broadcast progress, and more, with Node and browser..


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.