Skip to main content
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.

​
Getting Started

  • Vobiz Messaging API: SMS, MMS and RCS — 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 — 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 — 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 — 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 — Sends an SMS, MMS or RCS message from one of your numbers or RCS senders to one or more recipients
    • List messages — Returns the messages on your account, sent and received, newest first
    • Retrieve a message — Returns one message with its full status history
    • Preview message cost — Prices a message before you send it, without sending anything
    • Check RCS reachability — Checks whether a phone number can receive RCS from your RCS sender, without sending anything
  • Numbers
    • Vobiz Messaging 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 — 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 — Returns the countries where you can buy messaging numbers, with the number types and capabilities in stock in each
    • Search available numbers — Searches the inventory for numbers to buy in one country, with setup and monthly prices in your wallet currency
    • Purchase a number — Buys a number returned by GET /numbers/available and routes it to your account for messaging
    • List number purchases — Returns the numbers you bought through Vobiz, newest first, each with its wallet charges
    • Release a number — Cancels a number you bought through Vobiz and removes it from your account
  • Coverage
    • Vobiz Messaging 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 — Returns one summary row per destination country: accepted sender types, whether registration is required, two-way support, and opt-out rules
    • Retrieve country coverage — Returns the full coverage record for one country: sender types, registration and lead time, link rules, prohibited topics, and the sending window
  • Conversations
  • Opt-outs
    • Vobiz Messaging 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 — Adds a phone number to your opt-out list for one channel
    • List opt-outs — 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 — Tells you whether a phone number is on your opt-out list for a channel
    • Delete an opt-out — Removes a phone number from your opt-out list for one channel so you can message it again
  • Webhooks
    • Vobiz Messaging 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 — Registers an HTTPS endpoint that receives subscribed events as signed POST requests
    • List webhooks — Returns all of your webhook subscriptions, newest first, as a bare JSON array
    • Retrieve a webhook — Returns one webhook subscription with its URL, events, active flag, and signing secret
    • Update a webhook — Changes any subset of url, secret, events, and active on a webhook
    • Delete a webhook — Removes the subscription and stops all deliveries to its URL
  • Broadcasts
    • Vobiz Messaging 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 — Creates a broadcast in draft status with no recipients
    • List broadcasts — Returns the broadcasts on your account, newest first, each with freshly counted stats
    • Retrieve a broadcast — Returns one broadcast with its configuration, status, and freshly counted stats
    • Update a broadcast — 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 — Permanently removes a draft or cancelled broadcast together with its recipient list and returns 204 with no body
    • Upload recipients — Sets the recipient list of a draft broadcast; each upload replaces the previous list
    • List recipients — Returns the broadcast’s recipients in upload order, with template variables and send state
    • Preview a broadcast — Renders the template for the first pending recipients so you can check personalisation, encoding, and segments before launch
    • Export results as CSV — Downloads every recipient with its send result as a CSV file (text/csv), named broadcast-<id>.csv
    • Launch a broadcast — Starts sending real SMS to every pending recipient and charges your account per segment
    • Pause a broadcast — Pauses a running broadcast. Sending stops after in-flight messages, pending recipients stay pending, and any other status returns 409
    • Resume a broadcast — Continues sending to pending recipients of a paused broadcast and moves it back to running
    • Cancel a broadcast — Stops a broadcast for good and sets completedAt
  • RCS Senders
    • Vobiz Messaging API: RCS 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 — Registers a new RCS sender (agent) with the RCS platform and stores it on your account with status pending
    • List RCS senders — Returns the RCS senders on your account as a bare JSON array
    • Retrieve an RCS sender — Returns one RCS sender as stored on your account, with its full profile
    • Update an RCS sender — Updates the RCS sender’s profile on the RCS platform and your account, and returns it
    • Refresh sender status — Asks the RCS platform for the sender’s launch status, stores it, and returns the sender
    • Create a template — Registers a message template on an RCS sender with the RCS platform and returns it with status pending
    • List templates — Returns the templates on one RCS sender as a bare JSON array
    • Retrieve a template — Returns one RCS template as stored on your account, including its content
    • Delete a template — Removes the template from the RCS platform and your account, and returns 204 with no body
    • Refresh template status — Asks the RCS platform for the template’s approval status, stores it, and returns the full template
  • 10DLC Registration
    • Vobiz Messaging API: 10DLC registration — Register US brands, 10DLC campaigns and toll-free verifications with the Vobiz Messaging API, upload supporting documents and track registry review
    • Create a brand — 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 — Returns every 10DLC brand on your account as a bare JSON array, newest first
    • Retrieve a brand — Returns one brand after refreshing its stage, registrationStatus, brandIdentityStatus and rejectionReasons from the US 10DLC registry
    • Update a brand — Replaces the 10DLC brand with the body you send and pushes the change to the registry
    • Delete a brand — Deletes the brand from your account and from the US 10DLC registry and returns 204 with no body
    • Register a brand — Submits the brand to the US 10DLC registry for identity verification
    • List brand registrar statuses — Returns the brand’s state at each registrar that has reviewed it, read live from the US 10DLC registry
    • Request brand authentication — Starts the registry’s brand authentication for a brand whose brandType is TENDLC_PUBLIC_COMPANY
    • Resend brand 2FA verification — Asks the registry to resend brand-authentication verification to businessContactEmail, for a TENDLC_PUBLIC_COMPANY brand that is PENDING_2FA
    • Vet a brand — Requests an external vet of a registered brand from the US 10DLC registry
    • List brand vets — 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 — 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 — Starts toll-free verification for one or more toll-free numbers
    • 10DLC: List Campaigns — Returns every 10DLC and toll-free campaign on your account as a bare JSON array, newest first
    • List campaign priorities — Returns the priority options at the US 10DLC registry
    • 10DLC: Retrieve a Campaign — Returns one campaign after refreshing its stage and rejectionReasons from the US 10DLC registry
    • 10DLC: Update a Campaign — Replaces the editable fields of a 10DLC campaign and pushes the change to the registry
    • Delete a campaign — Deletes the campaign from your account and from the US 10DLC registry and returns 204 with no body
    • Register a campaign — Submits the campaign to the US 10DLC registry for review
    • Deregister a campaign — Withdraws a registered campaign from the US 10DLC registry and returns the campaign
    • Appeal a campaign rejection — Asks the US 10DLC registry to reconsider a REJECTED campaign and returns the campaign after the appeal is filed
    • Update a campaign registration — Asks the US 10DLC registry to update the set of numbers covered by a registered campaign, without deregistering it
    • List campaign network statuses — 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 — 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 — Attaches numbers to the campaign at the US 10DLC registry and adds them to the campaign’s numbers list
    • Remove numbers from a campaign — 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 — Uploads a supporting document or MMS sample file for campaign registration and stores it at the US 10DLC registry
    • Download a document — Downloads a document you uploaded with POST /10dlc/documents

​
Guides

  • Send SMS with Vobiz — 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 — 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 — 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 — 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 — 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 — 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 — 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 — 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 — Stream live messaging events from Vobiz over a WebSocket - inbound messages, delivery status, broadcast progress, and more, with Node and browser..