openapi: 3.0.3
info:
  title: Vobiz Messaging API
  description: |
    Send and receive SMS, MMS and RCS messages, buy messaging numbers, register for
    US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and webhooks.

    **Base URL:** `https://api.vobiz.ai/api/v1/Account/{auth_id}/Sms`, where `{auth_id}` is your
    account Auth ID. Paths in descriptions, such as `POST /Message/`, are relative to it.
    Coverage (`/api/v1/sms/coverage`) and `/api/v1/sms/numbers/countries` are not account data
    and keep their `https://api.vobiz.ai/api/v1/sms` URLs.

    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token` headers. The
    `{auth_id}` in the path must be the account those credentials belong to, otherwise the
    request returns `403`. Field names in this API are camelCase.

    The earlier URLs under `https://api.vobiz.ai/api/v1/sms` (for example `POST /api/v1/sms/messages`)
    still work.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://www.vobiz.ai
servers:
- url: https://api.vobiz.ai
  description: Production
security:
- AuthID: []
  AuthToken: []
tags:
- name: Messages
  description: Send messages and inspect their delivery state.
- name: Numbers
  description: Messaging-capable numbers on your account, inventory search, purchase and release.
- name: Number lookup
  description: Check whether numbers exist and are reachable on the mobile network, and which network serves them.
- name: Coverage
  description: Where you can send, per country.
- name: Conversations
  description: Two-way threads between one of your numbers and a contact.
- name: Opt-outs
  description: Numbers that must not receive messages on a channel.
- name: Webhooks
  description: Subscriptions that deliver message and broadcast events to your server.
- name: Broadcasts
  description: Bulk sends from an uploaded recipient list.
- name: RCS Senders
  description: RCS sender (agent) identities and their message templates.
- name: 10DLC Brands
  description: US 10DLC brand registration.
- name: 10DLC Campaigns
  description: US 10DLC campaigns, toll-free verification and supporting documents.
components:
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID (`MA_XXXXXXXX`).
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token.
  responses:
    BadRequest:
      description: The request body or a parameter is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid request body
    Unauthorized:
      description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`. The API gateway answers before the request reaches
        the messaging service, so `error` is an object with `code` and `message`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          examples:
            missing:
              summary: No credentials
              value:
                error:
                  code: 401
                  message: 'Authentication required: provide either Authorization header or X-Auth-ID and X-Auth-Token
                    headers'
            invalid:
              summary: Wrong Auth Token
              value:
                error:
                  code: 401
                  message: Invalid authentication credentials
    Forbidden:
      description: The `{auth_id}` in the path is not the account that the `X-Auth-ID` / `X-Auth-Token` credentials belong
        to. The API gateway answers, so `error` is an object with `code` and `message`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            error:
              code: 403
              message: 'Access denied: account ID mismatch'
    ServerError:
      description: Unexpected error. Retry with the same idempotency key where one applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  parameters:
    AuthId:
      name: auth_id
      in: path
      required: true
      description: Your account Auth ID. It must match the `X-Auth-ID` header.
      schema:
        type: string
        example: MA_XXXXXXXX
  schemas:
    Error:
      type: object
      description: 'The body of every error response: a flat object with one `error` string that explains what went wrong.
        Use the HTTP status code to decide how to handle the error, and log `error` for diagnosis.'
      required:
      - error
      properties:
        error:
          type: string
          example: 'recipient has opted out: +14155550123'
          description: 'Human-readable explanation of the error, for example `phoneNumber is required` or `recipient has opted
            out: +14155550123`. Branch on the HTTP status code rather than on this text.'
    GatewayError:
      type: object
      description: 'Error body returned by the Vobiz API gateway for authentication (`401`) and account-mismatch (`403`)
        failures, before the request reaches the messaging service. Unlike `Error`, `error` is an object.'
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: integer
              example: 401
              description: The HTTP status code, repeated.
            message:
              type: string
              example: Invalid authentication credentials
              description: Human-readable explanation of the failure.
    StatusOk:
      type: object
      properties:
        status:
          type: string
          example: ok
          description: Always `ok` when the action succeeded.
      description: Confirmation returned by actions that have no resource to return, such as marking a conversation read or
        creating or deleting an opt-out.
    RCSSuggestion:
      type: object
      description: 'One suggestion button on an RCS message: a suggested reply or an action the recipient can tap. Which optional
        fields apply depends on `type`.'
      required:
      - type
      - text
      properties:
        type:
          type: string
          enum:
          - REPLY
          - OPEN_URL
          - DIAL_PHONE
          - SHOW_LOCATION
          - REQUEST_LOCATION
          description: 'What the button does: `REPLY` sends `text` back as a reply, `OPEN_URL` opens `url`, `DIAL_PHONE` calls
            `phoneNumber`, `SHOW_LOCATION` shows a map pin at `latitude`/`longitude`, and `REQUEST_LOCATION` asks the recipient
            to share their location.'
        text:
          type: string
          description: Button label shown to the recipient. Keep it short so it fits on the button.
          example: Reschedule
        postbackData:
          type: string
          description: Your own string, returned to you with the inbound event when the recipient taps the button. Use it
            to tell which button was tapped.
          example: reschedule
        url:
          type: string
          format: uri
          description: HTTPS link to open. Used only when `type` is `OPEN_URL`.
        phoneNumber:
          type: string
          description: Phone number to dial, in E.164 format. Used only when `type` is `DIAL_PHONE`.
          example: '+14155550100'
        latitude:
          type: number
          description: Latitude of the map pin, in decimal degrees from `-90` to `90`. Used only when `type` is `SHOW_LOCATION`.
        longitude:
          type: number
          description: Longitude of the map pin, in decimal degrees from `-180` to `180`. Used only when `type` is `SHOW_LOCATION`.
        label:
          type: string
          description: Label shown on the map pin. Used only when `type` is `SHOW_LOCATION`.
    Message:
      type: object
      description: One message sent from or received by your account. Each recipient of a send gets its own message object
        with its own `id`, status and conversation.
      properties:
        id:
          type: string
          format: uuid
          example: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
          description: Unique identifier of the message (UUID). Use it with `GET /Message/{id}/` and to match status events.
        accountId:
          type: string
          description: Your Vobiz account ID (Auth ID), for example `MA_XXXXXXXX`.
          example: MA_XXXXXXXX
        direction:
          type: string
          enum:
          - out
          - in
          description: '`out` for a message you sent, `in` for a message one of your numbers received.'
        channel:
          type: string
          enum:
          - sms
          - mms
          - rcs
          description: 'Channel the message actually used: `sms`, `mms` or `rcs`. It can differ from the one you requested,
            for example `mms` after an SMS with media to US or Canadian numbers, or `sms` after an RCS send fell back with
            `failoverToSms`.'
        from:
          type: string
          example: '+14155550100'
          description: Sender. For outbound messages, your number in E.164 format or the `senderName` of your RCS sender;
            for inbound messages, the contact's number.
        to:
          type: string
          example: '+14155550123'
          description: Recipient. For outbound messages, the contact's number in E.164 format; for inbound messages, your
            number.
        text:
          type: string
          example: Your verification code is 482913
          description: Message body. An empty string when the message has no text, for example an MMS with media only.
        mediaUrls:
          type: array
          nullable: true
          items:
            type: string
            format: uri
          description: HTTPS URLs of the media attached to the message. `null` or an empty array when there is no media.
        status:
          type: string
          enum:
          - scheduled
          - sent
          - delivered
          - failed
          - received
          - unknown
          description: 'Where the message is in its lifecycle: `scheduled` (held for `scheduledAt`), `sent` (handed to the
            network), `delivered` (delivery confirmed), `failed` (see `errorCode` and `errorMessage`), `received` (inbound)
            or `unknown` (the network reported a status that maps to none of the others).'
        errorCode:
          type: string
          description: Error code reported for a failed message. Omitted when there is no error.
        errorMessage:
          type: string
          description: Human-readable reason a message failed. Omitted when there is no error; quote it to support when you
            need help with a failure.
        tag:
          type: string
          description: The label you set when sending, for filtering and reporting. Omitted when none was set.
        conversationId:
          type: string
          format: uuid
          description: UUID of the conversation the message belongs to. Use it with `GET /Conversation/{id}/Message/` to
            load the thread.
        scheduledAt:
          type: string
          format: date-time
          description: The time you asked the message to be held until (ISO 8601, UTC). Omitted for messages that were not
            scheduled.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the message was created, as an RFC 3339 / ISO 8601 timestamp in UTC.
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the message last changed, for example on a status update (ISO 8601, UTC).
    MessageStatusEntry:
      type: object
      properties:
        status:
          type: string
          enum:
          - scheduled
          - sent
          - delivered
          - failed
          - received
          - unknown
          description: 'The status the message moved to: `scheduled`, `sent`, `delivered`, `failed`, `received` or `unknown`.'
        errorCode:
          type: string
          description: Error code reported with this status. Omitted unless the entry records a failure.
        errorMessage:
          type: string
          description: Human-readable failure reason reported with this status. Omitted unless the entry records a failure.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
        createdAt:
          type: string
          format: date-time
          description: When the message reached this status (ISO 8601, UTC).
      description: 'One entry in a message''s status history: a status the message reached and when.'
    MessageWithHistory:
      allOf:
      - $ref: '#/components/schemas/Message'
      - type: object
        properties:
          statusHistory:
            type: array
            nullable: true
            description: Every status the message has passed through, oldest first, each with its time and any error detail.
              `null` when no status change has been recorded.
            items:
              $ref: '#/components/schemas/MessageStatusEntry'
      description: A message with its full status history, as returned by `GET /Message/{id}/`. It has every field of the
        message object plus `statusHistory`.
    SendMessageRequest:
      type: object
      required:
      - from
      - to
      properties:
        from:
          type: string
          description: The sender. For `sms` and `mms`, one of your Vobiz numbers in E.164 format, for example `+14155550100`.
            For `rcs`, the `senderName` of your RCS sender (from `GET /Sender/`); with `failoverToSms`, the SMS copy is sent
            from a number on your account.
          example: '+14155550100'
        to:
          type: array
          description: One or more recipient numbers in E.164 format. Each one becomes a separate message with its own `id`;
            blank entries and duplicates are skipped. At least one recipient is required.
          minItems: 1
          items:
            type: string
          example:
          - '+14155550123'
        channel:
          type: string
          enum:
          - sms
          - mms
          - rcs
          default: sms
          description: 'Channel to send on: `sms`, `mms` or `rcs`. Defaults to `sms`. An `sms` with `mediaUrls` to US or Canadian
            recipients is sent as MMS automatically.'
        text:
          type: string
          description: Message body. Required for `sms` and `rcs`. A long SMS is split into segments and billed per segment
            (160 GSM-7 or 70 UCS-2 characters fit in one segment). For `mms`, provide `text`, `mediaUrls` or both, with `text`
            up to 5000 characters.
          example: Your verification code is 482913
        mediaUrls:
          type: array
          description: Publicly reachable `https` URLs of media to attach. MMS accepts up to 10. RCS sends the first URL as
            a file. An SMS to recipients outside the US and Canada is sent as text only.
          maxItems: 10
          items:
            type: string
            format: uri
        title:
          type: string
          description: Subject line of an MMS. Used only when the message is sent as MMS.
        tag:
          type: string
          description: Your own label, stored on every message the request creates. Filter `GET /Message/` by it to find all
            recipients of one send or to group messages for reporting.
          example: otp
        idempotencyKey:
          type: string
          description: A unique string you choose, for example a UUID or your own order ID, scoped to your account. Retrying
            with the same key returns the original message instead of sending again. With several recipients the key is applied
            per recipient.
          example: otp-482913-user-77
        scheduledAt:
          type: string
          format: date-time
          description: Time to hold the message until, as an RFC 3339 / ISO 8601 timestamp such as `2026-11-01T09:00:00Z`.
            A future time stores the message with status `scheduled`; a past time or now sends immediately.
        failoverToSms:
          type: boolean
          default: false
          description: Used only when `channel` is `rcs`. When `true` and the RCS send cannot go through, Vobiz sends the
            same `text` as SMS and the message's `channel` becomes `sms`. Defaults to `false`.
        rcsSuggestions:
          type: array
          description: Suggestion buttons (suggested replies and actions) to show under an RCS message. Used only when `channel`
            is `rcs`. See the RCS suggestion object for each `type`.
          items:
            $ref: '#/components/schemas/RCSSuggestion'
        dltEntityId:
          type: string
          description: 'India (TRAI DLT): the Principal Entity ID you registered on a TRAI DLT portal. Pass it on every message
            to Indian numbers.'
        dltHeaderId:
          type: string
          description: 'India (TRAI DLT): the ID of the sender header you registered on a TRAI DLT portal. Pass it on every
            message to Indian numbers.'
        dltTemplateId:
          type: string
          description: 'India (TRAI DLT): the ID of the content template you registered on a TRAI DLT portal. `text` must
            match that template with its variables filled in.'
      description: What to send, from which sender, to whom and on which channel, plus optional scheduling, idempotency, RCS
        and India DLT settings.
    MessageList:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          description: The messages on this page, newest first. An empty array when nothing matches.
        total:
          type: integer
          example: 128
          description: Total number of messages that match your filters across all pages. Stop paging when `offset` plus the
            page length reaches it.
        limit:
          type: integer
          example: 20
          description: The `limit` value from your request. A page holds up to 100 messages, and 20 by default.
        offset:
          type: integer
          example: 0
          description: The number of messages skipped before this page, as sent in the request.
      description: One page of messages from `GET /Message/`, with the total number of matches so you can page through the
        rest.
    CostPreview:
      type: object
      properties:
        channel:
          type: string
          example: sms
          description: 'Channel the estimate is for: `sms`, `mms` or `rcs`, matching the `channel` you requested.'
        segmentCount:
          type: integer
          example: 2
          description: Number of segments the text splits into. A GSM-7 SMS fits 160 characters in one segment and 153 per
            segment when split; text with other characters uses UCS-2 (70 and 67).
        unitCost:
          type: number
          example: 0.01
          description: Price of one segment, in `currency`.
        totalCost:
          type: number
          example: 0.02
          description: 'Estimated price of the message to one recipient, in `currency`: `unitCost` multiplied by `segmentCount`.'
        currency:
          type: string
          example: USD
          description: ISO 4217 code of the currency the prices are in, for example `USD`.
        country:
          type: string
          description: ISO 3166-1 alpha-2 code of the destination country, for example `US`. Omitted when the destination
            country is not resolved.
          example: US
      description: 'An estimate of what a message costs before you send it: how many segments the text splits into, and the
        price per segment and in total.'
    RCSReachability:
      type: object
      properties:
        to:
          type: string
          example: '+14155550123'
          description: The phone number that was checked, in E.164 format.
        reachable:
          type: boolean
          description: '`true` when the number can receive RCS from your sender. When `false`, send as SMS or set `failoverToSms`
            on an RCS send.'
        carrier:
          type: string
          description: Name of the recipient's mobile carrier. Omitted when it is not known.
        capability:
          type: string
          description: Capability label returned with the result, for example `reachable`. Base your decision on `reachable`.
      description: Whether a phone number can receive RCS messages from your RCS sender.
    SMSNumberTenDlc:
      type: object
      nullable: true
      description: The most relevant US registration campaign attached to a number. `null` when no campaign is attached.
      properties:
        campaignId:
          type: string
          format: uuid
          example: 3f1c7a2e-9d4b-4e8a-b6c5-2a7d9e1f0b43
          description: ID of the campaign the number is registered to. Use it with the 10DLC campaign endpoints.
        campaignName:
          type: string
          example: Order notifications
          description: Name you gave that campaign.
        stage:
          type: string
          description: Registry stage of the campaign in upper case, for example `REGISTERED` or `IN_REVIEW`. Treat as an
            open string.
          example: REGISTERED
    SMSNumberRegistration:
      type: object
      description: 'US A2P registration state of a number: which registration path applies and how far it has progressed.'
      properties:
        kind:
          type: string
          enum:
          - 10dlc
          - toll_free
          - none
          description: 'Registration path: `10dlc` for long numbers that need a 10DLC campaign, `toll_free` for toll-free
            numbers that need toll-free verification, `none` when no US registration applies.'
        status:
          type: string
          enum:
          - not_registered
          - draft
          - pending
          - approved
          - rejected
          - not_required
          description: 'Progress of that registration: `not_registered` (no campaign attached), `draft` (campaign not submitted),
            `pending` (under review), `approved` (cleared to send to US recipients), `rejected` (fix and resubmit) or `not_required`.'
        campaignId:
          type: string
          description: ID of the campaign the number is attached to. Empty string when none.
          example: 3f1c7a2e-9d4b-4e8a-b6c5-2a7d9e1f0b43
        campaignName:
          type: string
          description: Name of that campaign. Empty string when none.
          example: Order notifications
        stage:
          type: string
          description: Registry stage of that campaign in upper case, for example `REGISTERED`. Treat as an open string; empty
            string when none.
          example: REGISTERED
    SMSNumberLastMessage:
      type: object
      nullable: true
      description: The latest outbound message sent from a number, for a quick health check. `null` when the number has not
        sent a message yet.
      properties:
        status:
          type: string
          enum:
          - scheduled
          - sent
          - delivered
          - failed
          - received
          - unknown
          description: 'Delivery status of that message: `scheduled`, `sent`, `delivered`, `failed`, `received` or `unknown`.'
        errorCode:
          type: string
          description: Error code reported for the message. Empty string unless the message failed.
        errorMessage:
          type: string
          description: Human-readable reason for the failure. Empty string unless the message failed.
        to:
          type: string
          example: '+14155550123'
          description: Recipient of that message in E.164 format.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-16T21:23:02Z'
          description: When that message was created (ISO 8601).
    SMSNumberSendable:
      type: object
      description: Where a number can send right now, derived from its country and registration state. Check it before you
        send.
      properties:
        international:
          type: boolean
          description: '`true` when the number can send to recipients outside the US.'
        usDomestic:
          type: boolean
          description: '`true` when the number can send to US recipients. A US number needs an approved 10DLC campaign or
            completed toll-free verification before this becomes `true`.'
    SMSNumber:
      type: object
      description: A messaging-capable number on your account, with its registration state and what it can send.
      properties:
        e164:
          type: string
          example: '+14155550100'
          description: The number in E.164 format. Use it as `from` when you send.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
        countryCode:
          type: string
          description: Upper-case ISO 3166-1 alpha-2 code of the number's country. Empty string when unknown.
          example: US
        channels:
          type: array
          description: 'Lower-case channels routed on the number: `sms`, `mms` and `rcs`. Defaults to `["sms"]`.'
          items:
            type: string
            enum:
            - sms
            - mms
            - rcs
          example:
          - sms
          - mms
        type:
          type: string
          description: Inventory type in upper case, for example `VIRTUAL_LONG_NUMBER`, `SHORT_CODE` or `TOLL_FREE`. Empty
            string when unknown.
          example: VIRTUAL_LONG_NUMBER
        capabilities:
          type: array
          description: Upper-case capability labels, for example `SMS`, `MMS` and `VOICE`. Empty array when unknown.
          items:
            type: string
          example:
          - SMS
          - MMS
          - VOICE
        tenDlc:
          allOf:
          - $ref: '#/components/schemas/SMSNumberTenDlc'
          description: The most relevant US registration campaign attached to the number. `null` when no campaign is attached.
        tollFree:
          type: boolean
          description: '`true` for US toll-free numbers, which use toll-free verification instead of a 10DLC campaign.'
        registration:
          allOf:
          - $ref: '#/components/schemas/SMSNumberRegistration'
          description: US A2P registration state of the number and the campaign behind it.
        lastMessage:
          allOf:
          - $ref: '#/components/schemas/SMSNumberLastMessage'
          description: The latest outbound message sent from this number. `null` when the number has not sent a message yet.
        sendable:
          allOf:
          - $ref: '#/components/schemas/SMSNumberSendable'
          description: Where the number can send right now, derived from its country and registration state.
    SMSNumberList:
      type: object
      properties:
        numbers:
          type: array
          description: Numbers routed for SMS or MMS, sorted by `countryCode` and then `e164`. Empty array when you have no
            messaging numbers.
          items:
            $ref: '#/components/schemas/SMSNumber'
      description: The messaging numbers on your account.
    NumberCountry:
      type: object
      description: A country with messaging numbers in stock.
      properties:
        country:
          type: string
          description: ISO 3166-1 alpha-2 code of the country. Pass it as `country` to `GET /Number/Available/`.
          example: US
        name:
          type: string
          example: United States
          description: English name of the country, for example `United States`.
        types:
          type: array
          description: 'Number types in stock: `local`, `mobile`, `tollfree` or `shortcode`, or another lower-case inventory
            type.'
          items:
            type: string
          example:
          - local
          - tollfree
        capabilities:
          type: array
          items:
            type: string
          example:
          - SMS
          - MMS
          - VOICE
          description: Upper-case capabilities offered by numbers in stock in the country, for example `SMS`, `MMS` and `VOICE`.
            Not every number has every capability; filter with `capabilities` on `GET /Number/Available/`.
    NumberCountries:
      type: object
      properties:
        countries:
          type: array
          items:
            $ref: '#/components/schemas/NumberCountry'
          description: Countries with numbers in stock. Empty while `ready` is `false`.
        updatedAt:
          type: string
          format: date-time
          nullable: true
          description: When the stock snapshot was last refreshed (ISO 8601). `null` until the first snapshot is built.
          example: '2026-10-18T03:19:11Z'
        ready:
          type: boolean
          description: '`true` once the stock snapshot has been built. While `false`, `countries` is empty and `updatedAt`
            is `null`; retry after a few seconds.'
      description: Countries where you can buy messaging numbers, from a snapshot of the inventory.
    AvailableNumber:
      type: object
      description: A number in the inventory that you can buy, with its type, capabilities and price.
      properties:
        e164:
          type: string
          example: '+14155550100'
          description: The number in E.164 format. Pass it as `e164` on `POST /Number/Purchase/`.
        numberKey:
          type: string
          description: Opaque inventory key for the number. Pass it as `numberKey` on `POST /Number/Purchase/` when it is
            not empty; it is empty for US numbers, which are bought by `e164` alone.
          example: ''
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country the number belongs to.
        type:
          type: string
          example: VIRTUAL_LONG_NUMBER
          description: Inventory type of the number in upper case, for example `VIRTUAL_LONG_NUMBER` or `TOLL_FREE`.
        capabilities:
          type: array
          items:
            type: string
          example:
          - MMS
          - SMS
          - VOICE
          description: Upper-case capability labels for the number, for example `SMS`, `MMS` and `VOICE`. Order is not significant.
        network:
          type: string
          description: Name of the mobile network the number belongs to, when published. Empty string otherwise.
          example: ''
        setupPrice:
          type: number
          description: One-time setup fee charged at purchase, in `currency`.
          example: 1
        monthlyPrice:
          type: number
          description: Monthly rental charged at purchase for the first month and then on each renewal, in `currency`.
          example: 1
        currency:
          type: string
          description: ISO 4217 code of the prices, which is your wallet currency, for example `USD`.
          example: USD
        providerRequiresDocuments:
          type: boolean
          description: '`true` when the number needs regulatory documents before it can be activated. Contact support to buy
            such a number; `POST /Number/Purchase/` returns `422` for it.'
    AvailableNumbersResponse:
      type: object
      properties:
        numbers:
          type: array
          items:
            $ref: '#/components/schemas/AvailableNumber'
          description: Numbers that match your filters, at most 10 per search. Empty array when nothing matches, and for `country=IN`.
        page:
          type: integer
          example: 0
          description: The zero-based page index you requested.
        limit:
          type: integer
          example: 10
          description: Page size applied to this search, at most `10`.
        hasMore:
          type: boolean
          example: false
          description: Reserved for pagination; `false` on every response. Run a new search with different filters to see
            other numbers.
        hint:
          type: string
          description: Guidance returned only for `country=IN`, explaining that Indian traffic is sent from DLT-registered
            sender IDs rather than purchased numbers. Absent for every other country.
          example: India uses DLT sender IDs, not long codes
      description: One page of inventory search results.
    PurchaseNumberRequest:
      type: object
      required:
      - e164
      - country
      properties:
        e164:
          type: string
          description: The number to buy, in E.164 format, exactly as returned in `e164` by `GET /Number/Available/`. Required.
          example: '+14155550100'
        country:
          type: string
          description: ISO 3166-1 alpha-2 code of the number's country, for example `US`. Required, and must match the number;
            a mismatch returns `400`.
          example: US
        numberKey:
          type: string
          description: The `numberKey` from `GET /Number/Available/`. Required when the search result has a non-empty `numberKey`,
            as for `CA` and `GB` numbers; omit it for US numbers, which are bought by `e164` alone.
      description: The number to buy, taken from a `GET /Number/Available/` result.
    NumberBillingCharge:
      type: object
      description: 'One wallet charge raised for a purchased number: the initial purchase charge or a monthly renewal.'
      properties:
        purchaseId:
          type: string
          format: uuid
          example: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
          description: '`id` of the purchase this charge belongs to.'
        kind:
          type: string
          enum:
          - purchase
          - rental
          description: '`purchase` for the setup fee plus the first month, charged when you buy; `rental` for each later monthly
            renewal.'
        periodStart:
          type: string
          format: date-time
          example: '2026-10-12T09:06:42Z'
          description: Start of the billing period this charge covers (ISO 8601).
        amount:
          type: number
          example: 2
          description: 'Amount charged, in `currency`. For `kind: purchase` this is the setup fee plus the first month.'
        currency:
          type: string
          example: USD
          description: ISO 4217 code of `amount`, for example `USD`.
        status:
          type: string
          enum:
          - pending
          - paid
          - failed
          - refunded
          description: '`pending` while the charge is waiting to be collected, `paid` once collected, `failed` when collection
            failed, `refunded` when the amount was returned to your wallet.'
        reference:
          type: string
          description: Ledger reference for the charge, as it appears in your wallet transactions. Quote it to support when
            reconciling.
          example: sms_number_purchase:5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
        attempts:
          type: integer
          example: 1
          description: How many times collection of this charge has been attempted. Values above `1` mean earlier attempts
            failed, typically for lack of balance.
        attemptedAt:
          type: string
          format: date-time
          example: '2026-10-12T09:06:42Z'
          description: When collection was last attempted (ISO 8601).
    NumberPurchase:
      type: object
      description: A number you bought through Vobiz, with its price, lifecycle status and billing history.
      properties:
        id:
          type: string
          format: uuid
          example: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
          description: Unique identifier of the purchase (UUID).
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Auth ID of the account that owns the purchase, for example `MA_XXXXXXXX`.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
        e164:
          type: string
          example: '+14155550100'
          description: The purchased number in E.164 format. Use it as the path value of `POST /Number/{e164}/Release/`.
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the number's country.
        type:
          type: string
          example: VIRTUAL_LONG_NUMBER
          description: Inventory type of the number in upper case, for example `VIRTUAL_LONG_NUMBER`.
        capabilities:
          type: array
          items:
            type: string
          example:
          - VOICE
          - SMS
          - MMS
          description: Upper-case capability labels for the number, for example `SMS`, `MMS` and `VOICE`.
        setupAmount:
          type: number
          example: 1
          description: One-time setup fee charged at purchase, in `currency`.
        monthlyAmount:
          type: number
          example: 1
          description: Monthly rental for the number, in `currency`.
        currency:
          type: string
          example: USD
          description: ISO 4217 code of the amounts, for example `USD`.
        status:
          type: string
          enum:
          - pending
          - debited
          - purchased
          - past_due
          - failed
          - refunded
          - released
          description: 'Lifecycle state: `pending` (created), `debited` (charged, purchase in progress), `purchased` (active
            and billing monthly), `past_due` (a renewal has been failing for more than 7 days), `failed` (did not complete),
            `refunded` (charge returned after a failed purchase) or `released` (you released it).'
        purchasedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-12T09:06:44Z'
          description: When the number went live on your account (ISO 8601). `null` until the purchase completes.
        nextBillingAt:
          type: string
          format: date-time
          nullable: true
          description: When the next monthly rental is charged (ISO 8601). `null` before the purchase completes and after
            release.
          example: '2026-11-12T09:06:44Z'
        releasedAt:
          type: string
          format: date-time
          nullable: true
          example: null
          description: When you released the number (ISO 8601). `null` while the number is active.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T09:06:42Z'
          description: When the purchase was started (ISO 8601).
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T09:06:44Z'
          description: When the purchase last changed, for example on renewal or release (ISO 8601).
        charges:
          type: array
          nullable: true
          description: 'Wallet charges raised for this number, oldest first: the initial `purchase` charge and each monthly
            `rental`. `null` when none have been raised.'
          items:
            $ref: '#/components/schemas/NumberBillingCharge'
    NumberRouting:
      type: object
      description: The routing record that connects a purchased number to your account for messaging.
      properties:
        id:
          type: integer
          example: 1042
          description: Numeric identifier of the routing record.
        e164:
          type: string
          example: '+14155550100'
          description: The routed number in E.164 format.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
        channelCapabilities:
          type: array
          description: Lower-case messaging channels routed on the number, for example `sms` and `mms`.
          items:
            type: string
          example:
          - sms
          - mms
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Auth ID of the account the number is routed to, for example `MA_XXXXXXXX`.
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the number's country.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T09:06:44Z'
          description: When the number was routed to your account (ISO 8601).
    PurchaseNumberResponse:
      type: object
      properties:
        purchase:
          allOf:
          - $ref: '#/components/schemas/NumberPurchase'
          description: 'The purchase record, with `status: purchased`, the amounts charged and `nextBillingAt`.'
        number:
          allOf:
          - $ref: '#/components/schemas/NumberRouting'
          description: The routing record that connects the number to your account. The number appears in `GET /Number/` from
            this point.
      description: 'The result of a successful purchase: the billing record and the routing record.'
    NumberPurchaseList:
      type: object
      properties:
        purchases:
          type: array
          description: Your purchases, newest first, including released numbers. Empty array when you have not bought a
            number.
          items:
            $ref: '#/components/schemas/NumberPurchase'
      description: The numbers you have bought, with their billing history.
    ReleaseNumberResponse:
      type: object
      properties:
        purchase:
          allOf:
          - $ref: '#/components/schemas/NumberPurchase'
          description: 'The purchase record after release, with `status: released`, `releasedAt` set and `nextBillingAt` set
            to `null`.'
      description: The result of releasing a number.
    LocalIntl:
      type: object
      description: A coverage rule that can differ for local (in-country) and international senders. Each value is `true`,
        `false`, or `null` when unknown.
      properties:
        local:
          type: boolean
          nullable: true
          description: Value of the rule for local (in-country) traffic. `null` when unknown.
        international:
          type: boolean
          nullable: true
          description: Value of the rule for international traffic, sent from outside the country. `null` when unknown.
    CoverageSenders:
      type: object
      description: Which sender types a destination accepts, each split into local and international traffic.
      properties:
        alphanumeric:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether alphanumeric sender IDs (a brand name such as `ACME` in place of a number) are accepted.
        shortCode:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether short codes (5 or 6 digit numbers) are accepted as senders.
        longNumber:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether long numbers (standard-length phone numbers, such as US 10DLC numbers) are accepted as senders.
    CoverageSummary:
      type: object
      description: One row of the coverage list, with the key rules for a destination country. Call `GET /api/v1/sms/coverage/{country}`
        for the full record.
      properties:
        country:
          type: string
          description: ISO 3166-1 alpha-2 code of the country. Pass it to `GET /api/v1/sms/coverage/{country}`.
          example: US
        name:
          type: string
          example: United States
          description: English name of the country or territory, for example `United States`.
        region:
          type: string
          nullable: true
          example: Northern America
          description: Geographic region the country belongs to, for example `Northern America`. `null` when not assigned.
        dialCode:
          type: string
          description: Country calling code without the `+`, for example `1` or `44`.
          example: '1'
        senders:
          allOf:
          - $ref: '#/components/schemas/CoverageSenders'
          description: Which sender types the country accepts, for local and international traffic.
        registrationRequired:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether senders must be registered before sending, for local and international traffic.
        twoWay:
          type: boolean
          nullable: true
          description: '`true` when recipients can reply to your messages, `false` when they cannot, `null` when unknown.'
        optOutMandatory:
          type: boolean
          nullable: true
          description: '`true` when messages must offer an opt-out, such as replying STOP. `null` when unknown.'
        hasSendWindow:
          type: boolean
          description: '`true` when the country restricts sending to certain hours. Read `sendWindow` on `GET /api/v1/sms/coverage/{country}`
            for the hours.'
    CoverageList:
      type: object
      properties:
        countries:
          type: array
          items:
            $ref: '#/components/schemas/CoverageSummary'
          description: One summary row per matching country, sorted by country name. Empty array when nothing matches.
        total:
          type: integer
          description: Number of rows in `countries` after filtering.
          example: 253
        updatedAt:
          type: string
          format: date-time
          description: When the coverage dataset was last refreshed (ISO 8601).
          example: '2026-10-09T09:49:01Z'
      description: Coverage summary rows for every country that matches your filters.
    CoverageRegistration:
      type: object
      description: Sender registration requirements for a destination country. The text fields are free-form and may prefix
        values with `LOCAL:` or `INTERNATIONAL:` when they differ by traffic type.
      properties:
        required:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether senders must be registered before sending, for local and international traffic.
        durationDays:
          type: string
          nullable: true
          description: 'Typical registration lead time as published for the country, for example `LOCAL: +20`. Free text;
            `null` when not published.'
        informationRequired:
          type: string
          nullable: true
          description: Information you must supply to register a sender, for example sample messages. `null` when not published.
        documentsRequired:
          type: string
          nullable: true
          description: Documents you must supply to register a sender, for example a letter of authorization. `null` when
            not published.
        alphanumericExtraSteps:
          type: string
          nullable: true
          description: Additional steps that apply to alphanumeric sender IDs, such as DLT registration in India. `null` when
            none.
    CoverageUrls:
      type: object
      description: Rules for links in message bodies sent to a destination country.
      properties:
        allowed:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether message bodies may contain URLs, for local and international traffic.
        whitelistingRequired:
          allOf:
          - $ref: '#/components/schemas/LocalIntl'
          description: Whether the domains you link to must be registered (whitelisted) in advance, for local and international
            traffic.
    CoverageSendWindow:
      type: object
      nullable: true
      description: 'The hours during which messages may be sent to the country. Each value is a text range with its timezone
        rule, for example `MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN`, which means the recipient''s local time.'
      properties:
        weekday:
          type: string
          example: 'MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN'
          description: Permitted sending hours Monday to Friday, with the timezone rule.
        saturday:
          type: string
          example: 'SAT: 10:00:00 - 21:00:00; Timezone from MSISDN'
          description: Permitted sending hours on Saturday, with the timezone rule.
        sunday:
          type: string
          example: 'SUN: 10:00:00 - 21:00:00; Timezone from MSISDN'
          description: Permitted sending hours on Sunday, with the timezone rule.
    CoverageDetail:
      type: object
      description: The full coverage record for one destination country, returned by `GET /api/v1/sms/coverage/{country}`.
      properties:
        country:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country.
        name:
          type: string
          example: United States
          description: English name of the country or territory, for example `United States`.
        region:
          type: string
          nullable: true
          example: Northern America
          description: Geographic region the country belongs to, for example `Northern America`. Use this value with the `region`
            filter on `GET /api/v1/sms/coverage`. `null` when not assigned.
        dialCode:
          type: string
          example: '1'
          description: Country calling code without the `+`, for example `1` or `44`.
        mcc:
          type: string
          nullable: true
          description: Mobile country code (MCC) of the country's networks, for example `311`. `null` when not published.
          example: '311'
        numberPortability:
          type: boolean
          nullable: true
          description: '`true` when subscribers can keep their number when they change network, `null` when unknown.'
        localVsInternationalTraffic:
          type: boolean
          nullable: true
          description: '`true` when the country applies different rules to local (in-country) and international senders. When
            `true`, read the `local` and `international` values of each rule separately.'
        senders:
          allOf:
          - $ref: '#/components/schemas/CoverageSenders'
          description: Which sender types the country accepts, for local and international traffic.
        registration:
          allOf:
          - $ref: '#/components/schemas/CoverageRegistration'
          description: Whether senders must be registered, and what registration involves.
        urls:
          allOf:
          - $ref: '#/components/schemas/CoverageUrls'
          description: Rules for links in message bodies.
        optOutMandatory:
          type: boolean
          nullable: true
          description: '`true` when messages must offer an opt-out, such as replying STOP. `null` when unknown.'
        twoWay:
          type: boolean
          nullable: true
          description: '`true` when recipients can reply to your messages, `false` when they cannot, `null` when unknown.'
        prohibitedTopics:
          type: array
          items:
            type: string
          example:
          - Phishing
          - Other Scams
          - Explicit Content
          - Gambling
          description: Content categories that may not be sent to the country, for example `Gambling` or `Phishing`. Empty
            array when none are listed.
        prohibitedNotes:
          type: string
          nullable: true
          description: Free-text detail on prohibited or restricted content. `null` when none.
        sendWindow:
          allOf:
          - $ref: '#/components/schemas/CoverageSendWindow'
          description: Hours during which you may send, by day type. `null` when the country has no sending window.
        marketNotes:
          type: string
          nullable: true
          description: Free-text guidance on sending to this market, such as sender behaviour and local rules. `null` when
            none.
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-09T09:49:01Z'
          description: When the coverage dataset was last refreshed (ISO 8601).
    Conversation:
      type: object
      description: A two-way thread between one of your numbers (or RCS senders) and one contact on one channel. Vobiz creates
        it with the first message in either direction and adds every later message between the same pair on that channel.
      properties:
        id:
          type: string
          format: uuid
          example: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
          description: Unique identifier of the conversation (UUID). Pass it to the conversation endpoints; messages carry
            it as `conversationId`.
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (Auth ID), for example `MA_XXXXXXXX`.
        participantA:
          type: string
          description: 'Your side of the thread: your number in E.164 format, or the `senderName` of your RCS sender.'
          example: '+14155550100'
        participantB:
          type: string
          description: The contact's phone number in E.164 format.
          example: '+14155550123'
        channel:
          type: string
          enum:
          - sms
          - mms
          - rcs
          description: 'Channel the thread runs on: `sms`, `mms` or `rcs`. The same two parties have a separate conversation
            on each channel.'
        lastMessageAt:
          type: string
          format: date-time
          example: '2026-10-16T21:23:51Z'
          description: Time of the latest message in the thread, sent or received (ISO 8601, UTC). Conversation lists are
            ordered by it, newest first.
        messageCount:
          type: integer
          example: 3
          description: Total number of messages in the thread, in both directions.
        unreadCount:
          type: integer
          description: Number of messages added to the thread since it was last marked read. `POST /Conversation/{id}/Read/`
            resets it to `0`.
          example: 1
        lastReadAt:
          type: string
          format: date-time
          description: When the thread was last marked read (ISO 8601, UTC). Omitted until you first call `POST /Conversation/{id}/Read/`.
          example: '2026-10-17T08:46:55Z'
        createdAt:
          type: string
          format: date-time
          example: '2026-10-16T21:23:02Z'
          description: When the conversation was created, as an RFC 3339 / ISO 8601 timestamp in UTC.
    UnreadCount:
      type: object
      properties:
        totalUnread:
          type: integer
          description: Sum of `unreadCount` over all your conversations. `0` when every thread has been marked read.
          example: 4
      description: The unread total across all your conversations.
    CreateOptOutRequest:
      type: object
      required:
      - phoneNumber
      properties:
        phoneNumber:
          type: string
          description: Required. The phone number to block, in E.164 format, for example `+14155550123`.
          example: '+14155550123'
        channel:
          type: string
          default: sms
          description: 'Channel to block: `sms`, `mms` or `rcs`. Defaults to `sms`. An `sms` opt-out also blocks `mms`.'
          example: sms
        reason:
          type: string
          default: manual
          description: Free-text note stored on the record, for example `customer request`. Defaults to `manual`. Repeating
            the request for the same number and channel replaces it.
          example: manual
      description: The number and channel to add to your opt-out list, with an optional reason.
    OptOut:
      type: object
      description: A phone number on your opt-out list for one channel. Vobiz blocks sends and broadcast deliveries to it
        on that channel until you delete the entry.
      properties:
        id:
          type: string
          format: uuid
          example: 4e8b2d61-7c3a-4f9e-a1d5-9b6c0e2f8a37
          description: Unique identifier of the opt-out record (UUID).
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (Auth ID), for example `MA_XXXXXXXX`.
        phoneNumber:
          type: string
          example: '+14155550123'
          description: The blocked phone number in E.164 format.
        channel:
          type: string
          example: sms
          description: 'Channel the number is blocked on: `sms`, `mms` or `rcs`. An `sms` entry also blocks `mms`.'
        reason:
          type: string
          description: Why the entry exists. `stop`, `start` or `help` when the contact replied with a keyword; `manual` or
            your own text when you created it through the API or console.
          example: manual
        source:
          type: string
          enum:
          - inbound
          - manual
          description: '`inbound` when the entry came from a keyword reply, `manual` when you created it through the API or
            console.'
        syncedToProvider:
          type: boolean
          description: '`true` when the block has also been applied on the carrier network.'
        createdAt:
          type: string
          format: date-time
          example: '2026-10-18T07:23:03Z'
          description: When the number was added to the list (ISO 8601, UTC).
    OptOutCheck:
      type: object
      properties:
        optedOut:
          type: boolean
          description: '`true` when the number is blocked on the requested channel, so sends to it return `422`. `false` when
            you can message it.'
          example: true
      description: Whether a phone number is on your opt-out list for the channel you asked about.
    WebhookEvent:
      type: string
      description: 'A messaging event name you can subscribe to: `message.status` (delivery state changed), `message.delivered`
        (reached the handset), `message.failed` (could not be delivered), `message.received` (inbound message) or `broadcast.updated`
        (broadcast status or counters changed).'
      enum:
      - message.status
      - message.delivered
      - message.failed
      - message.received
      - broadcast.updated
    CreateWebhookRequest:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          description: The HTTPS URL that receives `POST` deliveries, for example `https://example.com/vobiz/webhooks`. Required;
            an empty or missing value returns `400` with `url is required`.
          example: https://example.com/vobiz/webhooks
        secret:
          type: string
          description: Shared secret used to compute `X-Webhook-Signature` on every delivery. Choose a long random value and
            store it on your server; if you omit it the subscription is created with an empty secret.
          example: YOUR_WEBHOOK_SECRET
        events:
          type: array
          description: Event names to deliver to this URL, matched exactly. Defaults to `message.received`, `message.delivered`
            and `message.failed` when you omit it or send an empty array.
          default:
          - message.received
          - message.delivered
          - message.failed
          items:
            $ref: '#/components/schemas/WebhookEvent'
      description: The subscription to create. Only `url` is required.
    UpdateWebhookRequest:
      type: object
      description: The fields to change. Send any subset; fields you omit keep their current value.
      properties:
        url:
          type: string
          format: uri
          example: https://example.com/vobiz/webhooks-v2
          description: New HTTPS URL for deliveries. Replaces the current URL as sent, so always send a full valid URL.
        secret:
          type: string
          example: YOUR_NEW_WEBHOOK_SECRET
          description: New signing secret for `X-Webhook-Signature`. Deliveries are signed with the new value from this point,
            so update your verifier at the same time.
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          example:
          - message.delivered
          - message.failed
          description: New list of event names to deliver, matched exactly. Replaces the whole list; it is not merged with
            the current events.
        active:
          type: boolean
          description: '`false` pauses deliveries and keeps the subscription; `true` resumes them.'
    WebhookSubscription:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 8d4f2a6b-3e1c-4b9a-a7d2-5c8e1f0b6a93
          description: Unique identifier of the subscription (UUID). Use it with `GET`, `PUT` and `DELETE /Webhook/{id}/`.
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Auth ID of the account that owns the subscription, for example `MA_XXXXXXXX`.
        url:
          type: string
          format: uri
          example: https://example.com/vobiz/webhooks
          description: The URL that receives `POST` deliveries.
        secret:
          type: string
          description: The signing secret for `X-Webhook-Signature`, returned in clear. Keep it out of logs and client-side
            code.
          example: YOUR_WEBHOOK_SECRET
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          example:
          - message.received
          - message.delivered
          - message.failed
          description: Event names delivered to this URL. An event is delivered only when its name appears here exactly.
        active:
          type: boolean
          example: true
          description: '`true` when deliveries are on. New subscriptions start `true`; set it with `PUT /Webhook/{id}/`.'
        createdAt:
          type: string
          format: date-time
          example: '2026-10-18T07:22:11Z'
          description: When the subscription was created (ISO 8601). Read it from `GET /Webhook/{id}/` or `GET /Webhook/`.
      description: 'A webhook subscription: the URL Vobiz delivers your chosen events to, and the secret used to sign them.'
    BroadcastStats:
      type: object
      description: Counts of the broadcast's stored recipients by state, recounted every time you read the broadcast.
      properties:
        total:
          type: integer
          description: Recipients stored on the broadcast, including opted-out ones. Invalid rows and duplicates from the
            upload are not stored and not counted.
          example: 3
        pending:
          type: integer
          description: Recipients still waiting to be sent.
          example: 0
        sent:
          type: integer
          example: 3
          description: Recipients whose message was accepted for sending and has no delivery report yet.
        delivered:
          type: integer
          example: 0
          description: Recipients whose message was reported delivered.
        failed:
          type: integer
          example: 0
          description: Recipients whose message failed. Their `errorCode` says why.
        optedOut:
          type: integer
          description: Recipients excluded because the number opted out of SMS from you. They are not sent.
          example: 0
        skipped:
          type: integer
          description: Recipients that were still pending when the broadcast was cancelled.
          example: 0
    Broadcast:
      type: object
      description: A bulk SMS send that renders one template for every recipient of an uploaded list and sends at a controlled
        rate. Its `status` moves from `draft` through `scheduled` or `running` to `completed`, `cancelled` or `failed`, and
        `stats` counts recipients by state.
      properties:
        id:
          type: string
          format: uuid
          example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
          description: Unique identifier of the broadcast (UUID). Use it in every `/Broadcast/{id}/` path.
        accountId:
          type: string
          description: Your Vobiz account ID (`MA_...`) that owns the broadcast.
          example: MA_XXXXXXXX
        name:
          type: string
          example: October pricing update
          description: The label you gave the broadcast, shown in the console and in listings.
        from:
          type: string
          description: 'The sender every message goes out from, as stored: an E.164 number, a short code or an alphanumeric
            sender ID.'
          example: '+14155550100'
        channel:
          type: string
          enum:
          - sms
          example: sms
          description: The channel the broadcast sends on. Always `sms`.
        template:
          type: string
          description: The message body with `{{variable}}` placeholders, filled per recipient from the columns of the upload.
            Empty until you set it.
          example: Hi {{name}}, your refund of {{amount}} is on its way.
        status:
          type: string
          enum:
          - draft
          - scheduled
          - running
          - paused
          - completed
          - cancelled
          - failed
          description: Lifecycle state. `draft` until you launch, then `scheduled` (waiting for `scheduledAt`) or `running`.
            `paused` after a pause call or when `pauseReason` is set; `completed` once every recipient is processed; `cancelled`
            after a cancel call; `failed` when the run stopped on an error.
          example: draft
        pauseReason:
          type: string
          enum:
          - insufficient_balance
          description: Present only while the broadcast is paused for a reason other than your own pause call. `insufficient_balance`
            means the balance ran out; top up and call `POST /Broadcast/{id}/Resume/`.
        scheduledAt:
          type: string
          format: date-time
          nullable: true
          description: When sending starts after launch, in UTC (ISO 8601). `null` means sending starts as soon as you launch.
          example: null
        ratePerSecond:
          type: integer
          description: Maximum messages sent per second while running, from 1 to 50.
          example: 5
        tag:
          type: string
          description: Your label, copied onto every message the broadcast sends. Empty string when not set.
          example: ''
        dltEntityId:
          type: string
          description: India (TRAI DLT). The Principal Entity ID copied onto every message. Empty string when not set.
          example: ''
        dltHeaderId:
          type: string
          description: India (TRAI DLT). The registered sender header ID copied onto every message. Empty string when not
            set.
          example: ''
        dltTemplateId:
          type: string
          description: India (TRAI DLT). The registered content template ID copied onto every message. Empty string when not
            set.
          example: ''
        columns:
          type: array
          nullable: true
          description: Column names from the latest recipient upload, as written in your file header. The first is the phone
            column and the rest are available as template variables. Empty until you upload recipients.
          items:
            type: string
          example: []
        stats:
          allOf:
          - $ref: '#/components/schemas/BroadcastStats'
          description: Recipient counts by state, recounted on every read.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the broadcast was created (ISO 8601, UTC).
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the broadcast last changed, including status changes (ISO 8601, UTC).
        startedAt:
          type: string
          format: date-time
          nullable: true
          description: When sending began (ISO 8601, UTC). `null` until the broadcast runs.
          example: null
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: When the broadcast finished, either because the last recipient was processed or because it was cancelled
            (ISO 8601, UTC). `null` until then.
          example: null
    BroadcastUpdateInput:
      type: object
      description: Broadcast fields you can change on a draft. Every field is optional; fields you leave out keep their value,
        and the same validation as create applies.
      properties:
        name:
          type: string
          maxLength: 255
          description: A label for the broadcast in the console and in listings, 1 to 255 characters. Required on create;
            on update it cannot be set to an empty string.
          example: October pricing update
        from:
          type: string
          description: 'The sender every message goes out from: an SMS number on your account in E.164 format, a short code
            of up to 8 digits, or an alphanumeric sender ID of 1 to 11 letters, digits and spaces that starts with a letter
            or digit. Spaces, hyphens and brackets in phone numbers are removed before storing. Launch checks that a phone-number
            sender is an SMS number on your account. Required on create.'
          example: '+14155550100'
        channel:
          type: string
          enum:
          - sms
          default: sms
          description: The channel the broadcast sends on. Broadcasts send SMS, so the only value is `sms` (matched case-insensitively),
            which is also the default.
        template:
          type: string
          maxLength: 5000
          description: Message body, up to 5,000 characters, with `{{variable}}` placeholders filled per recipient from the
            columns of your upload. Placeholder names are matched case-insensitively and trimmed, so `{{ Name }}` matches
            a `name` column. Launch requires a non-empty template.
          example: Hi {{name}}, your refund of {{amount}} is on its way.
        scheduledAt:
          type: string
          format: date-time
          nullable: true
          description: RFC 3339 timestamp at which sending starts after you launch, for example `2026-11-01T09:00:00Z`; offsets
            are converted to UTC. Omit it, or pass `null` or `""`, to send as soon as you launch. On update, `null` clears
            a previous value.
          example: '2026-10-15T09:00:00Z'
        ratePerSecond:
          type: integer
          minimum: 1
          maximum: 50
          default: 5
          description: Maximum messages sent per second while the broadcast runs, an integer from 1 to 50. Defaults to 5,
            and `0` also selects the default. Lower it to spread load on your own systems or replies.
          example: 5
        tag:
          type: string
          maxLength: 255
          description: Your own label of up to 255 characters, copied onto every message the broadcast sends so you can find
            them with the `tag` filter on `GET /Message/`.
          example: pricing-oct
        dltEntityId:
          type: string
          maxLength: 64
          description: India (TRAI DLT). The Principal Entity ID you registered on a TRAI DLT portal, up to 64 characters.
            Pass it when the list contains Indian numbers; it is copied onto every message.
        dltHeaderId:
          type: string
          maxLength: 64
          description: India (TRAI DLT). The sender header ID you registered on a TRAI DLT portal, up to 64 characters. Copied
            onto every message.
        dltTemplateId:
          type: string
          maxLength: 64
          description: India (TRAI DLT). The content template ID you registered on a TRAI DLT portal, up to 64 characters.
            Your template text must match the registered template with the variables filled.
    BroadcastInput:
      allOf:
      - $ref: '#/components/schemas/BroadcastUpdateInput'
      - type: object
        required:
        - name
        - from
      description: Fields for a new broadcast. `name` and `from` are required; every other field is optional and takes its
        documented default.
    BroadcastList:
      type: object
      properties:
        broadcasts:
          type: array
          items:
            $ref: '#/components/schemas/Broadcast'
          description: The broadcasts on this page, newest first. Empty when `offset` is past the end.
        total:
          type: integer
          description: Number of broadcasts on your account across all pages. Page until `offset` reaches this value.
          example: 1
      description: One page of broadcasts, newest first, with the total count for paging.
    BroadcastRecipient:
      type: object
      description: 'One recipient of a broadcast: the normalised number, the variables from its upload row and the state of
        its message.'
      properties:
        id:
          type: integer
          format: int64
          example: 1042
          description: Numeric identifier of the recipient within Vobiz. Used in the broadcast's per-recipient idempotency
            key.
        row:
          type: integer
          description: Where the recipient came from in the upload. For a file it is the line number in the file, so with
            a header line the first data row is `2`; for a JSON `numbers` array it is the 1-based position.
          example: 2
        to:
          type: string
          description: The recipient's number, normalised to E.164.
          example: '+14155550123'
        variables:
          type: object
          description: Every column value from the recipient's upload row, keyed by the column name as written in your header,
            including the phone column. Used to fill the template. Only the phone column is present for JSON uploads.
          additionalProperties:
            type: string
          example:
            name: Priya
            amount: $42.00
        status:
          type: string
          enum:
          - pending
          - sending
          - sent
          - delivered
          - failed
          - opted_out
          - skipped
          example: sent
          description: 'The recipient''s send state: `pending`, `sending`, `sent`, `delivered`, `failed`, `opted_out` (excluded
            because the number opted out of SMS from you) or `skipped` (still pending when the broadcast was cancelled).'
        messageId:
          type: string
          description: The `id` of the message sent to this recipient; look it up with `GET /Message/{id}/`. Empty string
            until the message is sent.
          example: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
        errorCode:
          type: string
          description: 'Why the send failed: the message''s `errorCode`, or `send_failed` / `routing_failed`. Empty string
            unless `status` is `failed`.'
          example: ''
        errorMessage:
          type: string
          example: ''
          description: Human-readable detail for a failed send. Empty string unless `status` is `failed`.
        sentAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-12T10:30:02Z'
          description: When the message to this recipient was sent (ISO 8601, UTC). `null` until then.
    BroadcastRecipientList:
      type: object
      properties:
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/BroadcastRecipient'
          description: The recipients on this page, in upload order.
        total:
          type: integer
          description: Number of recipients that match the `status` filter across all pages, or all recipients when you pass
            no filter.
          example: 3
      description: One page of a broadcast's recipients, in upload order, with the count that matches your filter.
    UploadRecipientsFile:
      type: object
      required:
      - file
      properties:
        file:
          type: string
          format: binary
          description: A `.csv` or `.xlsx` file of at most 10 MB and 10,000 recipients. The phone column is detected from
            its header (`phone`, `mobile`, `msisdn`, `number`, `to`, `phonenumber` and similar), otherwise the first column
            is used. Files without a header get the columns `phone`, `column2`, `column3` and so on; CSV delimiters `,`, `;`
            and tab are detected, and for XLSX the first sheet is read.
        defaultCountry:
          type: string
          default: US
          description: ISO 3166-1 alpha-2 country code, matched case-insensitively, used to normalise numbers that have no
            country code. Defaults to `US`.
          enum:
          - US
          - CA
          - GB
          - IN
          - AU
          - NZ
          - IE
          - DE
          - FR
          - ES
          - IT
          - NL
          - BE
          - CH
          - AT
          - SE
          - 'NO'
          - DK
          - FI
          - PL
          - PT
          - BR
          - MX
          - AR
          - CO
          - CL
          - SG
          - MY
          - ID
          - PH
          - TH
          - VN
          - JP
          - KR
          - CN
          - HK
          - AE
          - SA
          - QA
          - IL
          - TR
          - ZA
          - NG
          - KE
          - EG
          - PK
          - BD
          - LK
          - NP
          example: US
      description: A recipient file upload. Every column other than the phone column becomes a template variable named after
        its header.
    UploadRecipientsJSON:
      type: object
      required:
      - numbers
      properties:
        numbers:
          type: array
          description: Phone numbers, one per recipient, up to 10,000. Numbers without a country code are normalised with
            `defaultCountry`. An empty array clears the list.
          items:
            type: string
          example:
          - '+14155550123'
          - '+14155550124'
        defaultCountry:
          type: string
          default: US
          description: ISO 3166-1 alpha-2 country code, matched case-insensitively, used to normalise numbers that have no
            country code. Defaults to `US`.
          enum:
          - US
          - CA
          - GB
          - IN
          - AU
          - NZ
          - IE
          - DE
          - FR
          - ES
          - IT
          - NL
          - BE
          - CH
          - AT
          - SE
          - 'NO'
          - DK
          - FI
          - PL
          - PT
          - BR
          - MX
          - AR
          - CO
          - CL
          - SG
          - MY
          - ID
          - PH
          - TH
          - VN
          - JP
          - KR
          - CN
          - HK
          - AE
          - SA
          - QA
          - IL
          - TR
          - ZA
          - NG
          - KE
          - EG
          - PK
          - BD
          - LK
          - NP
          example: US
      description: A plain recipient list sent as JSON. Use the file form instead when the template needs per-recipient variables.
    InvalidRecipient:
      type: object
      description: A row that was rejected during a recipient upload and not stored.
      properties:
        row:
          type: integer
          description: 'Where the row came from: the line number in the file (the header is line 1), or the 1-based position
            in a JSON `numbers` array.'
          example: 7
        value:
          type: string
          description: The phone value exactly as it appeared in the row. Empty when the phone cell was blank.
          example: abc
        reason:
          type: string
          enum:
          - missing phone number
          - contains letters or symbols
          - too short
          - too long
          - not a valid US/Canada number
          - not a valid Indian mobile number
          - unsupported defaultCountry
          example: contains letters or symbols
          description: 'Why the number was rejected: `missing phone number` (blank cell), `contains letters or symbols`, `too
            short`, `too long`, `not a valid US/Canada number`, `not a valid Indian mobile number` or `unsupported defaultCountry`.'
    UploadResult:
      type: object
      description: Summary of a recipient upload. The upload replaces the broadcast's previous recipient list.
      properties:
        total:
          type: integer
          description: Rows read from the file or array, excluding the header line.
          example: 5
        valid:
          type: integer
          description: Rows with a valid, unique number that were stored as recipients, including opted-out numbers.
          example: 3
        invalid:
          type: array
          description: Rejected rows with the reason for each, at most the first 100. Fix them in your file and upload again.
          items:
            $ref: '#/components/schemas/InvalidRecipient'
        invalidCount:
          type: integer
          description: Total rejected rows, including any beyond the 100 listed in `invalid`.
          example: 1
        duplicates:
          type: integer
          description: Rows dropped because the same number appeared earlier in the upload.
          example: 1
        optedOut:
          type: integer
          description: Stored rows marked `opted_out` because the number opted out of SMS from you. They count towards `valid`
            and are not sent.
          example: 0
        columns:
          type: array
          description: Column names detected in the upload, as written in your header. The first is the phone column; the
            rest are template variables.
          items:
            type: string
          example:
          - phone
          - name
          - amount
    BroadcastPreviewSample:
      type: object
      properties:
        to:
          type: string
          example: '+14155550123'
          description: The recipient's number in E.164 format.
        text:
          type: string
          description: The exact message text this recipient will receive, with their variables filled.
          example: Hi Priya, your refund of $42.00 is on its way.
        segments:
          type: integer
          description: Number of SMS segments this text is sent and billed as.
          example: 1
        encoding:
          type: string
          enum:
          - GSM-7
          - UCS-2
          description: '`GSM-7` when every character is in the GSM alphabet (160 characters in a single segment). `UCS-2`
            when the text contains other characters, such as emoji or most non-Latin scripts (70 characters in a single segment).'
          example: GSM-7
      description: The template rendered for one recipient, with the encoding and segment count it will be sent with.
    BroadcastPreview:
      type: object
      properties:
        samples:
          type: array
          description: The template rendered for up to `limit` pending recipients, in upload order. Empty when no recipient
            is pending.
          items:
            $ref: '#/components/schemas/BroadcastPreviewSample'
        missingVariables:
          type: array
          description: Placeholders in the template that have no matching upload column. They render as empty text; an empty
            array means every placeholder is filled.
          items:
            type: string
          example: []
        estimatedSegments:
          type: integer
          description: Total SMS segments across all pending recipients. Multiply by your per-segment rate to estimate the
            cost of the launch.
          example: 3
      description: The template rendered for the first pending recipients, with the information you need to check a broadcast
        before launching it.
    SenderBrand:
      type: object
      properties:
        brandName:
          type: string
          example: Example Brand
          description: Your brand or business name as the RCS platform should record it for review.
      description: The brand an RCS sender represents.
    SenderPhone:
      type: object
      properties:
        phoneNumber:
          type: string
          description: The phone number recipients can call, in E.164 format.
          example: '+14155550100'
        label:
          type: string
          example: Support
          description: Text shown next to the number, for example `Customer care`.
      description: A contact phone number shown on an RCS sender's info page.
    SenderEmail:
      type: object
      properties:
        address:
          type: string
          format: email
          example: support@example.com
          description: The email address recipients can write to, for example `support@example.com`.
        label:
          type: string
          example: Support
          description: Text shown next to the address, for example `Support`.
      description: A contact email address shown on an RCS sender's info page.
    SenderWebsite:
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://example.com
          description: Public HTTPS URL of the website, for example `https://example.com`.
        label:
          type: string
          example: Website
          description: Text shown for the link, for example `Website`.
      description: A website shown on an RCS sender's info page.
    SenderLink:
      type: object
      description: A labelled link shown on an RCS sender's info page, used for the privacy policy and terms of service.
      properties:
        url:
          type: string
          format: uri
          example: https://example.com/privacy
          description: Public HTTPS URL of the page, for example `https://example.com/privacy`.
        label:
          type: string
          example: Privacy policy
          description: Text shown for the link, for example `Privacy policy`.
    SenderPlatform:
      type: object
      description: Identifiers the RCS platform has assigned to your agent. Set them only when you already have them.
      properties:
        applicationId:
          type: string
          example: YOUR_APPLICATION_ID
          description: The application ID of your agent on the RCS platform.
        entityId:
          type: string
          example: YOUR_ENTITY_ID
          description: The entity ID of your agent on the RCS platform.
    Sender:
      type: object
      description: 'An RCS sender (agent): the verified brand identity that recipients see instead of a phone number. Send
        RCS from it by passing its `senderName` as `from` with `channel: rcs`.'
      properties:
        id:
          type: string
          format: uuid
          example: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
          description: Unique identifier of the sender on Vobiz (UUID). Use it in every `/Sender/{id}/` path.
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (`MA_...`) that owns the sender.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
          example: YOUR_ROUTING_IDENTIFIER
        senderName:
          type: string
          description: Unique technical name of the sender on the RCS platform. Pass it as `from` when you send RCS. Fixed
            after creation.
          example: example-brand
        displayName:
          type: string
          description: The brand name recipients see at the top of the conversation.
          example: Example Brand
        description:
          type: string
          example: Order updates and support for Example Brand customers.
          description: Short description shown on the sender's info page.
        billingCategory:
          type: string
          description: How the RCS platform bills conversations from this sender, for example `CONVERSATIONAL` or `NON_CONVERSATIONAL`.
          example: CONVERSATIONAL
        useCase:
          type: string
          description: The kind of traffic the sender carries, for example `OTP`, `TRANSACTIONAL`, `PROMOTIONAL` or `MULTI_USE`.
          example: TRANSACTIONAL
        hostingRegion:
          type: string
          description: The region where the RCS platform hosts the sender, for example `NORTH_AMERICA`, `EUROPE` or `ASIA_PACIFIC`.
            Fixed after creation.
          example: NORTH_AMERICA
        status:
          type: string
          description: Launch status reported by the RCS platform when the sender was created or last refreshed, stored on
            your account. It is an empty string when the platform has not reported a status. Call `GET /Sender/{id}/Status/`
            to refresh it.
          example: ''
        brand:
          allOf:
          - $ref: '#/components/schemas/SenderBrand'
          description: The brand the sender represents. Omitted when not set.
        color:
          type: string
          description: Accent colour as a hex code. Omitted when not set.
          example: '#1A73E8'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/SenderPhone'
          description: Contact phone numbers shown on the sender's info page. Omitted when none are set.
        emails:
          type: array
          items:
            $ref: '#/components/schemas/SenderEmail'
          description: Contact email addresses shown on the sender's info page. Omitted when none are set.
        websites:
          type: array
          items:
            $ref: '#/components/schemas/SenderWebsite'
          description: Websites shown on the sender's info page. Omitted when none are set.
        bannerUrl:
          type: string
          format: uri
          example: https://example.com/rcs/banner.jpg
          description: HTTPS URL of the banner image. Omitted when not set.
        logoUrl:
          type: string
          format: uri
          example: https://example.com/rcs/logo.png
          description: HTTPS URL of the logo image. Omitted when not set.
        privacy:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your privacy policy.
        termsOfService:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your terms of service.
        platform:
          allOf:
          - $ref: '#/components/schemas/SenderPlatform'
          description: Identifiers the RCS platform assigned to your agent. Omitted when not set.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the sender was created on your account (ISO 8601, UTC).
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the sender last changed, including status refreshes (ISO 8601, UTC).
    CreateSenderRequest:
      type: object
      required:
      - provider
      - senderName
      properties:
        provider:
          type: string
          description: The routing identifier your account was provisioned with for RCS. Contact support if you are unsure
            which value to use; an unknown value returns `400`.
          example: YOUR_ROUTING_IDENTIFIER
        senderName:
          type: string
          description: Unique technical name of the sender on the RCS platform. You pass it as `from` when you send RCS, and
            it cannot be changed later.
          example: example-brand
        displayName:
          type: string
          description: The brand name recipients see at the top of the conversation.
          example: Example Brand
        description:
          type: string
          description: Short description of your business or the sender's purpose, shown on the sender's info page.
          example: Order updates and support for Example Brand customers.
        billingCategory:
          type: string
          description: How the RCS platform bills conversations from this sender. Values accepted by the platform include
            `CONVERSATIONAL` and `NON_CONVERSATIONAL`.
          example: CONVERSATIONAL
        useCase:
          type: string
          description: The kind of traffic the sender carries, reviewed by the RCS platform. Values accepted by the platform
            include `OTP`, `TRANSACTIONAL`, `PROMOTIONAL` and `MULTI_USE`.
          example: TRANSACTIONAL
        hostingRegion:
          type: string
          description: The region where the RCS platform hosts the sender. Values accepted by the platform include `NORTH_AMERICA`,
            `EUROPE` and `ASIA_PACIFIC`. Cannot be changed later.
          example: NORTH_AMERICA
        brand:
          allOf:
          - $ref: '#/components/schemas/SenderBrand'
          description: The brand the sender represents.
        color:
          type: string
          description: Accent colour for the sender's buttons and header, as a hex code such as `#1A73E8`.
          example: '#1A73E8'
        phones:
          type: array
          description: Contact phone numbers shown on the sender's info page, each with a label.
          items:
            $ref: '#/components/schemas/SenderPhone'
        emails:
          type: array
          description: Contact email addresses shown on the sender's info page, each with a label.
          items:
            $ref: '#/components/schemas/SenderEmail'
        websites:
          type: array
          description: Websites shown on the sender's info page, each with a label.
          items:
            $ref: '#/components/schemas/SenderWebsite'
        bannerUrl:
          type: string
          format: uri
          description: Publicly reachable HTTPS URL of the banner image shown at the top of the sender's info page.
          example: https://example.com/rcs/banner.jpg
        logoUrl:
          type: string
          format: uri
          description: Publicly reachable HTTPS URL of the logo shown next to every message.
          example: https://example.com/rcs/logo.png
        privacy:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your privacy policy, shown on the sender's info page.
        termsOfService:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your terms of service, shown on the sender's info page.
        platform:
          allOf:
          - $ref: '#/components/schemas/SenderPlatform'
          description: Identifiers the RCS platform has already assigned to your agent, if you have any.
      description: The identity and profile of a new RCS sender. `provider` and `senderName` are required; the profile fields
        are what recipients see and what the RCS platform reviews.
    UpdateSenderRequest:
      type: object
      description: Any subset of the editable RCS sender fields. Fields you leave out keep their value; `provider`, `senderName`
        and `hostingRegion` are fixed after creation.
      properties:
        displayName:
          type: string
          example: Example Brand
          description: The brand name recipients see at the top of the conversation.
        description:
          type: string
          example: Order updates and support for Example Brand customers.
          description: Short description of your business or the sender's purpose, shown on the sender's info page.
        billingCategory:
          type: string
          description: How the RCS platform bills conversations from this sender, for example `CONVERSATIONAL` or `NON_CONVERSATIONAL`.
          example: CONVERSATIONAL
        useCase:
          type: string
          description: The kind of traffic the sender carries, for example `OTP`, `TRANSACTIONAL`, `PROMOTIONAL` or `MULTI_USE`.
          example: TRANSACTIONAL
        brand:
          allOf:
          - $ref: '#/components/schemas/SenderBrand'
          description: The brand the sender represents.
        color:
          type: string
          example: '#1A73E8'
          description: Accent colour for the sender's buttons and header, as a hex code such as `#1A73E8`.
        phones:
          type: array
          items:
            $ref: '#/components/schemas/SenderPhone'
          description: Contact phone numbers shown on the sender's info page.
        emails:
          type: array
          items:
            $ref: '#/components/schemas/SenderEmail'
          description: Contact email addresses shown on the sender's info page.
        websites:
          type: array
          items:
            $ref: '#/components/schemas/SenderWebsite'
          description: Websites shown on the sender's info page.
        bannerUrl:
          type: string
          format: uri
          example: https://example.com/rcs/banner.jpg
          description: Publicly reachable HTTPS URL of the banner image.
        logoUrl:
          type: string
          format: uri
          example: https://example.com/rcs/logo.png
          description: Publicly reachable HTTPS URL of the logo image.
        privacy:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your privacy policy.
        termsOfService:
          allOf:
          - $ref: '#/components/schemas/SenderLink'
          description: Link to your terms of service.
        platform:
          allOf:
          - $ref: '#/components/schemas/SenderPlatform'
          description: Identifiers the RCS platform has assigned to your agent.
    Template:
      type: object
      description: A message template registered on an RCS sender, with the approval status reported by the RCS platform.
      properties:
        id:
          type: string
          format: uuid
          example: c2e4a6b8-1d3f-4a5c-9e7b-6f8d0a2c4e61
          description: Unique identifier of the template on Vobiz (UUID). Template endpoints address templates by `templateName`
            instead.
        senderId:
          type: string
          format: uuid
          description: The `id` of the RCS sender the template belongs to.
          example: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (`MA_...`) that owns the template.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
          example: YOUR_ROUTING_IDENTIFIER
        templateName:
          type: string
          description: Unique name of the template on its sender. Used in the path of every template endpoint.
          example: order-shipped
        type:
          type: string
          description: Template type as defined by the RCS platform.
        status:
          type: string
          description: Approval status reported by the RCS platform when the template was created or last refreshed, stored
            on your account. It is an empty string when the platform has not reported a status. Call `GET /Sender/{senderId}/Template/{templateName}/Status/`
            to refresh it.
        content:
          type: object
          description: The template content exactly as you submitted it.
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the template was created on your account (ISO 8601, UTC).
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the template last changed, including status refreshes (ISO 8601, UTC).
    CreateTemplateRequest:
      type: object
      required:
      - templateName
      - type
      - content
      properties:
        templateName:
          type: string
          description: Unique name for the template on this sender. You use it in the path of every template endpoint.
          example: order-shipped
        type:
          type: string
          description: Template type as defined by the RCS platform. It decides which `content` shape the platform expects.
        content:
          type: object
          description: Template content as a JSON object in the shape the RCS platform defines for the chosen `type`. Stored
            and returned exactly as you submit it.
          additionalProperties: true
      description: A message template to register on an RCS sender. All three fields are required and are passed to the RCS
        platform unchanged.
    TenDLCError:
      description: Error returned when the US 10DLC registry declines or cannot process a request. `error` is a human-readable
        message you can show or log. When the registry answers with `400`, `404`, `409`, `422` or `429`, the same status is
        returned with this body; `502` means the registry did not answer and `503` means registration is temporarily unavailable.
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          providerError:
            type: string
            description: Opaque diagnostic string you can quote to support. Do not parse it.
            example: 'registration error 400 (HTTP 400): brand legalName is required'
    BrandAddress:
      type: object
      description: Postal address of the business. Keys are passed to the US 10DLC registry as given, so you can add any address
        key the registry accepts.
      additionalProperties: true
      properties:
        street:
          type: string
          example: 100 Example Street
          description: Street address, including number and suite.
        city:
          type: string
          example: San Francisco
          description: City or locality.
        state:
          type: string
          example: CA
          description: State, province or region; for US addresses, the two-letter state code (for example `CA`).
        zipCode:
          type: string
          example: '94105'
          description: ZIP or postal code, as a string (for example `94105`).
    BrandRejectionReason:
      type: object
      description: One rejection recorded by a registrar for the brand.
      properties:
        registrar:
          type: string
          description: Registrar that recorded the rejection.
          example: TCR
        state:
          type: string
          description: The brand's state at that registrar when the rejection was recorded. Omitted when not reported.
          example: REJECTED
        rejectionReason:
          type: string
          example: Tax ID does not match the legal name on file.
          description: The registrar's explanation of what to fix before you register again.
    CreateBrandRequest:
      type: object
      description: The business that will send messages. `name` and `brandType` are required; every other value is passed
        to the US 10DLC registry as given, so use the values the registry accepts (listed per field) and match your official
        records.
      required:
      - name
      - brandType
      properties:
        referenceId:
          type: string
          description: Your own idempotency reference, any string unique per brand on your account. Repeating a create with
            the same value reconciles to the same brand instead of creating a second one. Not used on update.
          example: brand-example-corp-01
        name:
          type: string
          description: Display name of the brand, usually the name customers know you by. Required.
          example: Example Corp
        legalName:
          type: string
          description: Registered legal name of the business, exactly as it appears on tax records.
          example: Example Corporation Inc.
        brandType:
          type: string
          enum:
          - TENDLC_PRIVATE_COMPANY
          - TENDLC_PUBLIC_COMPANY
          - TENDLC_NON_PROFIT
          - TENDLC_GOVERNMENT
          - TOLL_FREE_NUMBER
          description: Kind of business. Required. One of `TENDLC_PRIVATE_COMPANY` (privately held business), `TENDLC_PUBLIC_COMPANY`
            (publicly traded company; also goes through brand authentication), `TENDLC_NON_PROFIT` (registered non-profit),
            `TENDLC_GOVERNMENT` (government body) or `TOLL_FREE_NUMBER` (a business registered for toll-free messaging).
        website:
          type: string
          format: uri
          example: https://example.com
          description: Business website. It must be live, match the business and show your privacy policy.
        supportEmail:
          type: string
          format: email
          example: support@example.com
          description: Support email address for the business, ideally on the website's domain.
        supportPhone:
          type: string
          description: Support phone number for the business, in E.164 format (for example `+14155550100`).
          example: '+14155550100'
        vertical:
          type: string
          description: Industry of the business. Values accepted by the US 10DLC registry include `AGRICULTURE`, `COMMUNICATION`,
            `CONSTRUCTION`, `EDUCATION`, `ENERGY`, `ENTERTAINMENT`, `FINANCIAL`, `GAMBLING`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`,
            `HUMAN_RESOURCES`, `INFORMATION_TECHNOLOGY_SERVICES`, `INSURANCE`, `LEGAL`, `MANUFACTURING`, `NGO`, `POLITICAL`,
            `POSTAL`, `PROFESSIONAL`, `REAL_ESTATE`, `RETAIL`, `TECHNOLOGY`, `TRANSPORTATION`.
          example: TECHNOLOGY
        taxId:
          type: string
          description: Tax identifier of the business, for example the 9-digit US EIN. It must match `legalName` in the issuing
            country's records.
          example: 12-3456789
        taxIdIssuingCountry:
          type: string
          description: ISO 3166-1 alpha-2 code of the country that issued `taxId`, for example `US`.
          example: US
        countryCode:
          type: string
          description: ISO 3166-1 alpha-2 code of the country where the business is registered, for example `US`.
          example: US
        address:
          allOf:
          - $ref: '#/components/schemas/BrandAddress'
          description: Postal address of the business as it appears on its registration records.
        alternateBusinessId:
          type: object
          description: Alternate business identifier (for example a DUNS or LEI record), passed to the registry as given.
            Send it only when the registry asks for one.
          additionalProperties: true
          example:
            type: DUNS
            id: '123456789'
        businessContactFirstName:
          type: string
          example: Alex
          description: First name of the person the registry can contact about the brand.
        businessContactLastName:
          type: string
          example: Doe
          description: Last name of the person the registry can contact about the brand.
        businessContactEmail:
          type: string
          format: email
          description: Email address of the business contact. The registry sends brand-authentication and 2FA requests for
            `TENDLC_PUBLIC_COMPANY` brands here.
          example: alex.doe@example.com
        businessDba:
          type: string
          description: Trading name ("doing business as") when it differs from `legalName`. Note the casing `businessDba`
            on brand requests.
          example: Example
        legalEntityType:
          type: string
          description: 'Legal form of the business. Values accepted by the US 10DLC registry: `PRIVATE_COMPANY`, `PUBLIC_COMPANY`,
            `NON_PROFIT`, `GOVERNMENT`, `SOLE_PROPRIETOR`.'
          example: PRIVATE_COMPANY
        businessRegistrationType:
          type: string
          description: 'Type of registration number for a business outside the US. Values accepted by the US 10DLC registry:
            `VAT`, `CBN`, `PROVINCIAL_NUMBER`, `ABN`, `SIREN`, `NZBN`, `CIF`, `CNPJ`, `OTHER`.'
        taxExemptStatus:
          type: string
          description: Tax-exempt status of a `TENDLC_NON_PROFIT` brand.
          example: 501c3
        stockExchange:
          type: string
          description: Exchange where the company is listed, for example `NASDAQ` or `NYSE`. `TENDLC_PUBLIC_COMPANY` brands
            only.
          example: NASDAQ
        stockSymbol:
          type: string
          description: Ticker symbol on `stockExchange`. `TENDLC_PUBLIC_COMPANY` brands only.
          example: EXMP
    Brand:
      type: object
      description: 'A brand on your account: the business behind your 10DLC traffic and its state at the US 10DLC registry.
        Optional fields are omitted when empty, and registry state is refreshed when you retrieve the brand.'
      properties:
        id:
          type: string
          format: uuid
          description: Brand ID (UUID) on your account. Use it in every `/TenDlc/Brand/{id}/` path and as `brandId` when you
            create a campaign.
          example: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (`MA_...`). Always the account whose credentials made the request.
        name:
          type: string
          example: Example Corp
          description: Display name you gave the brand when you created it.
        legalName:
          type: string
          example: Example Corporation Inc.
          description: Registered legal name of the business. Omitted when not set.
        brandType:
          type: string
          enum:
          - TENDLC_PRIVATE_COMPANY
          - TENDLC_PUBLIC_COMPANY
          - TENDLC_NON_PROFIT
          - TENDLC_GOVERNMENT
          - TOLL_FREE_NUMBER
          description: 'Kind of business behind the brand: `TENDLC_PRIVATE_COMPANY` (privately held business), `TENDLC_PUBLIC_COMPANY`
            (publicly traded company; also goes through brand authentication), `TENDLC_NON_PROFIT` (registered non-profit),
            `TENDLC_GOVERNMENT` (government body) or `TOLL_FREE_NUMBER` (a business registered for toll-free messaging).'
        stage:
          type: string
          enum:
          - DRAFT
          - SUBMITTED
          description: 'Where the brand is in your workflow: `DRAFT` until you call `POST /TenDlc/Brand/{id}/Register/`, then
            `SUBMITTED`.'
        registrationStatus:
          type: string
          enum:
          - ACTIVE
          - PENDING
          - PENDING_2FA
          - PENDING_APPEAL
          - REJECTED
          description: The registrar's decision, present once the brand is submitted. `PENDING` while under review, `PENDING_2FA`
            while a public company's business contact completes brand authentication, `PENDING_APPEAL` while an appeal is
            reviewed, `ACTIVE` when approved and `REJECTED` when declined (see `rejectionReasons`).
        brandIdentityStatus:
          type: string
          description: Identity verification result from the registry, for example `VERIFIED`, `UNVERIFIED` or `VETTED_VERIFIED`.
            Omitted until the registry reports one.
          example: VERIFIED
        rejectionReasons:
          type: array
          description: Rejections recorded by registrars, one entry per registrar. Omitted when there are none; fix the brand
            with `PUT /TenDlc/Brand/{id}/` and register it again.
          items:
            $ref: '#/components/schemas/BrandRejectionReason'
        website:
          type: string
          format: uri
          example: https://example.com
          description: Business website as submitted to the registry. Omitted when not set.
        supportEmail:
          type: string
          example: support@example.com
          description: Support email address for the business. Omitted when not set.
        supportPhone:
          type: string
          example: '+14155550100'
          description: Support phone number for the business, in E.164 format. Omitted when not set.
        vertical:
          type: string
          example: TECHNOLOGY
          description: Industry vertical code as submitted to the registry, for example `TECHNOLOGY`. Omitted when not set.
        taxId:
          type: string
          example: 12-3456789
          description: Tax identifier of the business, for example a US EIN. Omitted when not set.
        taxIdIssuingCountry:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country that issued `taxId`, for example `US`. Omitted when not set.
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country where the business is registered. Omitted when not set.
        address:
          allOf:
          - $ref: '#/components/schemas/BrandAddress'
          description: Postal address of the business as submitted to the registry. Omitted when not set.
        alternateBusinessId:
          type: object
          additionalProperties: true
          description: Alternate business identifier (for example a DUNS or LEI record), returned as you sent it. Omitted
            when not set.
        businessContactFirstName:
          type: string
          example: Alex
          description: First name of the business contact the registry can reach. Omitted when not set.
        businessContactLastName:
          type: string
          example: Doe
          description: Last name of the business contact the registry can reach. Omitted when not set.
        businessContactEmail:
          type: string
          example: alex.doe@example.com
          description: Email address of the business contact; brand-authentication and 2FA requests go here. Omitted when
            not set.
        businessDba:
          type: string
          description: Trading name ("doing business as") when it differs from `legalName`. Omitted when not set.
        legalEntityType:
          type: string
          example: PRIVATE_COMPANY
          description: Legal entity type as submitted to the registry, for example `PRIVATE_COMPANY`. Omitted when not set.
        businessRegistrationType:
          type: string
          description: Type of business registration number for a business outside the US, for example `VAT`. Omitted when
            not set.
        stockExchange:
          type: string
          description: Exchange where a `TENDLC_PUBLIC_COMPANY` brand is listed. Omitted when not set.
        stockSymbol:
          type: string
          description: Ticker symbol of a `TENDLC_PUBLIC_COMPANY` brand. Omitted when not set.
        taxExemptStatus:
          type: string
          description: Tax-exempt status of a `TENDLC_NON_PROFIT` brand. Omitted when not set.
        lastSyncedAt:
          type: string
          format: date-time
          description: When Vobiz last refreshed this record from the US 10DLC registry, in ISO 8601 (RFC 3339) UTC. Omitted
            until the first refresh.
          example: '2026-10-12T10:35:00Z'
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the record was created on your account, in ISO 8601 (RFC 3339) UTC.
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-12T10:35:00Z'
          description: When the record last changed on your account, in ISO 8601 (RFC 3339) UTC.
    BrandRegistrarStatus:
      type: object
      description: The brand's state at one registrar, read live from the US 10DLC registry.
      properties:
        registrar:
          type: string
          example: TCR
          description: Registrar that reviewed the brand.
        state:
          type: string
          example: ACTIVE
          description: The brand's registration state at this registrar, for example `ACTIVE`, `PENDING` or `REJECTED`.
        brandIdentityStatus:
          type: string
          description: Identity verification result from this registrar, for example `VERIFIED`. Present only when the registrar
            reports one.
          example: VERIFIED
        brandAuthenticationStatus:
          type: string
          description: Brand-authentication (2FA) status for `TENDLC_PUBLIC_COMPANY` brands. Present only when the registrar
            reports one.
          example: AUTHENTICATED
        rejectionReason:
          type: string
          description: Why the registrar rejected the brand. Present only when `state` is a rejection.
    BrandAuthRequested:
      type: object
      properties:
        status:
          type: string
          example: requested
          description: Always `requested`. Follow the result in the brand's `registrationStatus` or in `GET /TenDlc/Brand/{id}/RegistrarStatuses/`.
      description: Acknowledgement that the registry accepted a brand-authentication or 2FA resend request. The outcome arrives
        later on the brand.
    BrandVetRequest:
      type: object
      properties:
        type:
          type: string
          enum:
          - STANDARD
          - ENHANCED
          - POLITICAL
          default: STANDARD
          description: 'Kind of vet to request: `STANDARD` (the default), `ENHANCED` (a deeper review) or `POLITICAL` (for
            political organisations). Case-insensitive; any other value returns `400` with `invalid request: type must be
            one of STANDARD, ENHANCED, POLITICAL`.'
      description: Body of a brand vetting request. Send `{}` or omit `type` for a standard vet.
    RegistryRecord:
      type: object
      description: A record returned by the US 10DLC registry, such as a vetting record, passed through as received. Its keys
        follow the registry's schema, so read the fields you need and ignore the rest.
      additionalProperties: true
    CampaignFields:
      type: object
      description: Fields shared by campaign create and update requests. Values are passed to the US 10DLC registry as given,
        and reviewers check them against your brand and website.
      properties:
        name:
          type: string
          description: Name for the campaign, for your reference. Required on create and on update.
          example: Example Corp account alerts
        programSummary:
          type: string
          description: 'Plain-language description of the program: what you send, to whom, how often and how recipients opt
            in. Reviewers read this first.'
          example: Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP
            to opt out, HELP for help.
        confirmationMessage:
          type: string
          description: Message you send when a recipient opts in. Include your brand name and how to get help or opt out.
          example: 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply.
            Reply HELP for help, STOP to opt out.'
        helpMessage:
          type: string
          description: Reply you send when a recipient texts HELP. Include your brand name and a way to reach support.
          example: 'Example Corp: For help email support@example.com. Reply STOP to opt out.'
        stopMessage:
          type: string
          description: Reply you send when a recipient texts STOP, confirming they will receive no further messages.
          example: 'Example Corp: You have been unsubscribed. Reply HELP for help.'
        customerCarePhone:
          type: string
          example: '+14155550100'
          description: Customer care phone number for the program, in E.164 format.
        customerCareEmail:
          type: string
          format: email
          example: support@example.com
          description: Customer care email address for the program.
        termsAndConditionsUrl:
          type: string
          format: uri
          example: https://example.com/terms
          description: Public URL of the terms and conditions that cover the program.
        privacyPolicyUrl:
          type: string
          format: uri
          example: https://example.com/privacy
          description: Public URL of your privacy policy.
        exampleMessages:
          type: array
          description: Sample messages exactly as the campaign will send them, including your brand name and opt-out language.
            Cover each use case you list.
          items:
            type: string
          example:
          - 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt
            out.'
        useCases:
          type: array
          description: 'Use-case codes the campaign covers. Values accepted by the US 10DLC registry: `TWO_FACTOR_AUTH`, `ALERTS`,
            `FRAUD_ALERTS`, `CHAT`, `PROMOTIONAL_MARKETING`, `EDUCATION`, `DONATION`, `PUBLIC_SERVICE_ANNOUNCEMENT`, `VOTING_POLLING`,
            `POLITICAL`, `M2M`, `SWEEPSTAKE`.'
          items:
            type: string
          example:
          - ALERTS
        messageTypes:
          type: array
          description: Message types the campaign sends, for example `SMS` and `MMS`.
          items:
            type: string
          example:
          - SMS
        optIns:
          type: object
          description: How recipients give consent, as an object keyed by opt-in channel (for example `web`, `keyword`, `paper`).
            Each entry describes that flow, for example `url` and `callToAction` for `web`; the object is passed to the registry
            as given.
          additionalProperties: true
          example:
            web:
              url: https://example.com/signup
              callToAction: By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies.
                Msg & data rates may apply. Reply STOP to opt out, HELP for help.
        lowVolume:
          type: boolean
          default: false
          description: Declares the campaign as low volume to the registry. Defaults to `false`.
        ageGated:
          type: boolean
          default: false
          description: Set `true` when the content is restricted to adults. Defaults to `false`.
        directLending:
          type: boolean
          default: false
          description: Set `true` when the content relates to direct lending or loan arrangements. Defaults to `false`.
        embeddedLink:
          type: boolean
          default: false
          description: Set `true` when messages contain URLs. Defaults to `false`.
        embeddedPhone:
          type: boolean
          default: false
          description: Set `true` when messages contain phone numbers. Defaults to `false`.
        numbers:
          type: array
          description: Numbers on your account to attach to the campaign, as digits with country code and no `+` (for example
            `14155550100`).
          items:
            type: string
          example:
          - '14155550100'
        supportingDocuments:
          type: array
          description: '`documentId` values of supporting documents uploaded with `POST /TenDlc/Document/`. Every ID must be
            on your account, otherwise the request returns `400`.'
          items:
            type: string
            format: uuid
        mmsSampleFiles:
          type: array
          description: '`documentId` values of MMS sample files uploaded with `POST /TenDlc/Document/`. Every ID must be on
            your account, otherwise the request returns `400`.'
          items:
            type: string
            format: uuid
    CreateCampaignRequest:
      allOf:
      - $ref: '#/components/schemas/CampaignFields'
      - type: object
        required:
        - brandId
        - name
        properties:
          referenceId:
            type: string
            description: Your own idempotency reference. Repeating a create with the same value reconciles to the same campaign
              instead of creating a second one. Not used on update.
            example: campaign-account-alerts-01
          brandId:
            type: string
            format: uuid
            description: Required. ID of the brand from `POST /TenDlc/Brand/` that runs this campaign. A missing, unknown or
              non-UUID value returns `404` with `{"error":"brand not found"}`.
            example: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
          campaignType:
            type: string
            enum:
            - TEN_DIGIT_LONG_CODE
            - EXTERNAL_TEN_DIGIT_LONG_CODE
            - DCA2_TEN_DIGIT_LONG_CODE
            - SHORT_CODE
            - RCS_SENDER_LAUNCH
            default: TEN_DIGIT_LONG_CODE
            description: Kind of campaign. Defaults to `TEN_DIGIT_LONG_CODE`, the standard 10DLC campaign. Toll-free types
              return `400`; use `POST /TenDlc/Campaign/TollFree/` for those.
      description: 'Body of a 10DLC campaign create: the shared campaign fields plus the brand, type and idempotency reference.
        `name` and `brandId` are required.'
    UpdateCampaignRequest:
      allOf:
      - $ref: '#/components/schemas/CampaignFields'
      - type: object
        required:
        - name
        description: Full replacement of the campaign's editable fields. `campaignType` and the brand stay as created.
      description: 'Full replacement body for a 10DLC campaign update: the shared campaign fields. `name` is required and
        any field you leave out is cleared; `campaignType` and the brand stay as created.'
    TollFreeCampaignRequest:
      type: object
      description: Toll-free verification request. The business details travel inside the request, so no `brandId` is needed;
        only `name` is required, but the reviewer checks every field you send.
      required:
      - name
      properties:
        referenceId:
          type: string
          description: Your own idempotency reference. Repeating a create with the same value reconciles to the same campaign
            instead of creating a second one.
          example: tollfree-notifications-01
        name:
          type: string
          example: Example Corp toll-free notifications
          description: 'Name for the toll-free campaign, for your reference. Required (`400` with `invalid request: name is
            required` otherwise).'
        privacyPolicyUrl:
          type: string
          format: uri
          example: https://example.com/privacy
          description: Public URL of your privacy policy.
        termsAndConditionsUrl:
          type: string
          format: uri
          example: https://example.com/terms
          description: Public URL of the terms and conditions that cover the program.
        messageVolume:
          type: string
          description: 'Expected monthly message volume. Values accepted by the US 10DLC registry: `HUNDRED`, `TEN_THOUSAND`,
            `TWO_HUNDRED_FIFTY_THOUSAND`, `SEVEN_HUNDRED_FIFTY_THOUSAND`, `FIVE_MILLION`.'
          example: TEN_THOUSAND
        numbers:
          type: array
          description: Toll-free numbers on your account to verify, in E.164 format (for example `+18885550100`).
          items:
            type: string
          example:
          - '+18335550100'
        numberKeys:
          type: array
          description: Registry number keys of the numbers to verify, as an alternative to `numbers`.
          items:
            type: string
        useCase:
          type: string
          description: 'Main use case of the program. Values accepted by the US 10DLC registry: `TWO_FACTOR_AUTH`, `NOTIFICATIONS`,
            `SYSTEM_ALERTS`, `APP_NOTIFICATIONS`, `BANKING`, `BOOKING_CONFIRMATIONS`, `CHATBOT`, `COURIER_SERVICES_DELIVERIES`,
            `EMERGENCY_ALERTS`, `EVENTS_PLANNING`, `FRAUD_ALERTS`, `GENERAL_MARKETING`, `HEALTHCARE`, `INSURANCE_SERVICES`,
            `LEGAL_SERVICES`, `MOTIVATIONAL_REMINDERS`, `POLITICAL`, `REAL_ESTATE_SERVICES`, `RELIGIOUS_SERVICES`, `REWARDS_PROGRAM`,
            `WEBINAR_REMINDERS`, `AUCTIONS`, `COVID_19_ALERTS`.'
          example: NOTIFICATIONS
        programSummary:
          type: string
          example: Example Corp sends account and support notifications to customers who opted in on the contact form. Reply
            STOP to opt out, HELP for help.
          description: 'Plain-language description of the program: what you send, to whom, how often and how recipients opt
            in.'
        exampleMessage:
          type: string
          example: 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt
            out, HELP for help.'
          description: A sample message exactly as you will send it, including your brand name and opt-out language.
        optIns:
          type: object
          description: How recipients give consent, as an object keyed by opt-in channel (for example `web` with `url` and
            `callToAction`). Passed to the registry as given.
          additionalProperties: true
          example:
            web:
              url: https://example.com/contact
              callToAction: By checking this box you agree to receive account notifications from Example Corp. Reply STOP
                to opt out, HELP for help.
        optInImageURLs:
          type: array
          description: Public URLs of screenshots or images that show the opt-in flow to the reviewer.
          items:
            type: string
            format: uri
          example:
          - https://example.com/opt-in-screenshot.png
        additionalInformation:
          type: string
          description: Anything else the reviewer should know about the program, in plain text.
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country where the business is registered.
        address:
          allOf:
          - $ref: '#/components/schemas/BrandAddress'
          description: Postal address of the business as it appears on its registration records.
        supportPhone:
          type: string
          example: '+14155550100'
          description: Support phone number for the business, in E.164 format.
        supportEmail:
          type: string
          format: email
          example: support@example.com
          description: Support email address for the business.
        businessContactFirstName:
          type: string
          example: Alex
          description: First name of the person the reviewer can contact about the business.
        businessContactLastName:
          type: string
          example: Doe
          description: Last name of the person the reviewer can contact about the business.
        legalName:
          type: string
          example: Example Corporation Inc.
          description: Registered legal name of the business, exactly as it appears on tax records.
        businessDBA:
          type: string
          description: Trading name ("doing business as") when it differs from `legalName`. Note the casing `businessDBA`
            on this endpoint, unlike `businessDba` on brands.
        businessName:
          type: string
          example: Example Corp
          description: Business name customers know you by.
        businessWebsite:
          type: string
          format: uri
          example: https://example.com
          description: Business website. It must be live and match the business.
        customerCareEmail:
          type: string
          format: email
          example: support@example.com
          description: Customer care email address for the program.
        taxId:
          type: string
          example: 12-3456789
          description: Tax identifier of the business, for example the US EIN.
        taxIdIssuingCountry:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code of the country that issued `taxId`.
        legalEntityType:
          type: string
          description: 'Legal form of the business. Values accepted by the US 10DLC registry: `PRIVATE_COMPANY`, `PUBLIC_COMPANY`,
            `NON_PROFIT`, `GOVERNMENT`, `SOLE_PROPRIETOR`.'
          example: PRIVATE_COMPANY
        businessRegistrationType:
          type: string
          description: 'Type of registration number for a business outside the US. Values accepted by the US 10DLC registry:
            `VAT`, `CBN`, `PROVINCIAL_NUMBER`, `ABN`, `SIREN`, `NZBN`, `CIF`, `CNPJ`, `OTHER`.'
        campaignVerifyToken:
          type: string
          description: Campaign Verify token for a US political program. Omit it for every other program.
        priorityId:
          type: string
          format: uuid
          description: ID (UUID) of a priority option from `GET /TenDlc/Campaign/Priorities/`. A value that is not a UUID returns
            `400`; omit it when the list is empty.
    Campaign:
      type: object
      description: A 10DLC or toll-free campaign on your account and its state at the US 10DLC registry. Optional fields are
        omitted when empty, and registry state is refreshed when you retrieve the campaign.
      properties:
        id:
          type: string
          format: uuid
          description: Campaign ID (UUID) on your account. Use it in every `/TenDlc/Campaign/{id}/` path.
          example: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (`MA_...`). Always the account whose credentials made the request.
        brandId:
          type: string
          format: uuid
          description: ID of the brand the campaign runs under. Omitted for toll-free campaigns, which carry their business
            details themselves.
          example: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
        name:
          type: string
          example: Example Corp account alerts
          description: Name you gave the campaign, for your reference.
        campaignType:
          type: string
          enum:
          - TEN_DIGIT_LONG_CODE
          - TOLL_FREE_UNIFIED_NUMBER
          - TOLL_FREE_NUMBER
          - SHORT_CODE
          - EXTERNAL_TEN_DIGIT_LONG_CODE
          - DCA2_TEN_DIGIT_LONG_CODE
          - TOLL_FREE_EXTERNALLY_VERIFIED
          - RCS_SENDER_LAUNCH
          description: Kind of campaign. `TEN_DIGIT_LONG_CODE` is a standard 10DLC campaign (the default on create) and `TOLL_FREE_UNIFIED_NUMBER`
            is a toll-free verification created with `POST /TenDlc/Campaign/TollFree/`. The other values are registry campaign
            types you can request on create.
        stage:
          type: string
          description: Registry lifecycle stage. A new campaign is `DRAFT`; after you register it, it moves through review
            stages such as `SUBMITTED`, `IN_REVIEW` or `APPEALED` and settles at `REGISTERED` or `REJECTED`. Other values
            include `REGISTERED_PENDING_UPDATE`, `REGISTERED_PENDING_DEREGISTRATION`, `REJECTED_EXTERNALLY`, `DEREGISTERED`,
            `ARCHIVED`, `BLOCKED`, `SUSPENDED` and `DELETED`; treat it as an open string.
          example: REGISTERED
        programSummary:
          type: string
          description: Description of the program as submitted to the registry. Omitted when not set.
        confirmationMessage:
          type: string
          description: Opt-in confirmation message as submitted. Omitted when not set.
        helpMessage:
          type: string
          description: HELP reply as submitted. Omitted when not set.
        stopMessage:
          type: string
          description: STOP reply as submitted. Omitted when not set.
        customerCarePhone:
          type: string
          example: '+14155550100'
          description: Customer care phone number, in E.164 format. Omitted when not set.
        customerCareEmail:
          type: string
          example: support@example.com
          description: Customer care email address. Omitted when not set.
        exampleMessages:
          type: array
          items:
            type: string
          description: Sample messages as submitted. Omitted when not set.
        termsAndConditionsUrl:
          type: string
          format: uri
          description: Public URL of your terms and conditions. Omitted when not set.
        privacyPolicyUrl:
          type: string
          format: uri
          description: Public URL of your privacy policy. Omitted when not set.
        useCases:
          type: array
          items:
            type: string
          example:
          - ALERTS
          description: Use-case codes as submitted, for example `ALERTS` or, on a toll-free campaign, `NOTIFICATIONS`. Omitted
            when not set.
        messageTypes:
          type: array
          items:
            type: string
          example:
          - SMS
          description: Message types as submitted, for example `SMS`. Omitted when not set.
        optIns:
          type: object
          description: Opt-in details as submitted, keyed by channel (for example `web`). Omitted when not set.
          additionalProperties: true
        lowVolume:
          type: boolean
          description: Whether the campaign is declared low volume. Always present; `false` unless you set it.
        ageGated:
          type: boolean
          description: Whether the content is restricted to adults. Always present; `false` unless you set it.
        directLending:
          type: boolean
          description: Whether the content relates to direct lending. Always present; `false` unless you set it.
        embeddedLink:
          type: boolean
          description: Whether messages contain URLs. Always present; `false` unless you set it.
        embeddedPhone:
          type: boolean
          description: Whether messages contain phone numbers. Always present; `false` unless you set it.
        numbers:
          type: array
          description: Numbers recorded on the campaign on your account. 10DLC campaigns store digits with country code (for
            example `14155550100`); toll-free campaigns store E.164 with a leading `+`. For the registry's own list use `GET
            /TenDlc/Campaign/{id}/Number/`.
          items:
            type: string
          example:
          - '14155550100'
        rejectionReasons:
          type: object
          description: The registry's review feedback after a rejection, with keys such as `rejectionDate`, `rejectionReasons`
            and `rejectionDetails` (each detail has `errorCode`, `description`, `recommendedAction` and `rejectionCategory`).
            Omitted when the campaign has no feedback; address every point before you appeal.
          additionalProperties: true
        lastSyncedAt:
          type: string
          format: date-time
          description: When Vobiz last refreshed this record from the US 10DLC registry, in ISO 8601 (RFC 3339) UTC. Omitted
            until the first refresh.
          example: '2026-10-14T17:19:03Z'
        createdAt:
          type: string
          format: date-time
          example: '2026-10-06T14:28:25Z'
          description: When the record was created on your account, in ISO 8601 (RFC 3339) UTC.
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-14T17:19:03Z'
          description: When the record last changed on your account, in ISO 8601 (RFC 3339) UTC.
    CampaignRegisterRequest:
      type: object
      properties:
        priorityId:
          type: string
          format: uuid
          description: 'ID (UUID) of a priority option from `GET /TenDlc/Campaign/Priorities/`, for toll-free campaigns. A
            value that is not a UUID returns `400` with `invalid request: priorityId must be a UUID`.'
          example: 2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d
      description: Optional body of a campaign registration. Send no body, or `{}`, for a 10DLC campaign.
    CampaignAppealRequest:
      type: object
      required:
      - reason
      properties:
        reason:
          type: string
          description: Required. Explains why the campaign should be reconsidered and what you changed; address every point
            in the campaign's `rejectionReasons`.
          example: Updated the program summary and opt-in call to action to match the brand's registered details.
      description: Body of an appeal against a campaign rejection.
    CampaignNumbersRequest:
      type: object
      description: 'Numbers to add to, remove from or re-register on a campaign. Provide `numbers`, `numberKeys`, or both;
        if both are empty the request returns `400` with `invalid request: numbers or numberKeys is required`.'
      properties:
        numbers:
          type: array
          description: Phone numbers on your account, as digits with country code and no `+` (for example `14155550100`).
            These values also update the campaign's `numbers` list on add and remove.
          items:
            type: string
          example:
          - '14155550100'
          - '14155550101'
        numberKeys:
          type: array
          description: Registry number keys from `GET /TenDlc/Campaign/{id}/Number/`, as an alternative to `numbers`.
          items:
            type: string
    PriorityOption:
      type: object
      description: A priority option available to your account at the US 10DLC registry. Pass its `id` as `priorityId` when
        you create or register a toll-free campaign; other keys follow the registry's schema.
      additionalProperties: true
      properties:
        id:
          type: string
          format: uuid
          example: 2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d
          description: ID (UUID) of the priority option. Pass it as `priorityId`.
    Document:
      type: object
      description: A supporting document or MMS sample file uploaded for campaign registration.
      properties:
        id:
          type: string
          format: uuid
          description: Record ID (UUID) of the upload on your account. Downloads and campaign references use `documentId`,
            not this value.
          example: 3d2c1b0a-9e8f-4d7c-b6a5-4f3e2d1c0b9a
        accountId:
          type: string
          example: MA_XXXXXXXX
          description: Your Vobiz account ID (`MA_...`). Always the account whose credentials made the request.
        provider:
          type: string
          description: Routing identifier. Don't rely on its value.
        documentId:
          type: string
          format: uuid
          description: The registry's document ID (UUID). Use it in `GET /TenDlc/Document/{id}/` and in a campaign's `supportingDocuments`
            or `mmsSampleFiles`.
          example: 7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b
        documentName:
          type: string
          example: opt-in-screenshot.png
          description: Original filename of the upload. Omitted when not recorded.
        contentType:
          type: string
          example: image/png
          description: Media type of the file, for example `application/pdf` or `image/png`. Omitted when not recorded.
        contentLength:
          type: integer
          format: int64
          description: Size of the file in bytes.
          example: 48213
        createdAt:
          type: string
          format: date-time
          example: '2026-10-12T10:30:00Z'
          description: When the record was created on your account, in ISO 8601 (RFC 3339) UTC.
    CampaignNetworkStatus:
      type: object
      description: The campaign's status on one US carrier network, read live from the US 10DLC registry.
      properties:
        network:
          type: string
          description: Carrier network the entry describes, for example `T_MOBILE`, `ATT` or `VERIZON`.
          example: T_MOBILE
        state:
          type: string
          description: The campaign's registration state on that network, for example `ACTIVE` once provisioned.
          example: ACTIVE
        messageClass:
          type: string
          description: Message class the network assigned to the campaign. `null` when the network does not report one.
          example: T
          nullable: true
        throughput:
          type: integer
          description: Throughput the network grants the campaign. The unit depends on the network (messages per minute on
            some, a daily cap on others). `null` when the network does not report one.
          example: 75
          nullable: true
        brandTier:
          type: string
          description: Brand tier the network applies, for example `LOW`. `null` when the network does not use tiers.
          example: LOW
          nullable: true
    CampaignNumberPreview:
      type: object
      properties:
        numberKey:
          type: string
          description: Registry key for the number. Pass it in `numberKeys` on campaign number requests.
          example: 6f5e4d3c2b1a4c9d8e7f0a1b2c3d4e5f
        number:
          type: string
          description: The number, as digits with country code and no `+` (for example `14155550100`).
          example: '14155550100'
        countryCode:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 country code of the number, for example `US`.
      description: One number attached to a campaign at the US 10DLC registry.
    CampaignNumberList:
      type: object
      properties:
        numberPreviews:
          type: array
          items:
            $ref: '#/components/schemas/CampaignNumberPreview'
          description: One entry per attached number. Empty when no numbers are attached.
      description: Numbers the US 10DLC registry associates with a campaign.
    BrandVetPaging:
      type: object
      properties:
        page:
          type: integer
          description: Zero-based index of this page, matching the `page` you requested.
        size:
          type: integer
          description: Page size applied to the request; `20` when you omit `size` or send `0`.
        totalPages:
          type: integer
          description: Total number of pages at this `size`.
        totalResults:
          type: integer
          description: Total number of vetting records for the brand.
      description: Paging details for a list of brand vets.
    BrandVetList:
      type: object
      properties:
        results:
          type: array
          description: Vetting records on this page, passed through from the registry as received. Empty when the brand has
            no vetting records.
          items:
            $ref: '#/components/schemas/RegistryRecord'
        paging:
          allOf:
          - $ref: '#/components/schemas/BrandVetPaging'
          description: Where this page sits in the full result set.
      description: One page of the brand's vetting records from the US 10DLC registry.
    LookupRequest:
      type: object
      description: Numbers to check against the mobile network.
      required:
      - numbers
      properties:
        numbers:
          type: array
          minItems: 1
          maxItems: 100
          description: 'Numbers to check, in E.164 format (`+14155550123`) or national format read with `defaultCountry`.
            At most 100 per request. A missing or empty array returns `400` with `numbers is required`; more than 100 returns
            `422` with `too many numbers: at most 100 per request`. Duplicates (the same E.164 number, or the same invalid
            text) are checked once.'
          items:
            type: string
          example:
          - '+14155550123'
          - (415) 555-0124
        defaultCountry:
          type: string
          default: US
          description: ISO 3166-1 alpha-2 country code, matched case-insensitively, used to read numbers written without
            a `+` country code. Defaults to `US`. A code outside the list returns `422` with `unsupported defaultCountry`.
          enum:
          - US
          - CA
          - GB
          - IN
          - AU
          - NZ
          - IE
          - DE
          - FR
          - ES
          - IT
          - NL
          - BE
          - CH
          - AT
          - SE
          - 'NO'
          - DK
          - FI
          - PL
          - PT
          - BR
          - MX
          - AR
          - CO
          - CL
          - SG
          - MY
          - ID
          - PH
          - TH
          - VN
          - JP
          - KR
          - CN
          - HK
          - AE
          - SA
          - QA
          - IL
          - TR
          - ZA
          - NG
          - KE
          - EG
          - PK
          - BD
          - LK
          - NP
        fresh:
          type: boolean
          default: false
          description: '`true` skips the cache and asks the network again. By default a result for the same number from
            the last 24 hours is reused and returned with `cached: true`.'
    LookupStatus:
      type: object
      description: The network's answer for the number.
      properties:
        group:
          type: string
          description: Status group, upper-case, for example `DELIVERED` (the number is reachable), `UNDELIVERABLE`, `REJECTED`,
            `PENDING` or `EXPIRED`. `valid` is `true` only for `DELIVERED`.
          example: REJECTED
        name:
          type: string
          description: Detailed status name within the group, for example `REJECTED_ROUTE_NOT_AVAILABLE`.
          example: REJECTED_ROUTE_NOT_AVAILABLE
        description:
          type: string
          description: Human-readable explanation of the status.
          example: Route not available
    LookupFailure:
      type: object
      description: The network error for the number. `null` when there was none.
      properties:
        name:
          type: string
          description: Error name reported by the network.
        description:
          type: string
          description: Human-readable explanation of the error.
        permanent:
          type: boolean
          description: '`true` when the error is permanent, for example a number that does not exist. A permanent error
            makes `valid` `false`.'
    LookupCountry:
      type: object
      description: The country the number belongs to.
      properties:
        iso:
          type: string
          description: ISO 3166-1 alpha-2 country code. An empty string when the country could only be named, not matched
            to a code.
          example: US
        name:
          type: string
          description: Country name.
          example: United States
        dialCode:
          type: string
          description: Country calling code, without `+`.
          example: '1'
    LookupNetwork:
      type: object
      description: The network that serves the number now (the ported network when the number was ported).
      properties:
        name:
          type: string
          description: Network (carrier) name. An empty string when only the MCC/MNC is known.
          example: Example Mobile
        mccMnc:
          type: string
          description: Mobile country code and mobile network code of the serving network, for example `310260`.
          example: '310260'
    LookupNetworkName:
      type: object
      description: A network (carrier), by name.
      properties:
        name:
          type: string
          description: Network (carrier) name.
          example: Example Mobile
    LookupResult:
      type: object
      description: 'The result of checking one number. Inputs that could not be read as a phone number, or that got no answer,
        have `valid: false`, a `reason` and `null` for the network fields.'
      properties:
        input:
          type: string
          description: The value you sent, trimmed.
          example: '+14155550123'
        number:
          type: string
          description: The number in E.164 format. An empty string when `input` could not be read as a phone number.
          example: '+14155550123'
        valid:
          type: boolean
          description: '`true` when the number exists and is reachable: the status group is `DELIVERED`, or the network
            reported neither a status nor an error. `false` for a permanent error, any other status group, or an input that
            was not looked up.'
        reason:
          type: string
          description: Why the number was not looked up. Present only for those inputs.
          enum:
          - missing phone number
          - contains letters or symbols
          - too short
          - too long
          - not a valid US/Canada number
          - not a valid Indian mobile number
          - no result for this number
        status:
          allOf:
          - $ref: '#/components/schemas/LookupStatus'
          nullable: true
          description: The network status. `null` when the network returned none or the number was not looked up.
        error:
          allOf:
          - $ref: '#/components/schemas/LookupFailure'
          nullable: true
          description: The network error. `null` when there was none.
        country:
          allOf:
          - $ref: '#/components/schemas/LookupCountry'
          nullable: true
          description: The number's country. `null` when it is unknown.
        network:
          allOf:
          - $ref: '#/components/schemas/LookupNetwork'
          nullable: true
          description: The network that serves the number now. `null` when it is unknown.
        originalNetwork:
          allOf:
          - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: The network the number was originally issued by. `null` when it is unknown.
        ported:
          type: boolean
          description: '`true` when the number was moved to another network.'
        portedNetwork:
          allOf:
          - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: The network the number was ported to. `null` unless `ported` is `true` and the network is known.
        roaming:
          type: boolean
          description: '`true` when the handset is roaming on another network.'
        roamingNetwork:
          allOf:
          - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: The network the handset is roaming on. `null` unless `roaming` is `true` and the network is known.
        cached:
          type: boolean
          description: '`true` when the result was reused from a lookup of the same number in the last 24 hours instead
            of asking the network again.'
        checkedAt:
          type: string
          format: date-time
          description: When the network was asked, in RFC 3339 UTC. For a cached result, the time of the original lookup.
          example: '2026-10-12T10:30:00Z'
    LookupResponse:
      type: object
      description: One result per distinct input, in the order you sent them.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/LookupResult'
    LookupHistory:
      type: object
      description: One page of your past lookups, newest first.
      properties:
        lookups:
          type: array
          description: The lookups on this page. `cached` tells whether each one was served from the cache.
          items:
            $ref: '#/components/schemas/LookupResult'
        total:
          type: integer
          description: Total number of recorded lookups on your account across all pages.
          example: 3
paths:
  /api/v1/Account/{auth_id}/Sms/Message/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Messages
      summary: Send a message
      description: |-
        Sends an SMS, MMS or RCS message from one of your numbers or RCS senders to one or more recipients. Each number in `to` becomes its own message, with its own `id`, status and conversation, and the response body is the first recipient's message. Every recipient is checked against your opt-out list first, and a send with a future `scheduledAt` is stored with status `scheduled`.

        - `201` when every recipient was accepted, including an idempotent replay and a successful SMS fallback.
        - `202` when at least one recipient was recorded and at least one errored. Find the other recipients with `GET /Message/` filtered by `tag` or `to`.
        - `422` when the recipient has opted out and nothing was recorded.
        - `502` when the send was rejected before a message was recorded. Retry with the same `idempotencyKey`.

        Track delivery with `GET /Message/{id}/`, your webhooks (callbacks) or the WebSocket.
      operationId: send-message
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequest'
            examples:
              sms:
                summary: SMS with idempotency key
                value:
                  from: '+14155550100'
                  to:
                  - '+14155550123'
                  channel: sms
                  text: Your verification code is 482913
                  idempotencyKey: otp-482913-user-77
              mms:
                summary: MMS with media
                value:
                  from: '+14155550100'
                  to:
                  - '+14155550123'
                  channel: mms
                  title: Your invoice
                  text: Here is your invoice.
                  mediaUrls:
                  - https://example.com/invoice.pdf
              rcs:
                summary: RCS with buttons and SMS fallback
                value:
                  from: YOUR_RCS_SENDER_NAME
                  to:
                  - '+14155550123'
                  channel: rcs
                  text: Your appointment is confirmed for 3pm tomorrow.
                  rcsSuggestions:
                  - type: REPLY
                    text: Reschedule
                    postbackData: reschedule
                  - type: DIAL_PHONE
                    text: Call us
                    postbackData: call
                    phoneNumber: '+14155550100'
                  failoverToSms: true
                  idempotencyKey: appt-8812-confirm
              india:
                summary: SMS to India with DLT IDs
                value:
                  from: '+919876543210'
                  to:
                  - '+919876500001'
                  channel: sms
                  text: Your OTP is 4821.
                  dltEntityId: '1001234567890123456'
                  dltHeaderId: '1001234567'
                  dltTemplateId: '10012345678901234567'
      responses:
        '201':
          description: Sent or scheduled for every recipient. Body is the first recipient's message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              example:
                id: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
                accountId: MA_XXXXXXXX
                direction: out
                channel: sms
                from: '+14155550100'
                to: '+14155550123'
                text: Your verification code is 482913
                mediaUrls: null
                status: sent
                tag: otp
                conversationId: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '202':
          description: Several recipients and at least one failed. Body is the first recipient's message; check each recipient
            individually.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '400':
          description: Invalid body, bad `scheduledAt`, or an MMS validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                body:
                  value:
                    error: invalid request body
                mms:
                  value:
                    error: 'invalid mms: mediaUrls[0] must use https'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The recipient has opted out. Nothing was sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'recipient has opted out: +14155550123'
        '502':
          description: The message couldn't be sent and nothing was recorded. Check that `to` holds at least one recipient
            and that `from` is an SMS-capable number or RCS sender on your account, then retry with the same `idempotencyKey`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: at least one recipient required
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.messages.sendMessage({
              from: "+14155550100",
              to: ["+14155550123"],
              channel: "sms",
              text: "Your verification code is 482913",
              idempotencyKey: "otp-482913-user-77"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.messages.send_message(
              from_="+14155550100",
              to=[
                  "+14155550123"
              ],
              channel="sms",
              text="Your verification code is 482913",
              idempotency_key="otp-482913-user-77",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.SendMessageRequest{
                  From: "+14155550100",
                  To: []string{
                      "+14155550123",
                  },
                  Channel: sms.SendMessageRequestChannelSms.Ptr(),
                  Text: vobiz.String(
                      "Your verification code is 482913",
                  ),
                  IdempotencyKey: vobiz.String(
                      "otp-482913-user-77",
                  ),
              }
          c.Sms.Messages.SendMessage(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().messages().sendMessage(
              SendMessageRequest
                  .builder()
                  .from("+14155550100")
                  .to(
                      Arrays.asList("+14155550123")
                  )
                  .channel(SendMessageRequestChannel.SMS)
                  .text("Your verification code is 482913")
                  .idempotencyKey("otp-482913-user-77")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.messages.send_message(
            from: "+14155550100",
            to: ["+14155550123"],
            channel: "sms",
            text: "Your verification code is 482913",
            idempotency_key: "otp-482913-user-77"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Messages.SendMessageAsync(
              new SendMessageRequest
              {
                  From = "+14155550100",
                  To = new List<string>() { "+14155550123" },
                  Channel = SendMessageRequestChannel.Sms,
                  Text = "Your verification code is 482913",
                  IdempotencyKey = "otp-482913-user-77",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->messages->sendMessage(
              new SendMessageRequest([
                  'from' => '+14155550100',
                  'to' => [
                      '+14155550123',
                  ],
                  'channel' => SendMessageRequestChannel::Sms->value,
                  'text' => 'Your verification code is 482913',
                  'idempotencyKey' => 'otp-482913-user-77',
              ]),
          );
    get:
      tags:
      - Messages
      summary: List messages
      description: Returns the messages on your account, sent and received, newest first. Combine the filters to find a message
        you did not keep the `id` for, such as the other recipients of a multi-recipient send (filter by `tag` or `to`). Every
        filter is an exact match, and filters you omit are not applied. Page through results with `limit` and `offset`, and
        use `total` to know when to stop.
      operationId: list-messages
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - scheduled
          - sent
          - delivered
          - failed
          - received
          - unknown
        description: 'Only messages with this status: `scheduled`, `sent`, `delivered`, `failed`, `received` (inbound) or
          `unknown`.'
      - name: channel
        in: query
        schema:
          type: string
          enum:
          - sms
          - mms
          - rcs
        description: 'Only messages sent or received on this channel: `sms`, `mms` or `rcs`. This is the channel actually
          used, so an SMS that was upgraded to MMS appears under `mms`.'
      - name: direction
        in: query
        description: '`out` for messages you sent, `in` for messages your numbers received.'
        schema:
          type: string
          enum:
          - out
          - in
      - name: to
        in: query
        schema:
          type: string
        description: Recipient number to filter on, in E.164 format, exact match. For inbound messages this is your number.
      - name: from
        in: query
        schema:
          type: string
        description: 'Sender to filter on, exact match: one of your numbers in E.164 format (for example `+14155550100`),
          or the `senderName` of your RCS sender for RCS messages. For inbound messages this is the contact''s number.'
      - name: tag
        in: query
        schema:
          type: string
        description: Only messages whose `tag` equals this value, exact match. Set the same `tag` on related sends to retrieve
          them together.
      - name: startDate
        in: query
        description: Only messages created at or after this time, as an RFC 3339 timestamp such as `2026-10-01T00:00:00Z`.
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        description: Only messages created at or before this time, as an RFC 3339 timestamp such as `2026-11-01T00:00:00Z`.
          Combine with `startDate` for a date range.
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Maximum number of messages to return, from `1` to `100`. Defaults to `20`; a value outside that range
          also returns `20`.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: offset
        in: query
        description: Number of records to skip before the page starts, `0` or greater. Defaults to `0`. Add the page size
          to it to fetch the next page.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.messages.listMessages()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.messages.list_messages()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListMessagesRequest{}
          c.Sms.Messages.ListMessages(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().messages().listMessages(
              ListMessagesRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.messages.list_messages
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Messages.ListMessagesAsync(new ListMessagesRequest());
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->messages->listMessages(
              new ListMessagesRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Message/CostPreview/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Messages
      summary: Preview message cost
      description: Estimates the cost of a message before you send it, without sending anything. It splits `text` into segments
        for the chosen channel and returns the segment count with an estimated price per segment and in total. Use it to show
        a cost estimate in your app or to keep long messages within a budget. The figures are for one recipient; multiply
        `totalCost` by the number of recipients for a multi-recipient send.
      operationId: preview-message-cost
      parameters:
      - name: from
        in: query
        required: true
        schema:
          type: string
        example: '+14155550100'
        description: 'Required. The sender you plan to use: one of your numbers in E.164 format, or the `senderName` of your
          RCS sender when `channel` is `rcs`. It determines the route the message is priced on.'
      - name: to
        in: query
        required: true
        schema:
          type: string
        example: '+14155550123'
        description: Required. One recipient number in E.164 format, for example `+14155550123`. Its destination country determines
          the price.
      - name: channel
        in: query
        schema:
          type: string
          enum:
          - sms
          - mms
          - rcs
          default: sms
        description: 'Channel to price: `sms`, `mms` or `rcs`. Defaults to `sms`.'
      - name: text
        in: query
        description: 'The message body to segment and price, URL-encoded. Pass the exact text you plan to send: the segment
          count depends on its length and on whether it fits the GSM-7 character set. Defaults to an empty string.'
        schema:
          type: string
      responses:
        '200':
          description: Segment count and cost.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostPreview'
              example:
                channel: sms
                segmentCount: 2
                unitCost: 0.01
                totalCost: 0.02
                currency: USD
        '400':
          description: '`from` and `to` are required.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: from and to are required
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.messages.previewMessageCost({
              from: "+14155550100",
              to: "+14155550123"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.messages.preview_message_cost(
              from_="+14155550100",
              to="+14155550123",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.PreviewMessageCostRequest{
                  From: "+14155550100",
                  To: "+14155550123",
              }
          c.Sms.Messages.PreviewMessageCost(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().messages().previewMessageCost(
              PreviewMessageCostRequest
                  .builder()
                  .from("+14155550100")
                  .to("+14155550123")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.messages.preview_message_cost(
            from: "+14155550100",
            to: "+14155550123"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Messages.PreviewMessageCostAsync(
              new PreviewMessageCostRequest { From = "+14155550100", To = "+14155550123" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->messages->previewMessageCost(
              new PreviewMessageCostRequest([
                  'from' => '+14155550100',
                  'to' => '+14155550123',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/Message/RcsReachability/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Messages
      summary: Check RCS reachability
      description: 'Checks whether a phone number can receive RCS messages from your RCS sender, without sending anything.
        Call it before an RCS send to choose between RCS and SMS for that contact. If `reachable` is `false`, send with `channel:
        "sms"` instead, or send RCS with `failoverToSms: true` so Vobiz falls back to SMS automatically.'
      operationId: check-rcs-reachability
      parameters:
      - name: from
        in: query
        required: true
        description: Required. The `senderName` of your RCS sender, as returned by `GET /Sender/`.
        schema:
          type: string
        example: YOUR_RCS_SENDER_NAME
      - name: to
        in: query
        required: true
        schema:
          type: string
        example: '+14155550123'
        description: Required. The recipient number to check, in E.164 format, for example `+14155550123`.
      responses:
        '200':
          description: Reachability result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RCSReachability'
              example:
                to: '+14155550123'
                reachable: true
                carrier: Example Mobile
                capability: reachable
        '400':
          description: '`from` and `to` are required.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.messages.checkRcsReachability({
              from: "YOUR_RCS_SENDER_NAME",
              to: "+14155550123"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.messages.check_rcs_reachability(
              from_="YOUR_RCS_SENDER_NAME",
              to="+14155550123",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CheckRcsReachabilityRequest{
                  From: "YOUR_RCS_SENDER_NAME",
                  To: "+14155550123",
              }
          c.Sms.Messages.CheckRcsReachability(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().messages().checkRcsReachability(
              CheckRcsReachabilityRequest
                  .builder()
                  .from("YOUR_RCS_SENDER_NAME")
                  .to("+14155550123")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.messages.check_rcs_reachability(
            from: "YOUR_RCS_SENDER_NAME",
            to: "+14155550123"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Messages.CheckRcsReachabilityAsync(
              new CheckRcsReachabilityRequest { From = "YOUR_RCS_SENDER_NAME", To = "+14155550123" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->messages->checkRcsReachability(
              new CheckRcsReachabilityRequest([
                  'from' => 'YOUR_RCS_SENDER_NAME',
                  'to' => '+14155550123',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/Message/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Messages
      summary: Retrieve a message
      description: Returns one message with its full status history. Use it to follow a message from `sent` to `delivered`
        or `failed`, and to read `errorCode` and `errorMessage` when it fails. The `statusHistory` array lists every status
        change, oldest first. For real-time updates, subscribe to webhooks (callbacks) or the WebSocket instead of polling.
      operationId: get-message
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
        description: The message `id` (UUID) returned by `POST /Message/`, `GET /Message/`, a conversation, or an event.
      responses:
        '200':
          description: The message and its status history.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageWithHistory'
              example:
                id: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
                accountId: MA_XXXXXXXX
                direction: out
                channel: sms
                from: '+14155550100'
                to: '+14155550123'
                text: Your verification code is 482913
                mediaUrls: []
                status: delivered
                conversationId: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:31:04Z'
                statusHistory:
                - status: sent
                  createdAt: '2026-10-12T10:30:00Z'
                - status: delivered
                  createdAt: '2026-10-12T10:31:04Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The message wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: message not found
        '500':
          description: The request couldn't be completed. Check that `id` is a message `id` returned by Vobiz, then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: internal error
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.messages.getMessage({
              id: "9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.messages.get_message(
              id="9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetMessageRequest{
                  ID: "9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01",
              }
          c.Sms.Messages.GetMessage(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().messages().getMessage(
              "9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01",
              GetMessageRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.messages.get_message(id: "9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Messages.GetMessageAsync(
              new GetMessageRequest { Id = "9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->messages->getMessage(
              '9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01',
          );
  /api/v1/Account/{auth_id}/Sms/Number/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Numbers
      summary: List your numbers
      description: Returns every number on your account that is routed for SMS or MMS, sorted by `countryCode` and then `e164`.
        Each number carries its US registration state, the last message it sent and a `sendable` summary of where it can send
        right now. Check `sendable.usDomestic` before you send to US recipients from a US number. To add numbers, search with
        `GET /Number/Available/` and buy with `POST /Number/Purchase/`.
      operationId: list-numbers
      responses:
        '200':
          description: Your messaging numbers, sorted by country then number.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSNumberList'
              example:
                numbers:
                - e164: '+14155550100'
                  provider: internal
                  countryCode: US
                  channels:
                  - sms
                  - mms
                  type: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - SMS
                  - VOICE
                  - MMS
                  tenDlc:
                    campaignId: 3f1c7a2e-9d4b-4e8a-b6c5-2a7d9e1f0b43
                    campaignName: Order notifications
                    stage: REGISTERED
                  tollFree: false
                  registration:
                    kind: 10dlc
                    status: approved
                    campaignId: 3f1c7a2e-9d4b-4e8a-b6c5-2a7d9e1f0b43
                    campaignName: Order notifications
                    stage: REGISTERED
                  lastMessage:
                    status: delivered
                    errorCode: ''
                    errorMessage: ''
                    to: '+14155550123'
                    createdAt: '2026-10-16T21:23:02Z'
                  sendable:
                    international: true
                    usDomestic: true
                - e164: '+14155550101'
                  provider: internal
                  countryCode: US
                  channels:
                  - sms
                  - mms
                  type: ''
                  capabilities: []
                  tenDlc: null
                  tollFree: false
                  registration:
                    kind: 10dlc
                    status: not_registered
                    campaignId: ''
                    campaignName: ''
                    stage: ''
                  lastMessage: null
                  sendable:
                    international: true
                    usDomestic: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.listNumbers()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.list_numbers()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Numbers.ListNumbers(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().listNumbers();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.list_numbers
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.ListNumbersAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->listNumbers();
  /api/v1/sms/numbers/countries:
    get:
      tags:
      - Numbers
      summary: List countries in stock
      description: 'Returns the countries where you can buy messaging numbers, with the number types and capabilities in stock
        in each. The list is a snapshot that refreshes in the background: while `ready` is `false`, `countries` is empty and
        you retry shortly. India is not listed, because traffic to Indian recipients is sent from DLT-registered sender IDs.
        Pass a returned `country` to `GET /Number/Available/` to see individual numbers.'
      operationId: list-countries
      responses:
        '200':
          description: Countries with stock.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberCountries'
              examples:
                ready:
                  summary: Snapshot ready
                  value:
                    countries:
                    - country: CA
                      name: Canada
                      types:
                      - local
                      capabilities:
                      - SMS
                      - MMS
                      - VOICE
                    - country: GB
                      name: United Kingdom
                      types:
                      - local
                      capabilities:
                      - SMS
                    - country: US
                      name: United States
                      types:
                      - local
                      - tollfree
                      capabilities:
                      - SMS
                      - MMS
                      - VOICE
                    updatedAt: '2026-10-18T03:19:11Z'
                    ready: true
                warming:
                  summary: Snapshot still building
                  value:
                    countries: []
                    updatedAt: null
                    ready: false
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.listCountries()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.list_countries()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Numbers.ListCountries(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().listCountries();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.list_countries
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.ListCountriesAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->listCountries();
  /api/v1/Account/{auth_id}/Sms/Number/Available/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Numbers
      summary: Search available numbers
      description: Searches the inventory for numbers you can buy in one country, with their setup and monthly prices in your
        wallet currency. Each search returns up to 10 numbers. Pass the chosen `e164`, the `country` and any non-empty `numberKey`
        to `POST /Number/Purchase/`. For `country=IN` the list is empty and `hint` explains that Indian traffic uses DLT-registered
        sender IDs. A country outside the set Vobiz sells numbers in returns `422`.
      operationId: search-available-numbers
      parameters:
      - name: country
        in: query
        required: true
        description: Country to search, as an ISO 3166-1 alpha-2 code such as `US`, `CA` or `GB`. Case-insensitive. A value
          that is not two letters returns `400` with `country must be an ISO 3166-1 alpha-2 code`.
        schema:
          type: string
          pattern: ^[A-Za-z]{2}$
        example: US
      - name: capabilities
        in: query
        description: 'Comma-separated capabilities the number must have: `SMS`, `MMS`, or `SMS,MMS`. Case-insensitive, defaults
          to `SMS`. Any other value returns `400` with `capabilities must be SMS and/or MMS`.'
        schema:
          type: string
          default: SMS
        example: SMS,MMS
      - name: areaCode
        in: query
        description: Three-digit area code to search in, for example `415`. Accepted only when `country` is `US` or `CA`;
          other countries return `400` with `areaCode is only supported for US and CA`.
        schema:
          type: string
          pattern: ^[0-9]{3}$
        example: '415'
      - name: contains
        in: query
        description: Digits the number should contain, 1 to 15 digits, with an optional leading `+`. Confirm the digits in
          each returned `e164` before you buy. Anything else returns `400` with `contains must be 1-15 digits`.
        schema:
          type: string
          pattern: ^\+?[0-9]{1,15}$
        example: '555'
      - name: limit
        in: query
        description: Maximum number of results, from `1` to `100`. Each search returns up to 10 numbers, and the response
          `limit` shows the value applied. A value outside the range returns `400` with `limit must be between 1 and 100`,
          and a non-integer returns `400` with `limit must be an integer`.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 10
      - name: page
        in: query
        description: Zero-based page number, returned in the response. Defaults to `0`. Results come in a single page (`hasMore`
          is `false`), so narrow the search with `areaCode` or `contains` to see different numbers. A negative value returns
          `400` with `page must be >= 0`, and a non-integer returns `400` with `page must be an integer`.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: Numbers you can buy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableNumbersResponse'
              examples:
                us:
                  summary: US search
                  value:
                    numbers:
                    - e164: '+14155550100'
                      numberKey: ''
                      countryCode: US
                      type: VIRTUAL_LONG_NUMBER
                      capabilities:
                      - MMS
                      - SMS
                      - VOICE
                      network: ''
                      setupPrice: 1
                      monthlyPrice: 1
                      currency: USD
                      providerRequiresDocuments: false
                    page: 0
                    limit: 10
                    hasMore: false
                india:
                  summary: India
                  value:
                    numbers: []
                    page: 0
                    limit: 10
                    hasMore: false
                    hint: India uses DLT sender IDs, not long codes
        '400':
          description: A query parameter is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                country-missing:
                  value:
                    error: country is required
                country-format:
                  value:
                    error: country must be an ISO 3166-1 alpha-2 code
                capabilities:
                  value:
                    error: capabilities must be SMS and/or MMS
                areaCode:
                  value:
                    error: areaCode is only supported for US and CA
                limit:
                  value:
                    error: limit must be between 1 and 100
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The country or your wallet currency is outside the current sales set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                country:
                  value:
                    error: SMS numbers are not sold for country FR
                pricing:
                  value:
                    error: SMS numbers in GB cannot be priced in EUR yet; contact support
        '502':
          description: The number search couldn't be completed. Change the filter that `error` names, or retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rejected:
                  value:
                    error: 'number provider: invalid area code'
                unavailable:
                  value:
                    error: number provider unavailable; try again later
        '503':
          description: Number search is paused or busy. Retry after a short wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                busy:
                  value:
                    error: number search is busy; try again in a few seconds
                billing:
                  value:
                    error: billing is unavailable; try again later
                purchasing:
                  value:
                    error: number purchasing is not available
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.searchAvailableNumbers({
              country: "US",
              capabilities: "SMS,MMS",
              areaCode: "415"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.search_available_numbers(
              country="US",
              capabilities="SMS,MMS",
              area_code="415",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.SearchAvailableNumbersRequest{
                  Country: "US",
                  Capabilities: vobiz.String(
                      "SMS,MMS",
                  ),
                  AreaCode: vobiz.String(
                      "415",
                  ),
              }
          c.Sms.Numbers.SearchAvailableNumbers(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().searchAvailableNumbers(
              SearchAvailableNumbersRequest
                  .builder()
                  .country("US")
                  .capabilities("SMS,MMS")
                  .areaCode("415")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.search_available_numbers(
            country: "US",
            capabilities: "SMS,MMS",
            area_code: "415"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.SearchAvailableNumbersAsync(
              new SearchAvailableNumbersRequest
              {
                  Country = "US",
                  Capabilities = "SMS,MMS",
                  AreaCode = "415",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->searchAvailableNumbers(
              new SearchAvailableNumbersRequest([
                  'country' => 'US',
                  'capabilities' => 'SMS,MMS',
                  'areaCode' => '415',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/Number/Purchase/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Numbers
      summary: Purchase a number
      description: 'Buys a number returned by `GET /Number/Available/` and routes it to your account for messaging. This call
        spends money: it debits the setup fee and the first month''s rental from your wallet before the number is bought,
        and the rental renews monthly until you release the number. If the purchase cannot complete after the debit, your
        wallet is refunded and the error message says so. Run it only with your own credentials once you have confirmed the
        number and price. A `numbers.updated` WebSocket event is published when the number goes live; a US number then needs
        a 10DLC campaign or toll-free verification before it can send to US recipients.'
      operationId: purchase-number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseNumberRequest'
            examples:
              us:
                summary: US number
                value:
                  e164: '+14155550100'
                  country: US
              keyed:
                summary: Number with an inventory key
                value:
                  e164: '+442079460100'
                  country: GB
                  numberKey: YOUR_NUMBER_KEY
      responses:
        '201':
          description: The number is bought, charged and routed to your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseNumberResponse'
              example:
                purchase:
                  id: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                  accountId: MA_XXXXXXXX
                  provider: internal
                  e164: '+14155550100'
                  countryCode: US
                  type: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - VOICE
                  - SMS
                  - MMS
                  setupAmount: 1
                  monthlyAmount: 1
                  currency: USD
                  status: purchased
                  purchasedAt: '2026-10-12T09:06:44Z'
                  nextBillingAt: '2026-11-12T09:06:44Z'
                  releasedAt: null
                  createdAt: '2026-10-12T09:06:42Z'
                  updatedAt: '2026-10-12T09:06:44Z'
                  charges:
                  - purchaseId: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    kind: purchase
                    periodStart: '2026-10-12T09:06:42Z'
                    amount: 2
                    currency: USD
                    status: paid
                    reference: sms_number_purchase:5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    attempts: 1
                    attemptedAt: '2026-10-12T09:06:42Z'
                number:
                  id: 1042
                  e164: '+14155550100'
                  provider: internal
                  channelCapabilities:
                  - sms
                  - mms
                  accountId: MA_XXXXXXXX
                  countryCode: US
                  createdAt: '2026-10-12T09:06:44Z'
        '400':
          description: The body is invalid or the number does not match the country.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                e164:
                  value:
                    error: e164 must be a number in E.164 format
                country-missing:
                  value:
                    error: country is required
                country-format:
                  value:
                    error: country must be an ISO 3166-1 alpha-2 code
                mismatch:
                  value:
                    error: number does not belong to the given country
                body:
                  value:
                    error: invalid request body
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '402':
          description: Your wallet balance does not cover the setup fee plus the first month. Top up and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: insufficient balance
        '409':
          description: The number is already yours, is taken, or a purchase of it is already running.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                own:
                  value:
                    error: you already have this number
                taken:
                  value:
                    error: number is not available
                gone:
                  value:
                    error: number is no longer available
                in-progress:
                  value:
                    error: a purchase of this number is already in progress
        '422':
          description: The number cannot be sold to your account as requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                india:
                  value:
                    error: India uses DLT sender IDs, not long codes
                country:
                  value:
                    error: SMS numbers are not sold for country FR
                documents:
                  value:
                    error: this country needs regulatory documents; contact support
                capability:
                  value:
                    error: number is not SMS-capable
        '502':
          description: The purchase couldn't be completed. The error says whether your wallet was refunded automatically.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                refunded:
                  value:
                    error: number provider could not complete the purchase; your wallet has been refunded
                refund-pending:
                  value:
                    error: 'number provider: number already assigned; your refund is being processed by support'
                unavailable:
                  value:
                    error: number provider unavailable; try again later
        '503':
          description: Purchasing or billing is paused. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                purchasing:
                  value:
                    error: number purchasing is not available
                billing:
                  value:
                    error: billing is unavailable; try again later
        '500':
          description: Unexpected error. The message says whether a refund was issued or support needs to finish activation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                refunded:
                  value:
                    error: the purchase could not be completed; your wallet has been refunded
                activation:
                  value:
                    error: number purchased but could not be activated; contact support
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.purchaseNumber({
              e164: "+14155550100",
              country: "US"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.purchase_number(
              e164="+14155550100",
              country="US",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.PurchaseNumberRequest{
                  E164: "+14155550100",
                  Country: "US",
              }
          c.Sms.Numbers.PurchaseNumber(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().purchaseNumber(
              PurchaseNumberRequest
                  .builder()
                  .e164("+14155550100")
                  .country("US")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.purchase_number(
            e164: "+14155550100",
            country: "US"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.PurchaseNumberAsync(
              new PurchaseNumberRequest { E164 = "+14155550100", Country = "US" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->purchaseNumber(
              new PurchaseNumberRequest([
                  'e164' => '+14155550100',
                  'country' => 'US',
              ]),
          );
    get:
      tags:
      - Numbers
      summary: List number purchases
      description: 'Returns the numbers you have bought through Vobiz, newest first, each with its full list of wallet charges.
        Released numbers stay in the list with `status: released`, so this is the billing history of every number you have
        owned. Use `nextBillingAt` to see when each active number renews and `charges` to reconcile setup and rental debits.'
      operationId: list-purchases
      responses:
        '200':
          description: Your purchases.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberPurchaseList'
              example:
                purchases:
                - id: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                  accountId: MA_XXXXXXXX
                  provider: internal
                  e164: '+14155550100'
                  countryCode: US
                  type: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - VOICE
                  - SMS
                  - MMS
                  setupAmount: 1
                  monthlyAmount: 1
                  currency: USD
                  status: purchased
                  purchasedAt: '2026-10-12T09:06:44Z'
                  nextBillingAt: '2026-12-12T09:06:44Z'
                  releasedAt: null
                  createdAt: '2026-10-12T09:06:42Z'
                  updatedAt: '2026-11-12T10:06:07Z'
                  charges:
                  - purchaseId: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    kind: purchase
                    periodStart: '2026-10-12T09:06:42Z'
                    amount: 2
                    currency: USD
                    status: paid
                    reference: sms_number_purchase:5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    attempts: 1
                    attemptedAt: '2026-10-12T09:06:42Z'
                  - purchaseId: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    kind: rental
                    periodStart: '2026-11-12T09:06:44Z'
                    amount: 1
                    currency: USD
                    status: paid
                    reference: sms_number_rental:5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e:2026-11
                    attempts: 1
                    attemptedAt: '2026-11-12T10:06:06Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          description: Purchasing is paused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number purchasing is not available
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.listPurchases()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.list_purchases()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Numbers.ListPurchases(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().listPurchases();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.list_purchases
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.ListPurchasesAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->listPurchases();
  /api/v1/Account/{auth_id}/Sms/Number/{e164}/Release/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Numbers
      summary: Release a number
      description: 'Cancels a number you bought through Vobiz and removes it from your account. The number stops sending and
        receiving messages immediately, and monthly rental stops. The setup fee and the current month are not refunded, and
        a released number cannot be restored. The call has no request body and returns the purchase with `status: released`.
        Run it only with your own credentials once you are sure you no longer need the number.'
      operationId: release-number
      parameters:
      - name: e164
        in: path
        required: true
        description: The number to release, in E.164 format, for example `+14155550100`. In raw HTTP requests, URL-encode
          the `+` as `%2B`; the SDKs encode it for you. A value that is not an E.164 number returns `400`, and a number that
          is not on your account returns `404`.
        schema:
          type: string
        example: '+14155550100'
      responses:
        '200':
          description: The number is released. `status` is `released`, `releasedAt` is set and `nextBillingAt` is `null`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseNumberResponse'
              example:
                purchase:
                  id: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                  accountId: MA_XXXXXXXX
                  provider: internal
                  e164: '+14155550100'
                  countryCode: US
                  type: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - VOICE
                  - SMS
                  - MMS
                  setupAmount: 1
                  monthlyAmount: 1
                  currency: USD
                  status: released
                  purchasedAt: '2026-10-12T09:06:44Z'
                  nextBillingAt: null
                  releasedAt: '2026-10-20T14:02:10Z'
                  createdAt: '2026-10-12T09:06:42Z'
                  updatedAt: '2026-10-20T14:02:10Z'
                  charges:
                  - purchaseId: 5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    kind: purchase
                    periodStart: '2026-10-12T09:06:42Z'
                    amount: 2
                    currency: USD
                    status: paid
                    reference: sms_number_purchase:5c2d9e7a-1b4f-4a8c-9e3d-6f7a0b1c2d3e
                    attempts: 1
                    attemptedAt: '2026-10-12T09:06:42Z'
        '400':
          description: The path value is not an E.164 number.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: e164 must be a number in E.164 format
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The number is not on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number not found
        '409':
          description: The number cannot be released through the API right now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not-self-serve:
                  value:
                    error: this number was not bought through the console; contact support to release it
                in-progress:
                  value:
                    error: the purchase of this number is still in progress
        '502':
          description: The number couldn't be released. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number provider could not release the number; try again later
        '503':
          description: Purchasing is paused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number purchasing is not available
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.numbers.releaseNumber({
              e164: "+14155550100"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.numbers.release_number(
              e164="+14155550100",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ReleaseNumberRequest{
                  E164: "+14155550100",
              }
          c.Sms.Numbers.ReleaseNumber(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().numbers().releaseNumber(
              "+14155550100",
              ReleaseNumberRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.numbers.release_number(e164: "+14155550100")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Numbers.ReleaseNumberAsync(new ReleaseNumberRequest { E164 = "+14155550100" });
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->numbers->releaseNumber(
              '+14155550100',
          );
  /api/v1/sms/coverage:
    get:
      tags:
      - Coverage
      summary: List coverage
      description: 'Returns one summary row per destination country, sorted by country name: the sender types it accepts,
        whether sender registration is required, two-way support, opt-out rules and whether a sending window applies. Use
        it to plan where to send and which sender to use before you buy numbers or register. Filters combine, so `region`
        plus `twoWay=true` returns only two-way countries in that region. For the full record of one country, call `GET /api/v1/sms/coverage/{country}`.'
      operationId: list-coverage
      parameters:
      - name: q
        in: query
        description: Search text, case-insensitive. Matches a substring of the country name (`united`), an exact ISO 3166-1
          alpha-2 code (`GB`) or the start of the dial code (`44` or `+44`); spaces and a leading `+` don't affect the match.
        schema:
          type: string
        example: united
      - name: region
        in: query
        description: Exact region name, case-insensitive, for example `Northern America`, `Western Europe` or `South-central
          Asia`. Partial names match nothing; read the `region` values from an unfiltered list to see the full set.
        schema:
          type: string
        example: Northern America
      - name: twoWay
        in: query
        description: '`true` returns only countries where recipients can reply; `false` returns the rest, including countries
          where two-way support is unknown. Also accepts `1`/`0` and `t`/`f`; any other value returns `400` with `twoWay must
          be true or false`.'
        schema:
          type: boolean
      - name: registrationRequired
        in: query
        description: '`true` returns countries that require sender registration for local or international traffic; `false`
          returns countries that require neither. Accepts the same values as `twoWay`; anything else returns `400` with `registrationRequired
          must be true or false`.'
        schema:
          type: boolean
      responses:
        '200':
          description: Coverage rows and the dataset timestamp.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageList'
              example:
                countries:
                - country: GB
                  name: United Kingdom
                  region: Northern Europe
                  dialCode: '44'
                  senders:
                    alphanumeric:
                      local: true
                      international: true
                    shortCode:
                      local: true
                      international: true
                    longNumber:
                      local: true
                      international: true
                  registrationRequired:
                    local: true
                    international: true
                  twoWay: true
                  optOutMandatory: false
                  hasSendWindow: false
                - country: US
                  name: United States
                  region: Northern America
                  dialCode: '1'
                  senders:
                    alphanumeric:
                      local: false
                      international: false
                    shortCode:
                      local: true
                      international: true
                    longNumber:
                      local: true
                      international: true
                  registrationRequired:
                    local: true
                    international: true
                  twoWay: true
                  optOutMandatory: true
                  hasSendWindow: false
                total: 2
                updatedAt: '2026-10-09T09:49:01Z'
        '400':
          description: A boolean filter has a value other than `true` or `false`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: twoWay must be true or false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.coverage.listCoverage({
              q: "united",
              region: "Northern America"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.coverage.list_coverage(
              q="united",
              region="Northern America",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListCoverageRequest{
                  Q: vobiz.String(
                      "united",
                  ),
                  Region: vobiz.String(
                      "Northern America",
                  ),
              }
          c.Sms.Coverage.ListCoverage(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().coverage().listCoverage(
              ListCoverageRequest
                  .builder()
                  .q("united")
                  .region("Northern America")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.coverage.list_coverage(
            q: "united",
            region: "Northern America"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Coverage.ListCoverageAsync(
              new ListCoverageRequest { Q = "united", Region = "Northern America" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->coverage->listCoverage(
              new ListCoverageRequest([
                  'q' => 'united',
                  'region' => 'Northern America',
              ]),
          );
  /api/v1/sms/coverage/{country}:
    get:
      tags:
      - Coverage
      summary: Retrieve country coverage
      description: 'Returns the full coverage record for one country: accepted sender types, registration requirements and
        lead time, link rules, prohibited topics, the permitted sending window and free-text market notes. Read it before
        your first send to a new country so your sender, content and send times match the local rules. An unknown code returns
        `404` with `country not found`.'
      operationId: get-coverage
      parameters:
      - name: country
        in: path
        required: true
        description: ISO 3166-1 alpha-2 code of the destination country, for example `US`, `GB` or `IN`. Case-insensitive.
          Three-letter codes and dial codes return `404`.
        schema:
          type: string
        example: US
      responses:
        '200':
          description: The country's coverage record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageDetail'
              example:
                country: IN
                name: India
                region: South-central Asia
                dialCode: '91'
                mcc: '405'
                numberPortability: true
                localVsInternationalTraffic: false
                senders:
                  alphanumeric:
                    local: true
                    international: true
                  shortCode:
                    local: false
                    international: true
                  longNumber:
                    local: false
                    international: true
                registration:
                  required:
                    local: false
                    international: false
                  durationDays: null
                  informationRequired: null
                  documentsRequired: null
                  alphanumericExtraSteps: Register the Principal Entity, the sender header and each content template on a
                    TRAI DLT portal before sending local traffic.
                urls:
                  allowed:
                    local: true
                    international: true
                  whitelistingRequired:
                    local: false
                    international: false
                optOutMandatory: false
                twoWay: true
                prohibitedTopics:
                - Regulatory
                - Other Scams
                - Gambling
                - Explicit Content
                - Phishing
                prohibitedNotes: Gambling - only OTP allowed. Political and adult content is not allowed.
                sendWindow:
                  weekday: 'MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN'
                  saturday: 'SAT: 10:00:00 - 21:00:00; Timezone from MSISDN'
                  sunday: 'SUN: 10:00:00 - 21:00:00; Timezone from MSISDN'
                marketNotes: DLT registration applies to all local SMS traffic types (promotional, transactional and OTP).
                updatedAt: '2026-10-09T09:49:01Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: No coverage record for that code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: country not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.coverage.getCoverage({
              country: "US"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.coverage.get_coverage(
              country="US",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetCoverageRequest{
                  Country: "US",
              }
          c.Sms.Coverage.GetCoverage(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().coverage().getCoverage(
              "US",
              GetCoverageRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.coverage.get_coverage(country: "US")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Coverage.GetCoverageAsync(new GetCoverageRequest { Country = "US" });
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->coverage->getCoverage(
              'US',
          );
  /api/v1/Account/{auth_id}/Sms/Conversation/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Conversations
      summary: List conversations
      description: Returns your conversations, most recently active first (ordered by `lastMessageAt`). A conversation is
        the thread between one of your numbers and one contact on one channel, and Vobiz creates it with the first message
        in either direction. The response is a bare JSON array, `[]` when you have none. Page with `limit` and `offset`; when
        a page returns fewer items than `limit`, you have reached the end.
      operationId: list-conversations
      parameters:
      - name: limit
        in: query
        description: Maximum number of conversations to return, from `1` to `100`. Defaults to `20`; a value outside that
          range also returns `20`.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: offset
        in: query
        description: Number of conversations to skip before the page starts, `0` or greater. Defaults to `0`. Add the page
          size to it to fetch the next page.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of conversations. Empty array when none.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Conversation'
              example:
              - id: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                accountId: MA_XXXXXXXX
                participantA: '+14155550100'
                participantB: '+14155550123'
                channel: sms
                lastMessageAt: '2026-10-16T21:23:51Z'
                messageCount: 3
                unreadCount: 1
                createdAt: '2026-10-16T21:23:02Z'
              - id: 1a9c3e5b-7d2f-4b8a-9c6e-0f4d2b8a6c13
                accountId: MA_XXXXXXXX
                participantA: '+14155550100'
                participantB: '+14155550124'
                channel: sms
                lastMessageAt: '2026-10-16T13:25:41Z'
                messageCount: 2
                unreadCount: 0
                lastReadAt: '2026-10-16T21:24:15Z'
                createdAt: '2026-10-16T13:25:41Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.conversations.listConversations()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.conversations.list_conversations()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListConversationsRequest{}
          c.Sms.Conversations.ListConversations(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().conversations().listConversations(
              ListConversationsRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.conversations.list_conversations
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Conversations.ListConversationsAsync(new ListConversationsRequest());
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->conversations->listConversations(
              new ListConversationsRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Conversation/UnreadCount/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Conversations
      summary: Count unread messages
      description: Returns the total of `unreadCount` across all your conversations. Use it for an inbox badge, then call
        `GET /Conversation/` to see which threads are unread. The total drops when you mark a conversation read with `POST
        /Conversation/{id}/Read/`.
      operationId: unread-count
      responses:
        '200':
          description: The unread total.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnreadCount'
              example:
                totalUnread: 4
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.conversations.unreadCount()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.conversations.unread_count()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Conversations.UnreadCount(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().conversations().unreadCount();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.conversations.unread_count
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Conversations.UnreadCountAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->conversations->unreadCount();
  /api/v1/Account/{auth_id}/Sms/Conversation/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Conversations
      summary: Retrieve a conversation
      description: Returns one conversation with its participants, channel and counters. Use it to refresh a thread's `unreadCount`
        or `lastMessageAt` after a new message arrives. To read the messages themselves, call `GET /Conversation/{id}/Message/`.
      operationId: get-conversation
      parameters:
      - name: id
        in: path
        required: true
        description: The conversation `id` (UUID), from `GET /Conversation/` or the `conversationId` on any message.
        schema:
          type: string
          format: uuid
        example: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
      responses:
        '200':
          description: The conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
              example:
                id: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                accountId: MA_XXXXXXXX
                participantA: '+14155550100'
                participantB: '+14155550123'
                channel: sms
                lastMessageAt: '2026-10-16T21:23:51Z'
                messageCount: 3
                unreadCount: 1
                createdAt: '2026-10-16T21:23:02Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The conversation wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: conversation not found
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.conversations.getConversation({
              id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.conversations.get_conversation(
              id="c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetConversationRequest{
                  ID: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              }
          c.Sms.Conversations.GetConversation(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().conversations().getConversation(
              "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              GetConversationRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.conversations.get_conversation(id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Conversations.GetConversationAsync(
              new GetConversationRequest { Id = "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->conversations->getConversation(
              'c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04',
          );
  /api/v1/Account/{auth_id}/Sms/Conversation/{id}/Message/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Conversations
      summary: List conversation messages
      description: 'Returns the messages in one conversation, in both directions, newest first. Use it to render a chat thread:
        reverse the page to show it oldest to newest. The response is a bare JSON array of message objects without `statusHistory`;
        call `GET /Message/{id}/` for one message''s history. Page with `limit` and `offset`. An empty page has no items.'
      operationId: list-conversation-messages
      parameters:
      - name: id
        in: path
        required: true
        description: The conversation `id` (UUID), from `GET /Conversation/` or the `conversationId` on any message.
        schema:
          type: string
          format: uuid
        example: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
      - name: limit
        in: query
        description: Maximum number of messages to return, from `1` to `100`. Defaults to `50`; a value outside that range
          also returns `50`.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
      - name: offset
        in: query
        description: Number of messages to skip before the page starts, `0` or greater. Defaults to `0`. Add the page size
          to it to load older messages.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of messages.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Message'
              example:
              - id: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
                accountId: MA_XXXXXXXX
                direction: out
                channel: sms
                from: '+14155550100'
                to: '+14155550123'
                text: Your appointment is confirmed for 3pm tomorrow.
                mediaUrls: null
                status: delivered
                conversationId: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                createdAt: '2026-10-16T21:23:02Z'
                updatedAt: '2026-10-16T21:23:09Z'
              - id: 2e7f4b91-6c3d-4a8e-b5f1-9d0c7a2e3b64
                accountId: MA_XXXXXXXX
                direction: in
                channel: sms
                from: '+14155550123'
                to: '+14155550100'
                text: Thanks, see you then.
                mediaUrls: null
                status: received
                conversationId: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
                createdAt: '2026-10-16T21:23:51Z'
                updatedAt: '2026-10-16T21:23:51Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.conversations.listConversationMessages({
              id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.conversations.list_conversation_messages(
              id="c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListConversationMessagesRequest{
                  ID: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              }
          c.Sms.Conversations.ListConversationMessages(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().conversations().listConversationMessages(
              "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              ListConversationMessagesRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.conversations.list_conversation_messages(id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Conversations.ListConversationMessagesAsync(
              new ListConversationMessagesRequest { Id = "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->conversations->listConversationMessages(
              'c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04',
              new ListConversationMessagesRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Conversation/{id}/Read/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Conversations
      summary: Mark a conversation read
      description: 'Marks a conversation as read: it sets `unreadCount` to `0` and `lastReadAt` to the current time. Call
        it when a user opens the thread in your inbox. It takes no request body, and calling it on a thread that is already
        read is harmless. The account-wide total from `GET /Conversation/UnreadCount/` drops by the thread''s previous `unreadCount`.'
      operationId: mark-conversation-read
      parameters:
      - name: id
        in: path
        required: true
        description: The conversation `id` (UUID) to mark as read.
        schema:
          type: string
          format: uuid
        example: c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04
      responses:
        '200':
          description: Marked read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The conversation wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: conversation not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.conversations.markConversationRead({
              id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.conversations.mark_conversation_read(
              id="c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.MarkConversationReadRequest{
                  ID: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              }
          c.Sms.Conversations.MarkConversationRead(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().conversations().markConversationRead(
              "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
              MarkConversationReadRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.conversations.mark_conversation_read(id: "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Conversations.MarkConversationReadAsync(
              new MarkConversationReadRequest { Id = "c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->conversations->markConversationRead(
              'c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04',
          );
  /api/v1/Account/{auth_id}/Sms/OptOut/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Opt-outs
      summary: Create an opt-out
      description: Adds a phone number to your opt-out list for one channel, so Vobiz stops messages to it. After this, `POST
        /Message/` to that number on that channel returns `422` and broadcasts skip it. An `sms` opt-out also blocks `mms`.
        Use it to record consent withdrawn outside a keyword reply, for example on a call or a web form. Creating the same
        number and channel again updates the stored `reason` instead of adding a second record.
      operationId: create-opt-out
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOptOutRequest'
            example:
              phoneNumber: '+14155550123'
              channel: sms
              reason: customer request
      responses:
        '201':
          description: The opt-out is recorded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '400':
          description: '`phoneNumber` is missing or the body is not valid JSON.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missing:
                  value:
                    error: phoneNumber is required
                body:
                  value:
                    error: invalid request body
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.optOuts.createOptOut({
              phoneNumber: "+14155550123",
              channel: "sms",
              reason: "customer request"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.opt_outs.create_opt_out(
              phone_number="+14155550123",
              channel="sms",
              reason="customer request",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateOptOutRequest{
                  PhoneNumber: "+14155550123",
                  Channel: vobiz.String(
                      "sms",
                  ),
                  Reason: vobiz.String(
                      "customer request",
                  ),
              }
          c.Sms.OptOuts.CreateOptOut(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().optOuts().createOptOut(
              CreateOptOutRequest
                  .builder()
                  .phoneNumber("+14155550123")
                  .channel("sms")
                  .reason("customer request")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.opt_outs.create_opt_out(
            phone_number: "+14155550123",
            channel: "sms",
            reason: "customer request"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.OptOuts.CreateOptOutAsync(
              new CreateOptOutRequest
              {
                  PhoneNumber = "+14155550123",
                  Channel = "sms",
                  Reason = "customer request",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->optOuts->createOptOut(
              new CreateOptOutRequest([
                  'phoneNumber' => '+14155550123',
                  'channel' => 'sms',
                  'reason' => 'customer request',
              ]),
          );
    get:
      tags:
      - Opt-outs
      summary: List opt-outs
      description: 'Returns the numbers on your opt-out list, newest first, including entries created from keyword replies
        such as STOP and the ones you added. Send `limit` with every call; the response is a JSON array of up to `limit` records.
        Page by increasing `offset` until a page returns fewer items than `limit`. An empty page has no items (`null`). To
        check a single number, use `GET /OptOut/{phoneNumber}/` instead.'
      operationId: list-opt-outs
      parameters:
      - name: limit
        in: query
        required: true
        description: Maximum number of opt-outs to return, `1` or greater, for example `100`.
        schema:
          type: integer
          minimum: 1
        example: 50
      - name: offset
        in: query
        description: Number of records to skip before the page starts. Defaults to `0`; add `limit` for each following page.
        schema:
          type: integer
          minimum: 0
          default: 0
        example: 0
      responses:
        '200':
          description: A page of opt-outs. An empty page has no items.
          content:
            application/json:
              schema:
                type: array
                nullable: true
                items:
                  $ref: '#/components/schemas/OptOut'
              example:
              - id: 4e8b2d61-7c3a-4f9e-a1d5-9b6c0e2f8a37
                accountId: MA_XXXXXXXX
                phoneNumber: '+14155550123'
                channel: sms
                reason: manual
                source: manual
                syncedToProvider: true
                createdAt: '2026-10-18T07:23:03Z'
              - id: 7b1d9f3e-2a6c-4e5b-8d0f-3c9a1e7b5d26
                accountId: MA_XXXXXXXX
                phoneNumber: '+14155550124'
                channel: sms
                reason: stop
                source: inbound
                syncedToProvider: false
                createdAt: '2026-10-17T19:04:40Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.optOuts.listOptOuts({
              limit: 1,
              offset: 1
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.opt_outs.list_opt_outs(
              limit=1,
              offset=1,
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListOptOutsRequest{
                  Limit: 1,
                  Offset: 1,
              }
          c.Sms.OptOuts.ListOptOuts(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().optOuts().listOptOuts(
              ListOptOutsRequest
                  .builder()
                  .limit(1)
                  .offset(1)
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.opt_outs.list_opt_outs(
            limit: 1,
            offset: 1
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.OptOuts.ListOptOutsAsync(new ListOptOutsRequest { Limit = 1, Offset = 1 });
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->optOuts->listOptOuts(
              new ListOptOutsRequest([
                  'limit' => 1,
                  'offset' => 1,
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/OptOut/{phoneNumber}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Opt-outs
      summary: Check an opt-out
      description: Tells you whether a phone number is on your opt-out list for a channel. Call it before a send to skip a
        blocked contact instead of handling a `422` from `POST /Message/`. The response is always `200` with `optedOut` set
        to `true` or `false`.
      operationId: check-opt-out
      parameters:
      - name: phoneNumber
        in: path
        required: true
        description: The number in E.164 format, for example `+14155550123`. In raw HTTP requests, URL-encode the `+` as `%2B`
          (`/OptOut/%2B14155550123/`); the SDKs encode it for you.
        schema:
          type: string
        example: '+14155550123'
      - name: channel
        in: query
        description: 'Channel to check: `sms`, `mms` or `rcs`. Defaults to `sms`.'
        schema:
          type: string
          default: sms
        example: sms
      responses:
        '200':
          description: The opt-out state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptOutCheck'
              example:
                optedOut: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.optOuts.checkOptOut({
              phoneNumber: "+14155550123",
              channel: "sms"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.opt_outs.check_opt_out(
              phone_number="+14155550123",
              channel="sms",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CheckOptOutRequest{
                  PhoneNumber: "+14155550123",
                  Channel: vobiz.String(
                      "sms",
                  ),
              }
          c.Sms.OptOuts.CheckOptOut(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().optOuts().checkOptOut(
              "+14155550123",
              CheckOptOutRequest
                  .builder()
                  .channel("sms")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.opt_outs.check_opt_out(
            phone_number: "+14155550123",
            channel: "sms"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.OptOuts.CheckOptOutAsync(
              new CheckOptOutRequest { PhoneNumber = "+14155550123", Channel = "sms" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->optOuts->checkOptOut(
              '+14155550123',
              new CheckOptOutRequest([
                  'channel' => 'sms',
              ]),
          );
    delete:
      tags:
      - Opt-outs
      summary: Delete an opt-out
      description: Removes a phone number from your opt-out list for one channel, so you can message it again on that channel.
        Do this only after the contact has given consent again, for example after they opt back in. The response is `200`
        whether or not a record existed, so it is safe to retry. Removing an opt-out on one channel leaves entries on other
        channels in place; delete each one separately.
      operationId: delete-opt-out
      parameters:
      - name: phoneNumber
        in: path
        required: true
        description: The number in E.164 format, for example `+14155550123`. In raw HTTP requests, URL-encode the `+` as `%2B`
          (`/OptOut/%2B14155550123/`); the SDKs encode it for you.
        schema:
          type: string
        example: '+14155550123'
      - name: channel
        in: query
        description: 'Channel to remove the opt-out from: `sms`, `mms` or `rcs`. Defaults to `sms`.'
        schema:
          type: string
          default: sms
        example: sms
      responses:
        '200':
          description: The number is unblocked on that channel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.optOuts.deleteOptOut({
              phoneNumber: "+14155550123",
              channel: "sms"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.opt_outs.delete_opt_out(
              phone_number="+14155550123",
              channel="sms",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteOptOutRequest{
                  PhoneNumber: "+14155550123",
                  Channel: vobiz.String(
                      "sms",
                  ),
              }
          c.Sms.OptOuts.DeleteOptOut(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().optOuts().deleteOptOut(
              "+14155550123",
              DeleteOptOutRequest
                  .builder()
                  .channel("sms")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.opt_outs.delete_opt_out(
            phone_number: "+14155550123",
            channel: "sms"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.OptOuts.DeleteOptOutAsync(
              new DeleteOptOutRequest { PhoneNumber = "+14155550123", Channel = "sms" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->optOuts->deleteOptOut(
              '+14155550123',
              new DeleteOptOutRequest([
                  'channel' => 'sms',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/Webhook/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Webhooks
      summary: Create a webhook
      description: Registers an HTTPS endpoint that receives the events you subscribe to as signed `POST` requests. Only `url`
        is required; omit `events` to subscribe to `message.received`, `message.delivered` and `message.failed`. Every delivery
        carries `X-Webhook-ID`, `X-Webhook-Event` and `X-Webhook-Signature`, a lower-case hex HMAC-SHA256 of the raw body
        keyed with your `secret`. The subscription is active as soon as it is created; see the Webhooks guide for the payload
        envelope and a verification example.
      operationId: create-webhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              url: https://example.com/vobiz/webhooks
              secret: YOUR_WEBHOOK_SECRET
              events:
              - message.received
              - message.delivered
              - message.failed
      responses:
        '201':
          description: The subscription, active immediately. Call `GET /Webhook/{id}/` to read the stored `createdAt` time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
              example:
                id: 8d4f2a6b-3e1c-4b9a-a7d2-5c8e1f0b6a93
                accountId: MA_XXXXXXXX
                url: https://example.com/vobiz/webhooks
                secret: YOUR_WEBHOOK_SECRET
                events:
                - message.received
                - message.delivered
                - message.failed
                active: true
                createdAt: '2026-10-18T07:22:11Z'
        '400':
          description: '`url` is missing or the body is not valid JSON.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                url:
                  value:
                    error: url is required
                body:
                  value:
                    error: invalid request body
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.webhooks.createWebhook({
              url: "https://example.com/vobiz/webhooks",
              secret: "YOUR_WEBHOOK_SECRET",
              events: ["message.received", "message.delivered", "message.failed"]
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.webhooks.create_webhook(
              url="https://example.com/vobiz/webhooks",
              secret="YOUR_WEBHOOK_SECRET",
              events=[
                  "message.received",
                  "message.delivered",
                  "message.failed"
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateWebhookRequest{
                  URL: "https://example.com/vobiz/webhooks",
                  Secret: vobiz.String(
                      "YOUR_WEBHOOK_SECRET",
                  ),
                  Events: []sms.WebhookEvent{
                      sms.WebhookEventMessageReceived,
                      sms.WebhookEventMessageDelivered,
                      sms.WebhookEventMessageFailed,
                  },
              }
          c.Sms.Webhooks.CreateWebhook(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().webhooks().createWebhook(
              CreateWebhookRequest
                  .builder()
                  .url("https://example.com/vobiz/webhooks")
                  .secret("YOUR_WEBHOOK_SECRET")
                  .events(
                      Optional.of(
                          Arrays.asList(WebhookEvent.MESSAGE_RECEIVED, WebhookEvent.MESSAGE_DELIVERED, WebhookEvent.MESSAGE_FAILED)
                      )
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.webhooks.create_webhook(
            url: "https://example.com/vobiz/webhooks",
            secret: "YOUR_WEBHOOK_SECRET",
            events: %w[message.received message.delivered message.failed]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Webhooks.CreateWebhookAsync(
              new CreateWebhookRequest
              {
                  Url = "https://example.com/vobiz/webhooks",
                  Secret = "YOUR_WEBHOOK_SECRET",
                  Events = new List<WebhookEvent>()
                  {
                      WebhookEvent.MessageReceived,
                      WebhookEvent.MessageDelivered,
                      WebhookEvent.MessageFailed,
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->webhooks->createWebhook(
              new CreateWebhookRequest([
                  'url' => 'https://example.com/vobiz/webhooks',
                  'secret' => 'YOUR_WEBHOOK_SECRET',
                  'events' => [
                      WebhookEvent::MessageReceived->value,
                      WebhookEvent::MessageDelivered->value,
                      WebhookEvent::MessageFailed->value,
                  ],
              ]),
          );
    get:
      tags:
      - Webhooks
      summary: List webhooks
      description: Returns all of your webhook subscriptions, newest first, as a JSON array. An account with no subscriptions
        returns an empty body (`null`); treat it as an empty list. The response includes each subscription's `secret`, so keep
        it out of logs and client-side code.
      operationId: list-webhooks
      responses:
        '200':
          description: Your subscriptions. An empty result has no items.
          content:
            application/json:
              schema:
                type: array
                nullable: true
                items:
                  $ref: '#/components/schemas/WebhookSubscription'
              example:
              - id: 8d4f2a6b-3e1c-4b9a-a7d2-5c8e1f0b6a93
                accountId: MA_XXXXXXXX
                url: https://example.com/vobiz/webhooks
                secret: YOUR_WEBHOOK_SECRET
                events:
                - message.received
                - message.delivered
                - message.failed
                active: true
                createdAt: '2026-10-18T07:22:11Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.webhooks.listWebhooks()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.webhooks.list_webhooks()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Webhooks.ListWebhooks(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().webhooks().listWebhooks();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.webhooks.list_webhooks
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Webhooks.ListWebhooksAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->webhooks->listWebhooks();
  /api/v1/Account/{auth_id}/Sms/Webhook/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Webhooks
      summary: Retrieve a webhook
      description: Returns one webhook subscription with its URL, events, `active` flag and signing secret. Use it to confirm
        the result of an update, since `PUT /Webhook/{id}/` returns only `{"status":"ok"}`.
      operationId: get-webhook
      parameters:
      - name: id
        in: path
        required: true
        description: The subscription `id` (UUID) returned when you created it or by `GET /Webhook/`.
        schema:
          type: string
          format: uuid
        example: 2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e
      responses:
        '200':
          description: The subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
              example:
                id: 8d4f2a6b-3e1c-4b9a-a7d2-5c8e1f0b6a93
                accountId: MA_XXXXXXXX
                url: https://example.com/vobiz/webhooks
                secret: YOUR_WEBHOOK_SECRET
                events:
                - message.received
                - message.delivered
                - message.failed
                active: true
                createdAt: '2026-10-18T07:22:11Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The webhook wasn't found on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: subscription not found
        '500':
          description: The request couldn't be completed. Check that `id` is a subscription `id` returned by `GET /Webhook/`,
            then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: internal error
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.webhooks.getWebhook({
              id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.webhooks.get_webhook(
              id="2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetWebhookRequest{
                  ID: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              }
          c.Sms.Webhooks.GetWebhook(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().webhooks().getWebhook(
              "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              GetWebhookRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.webhooks.get_webhook(id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Webhooks.GetWebhookAsync(
              new GetWebhookRequest { Id = "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->webhooks->getWebhook(
              '2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e',
          );
    put:
      tags:
      - Webhooks
      summary: Update a webhook
      description: Changes any subset of `url`, `secret`, `events` and `active`. Fields you omit keep their current value;
        a field you send, including an empty string, replaces it. Set `active` to `false` to pause deliveries without losing
        the subscription, and back to `true` to resume. The response is `{"status":"ok"}`, so call `GET /Webhook/{id}/` to
        read the updated subscription.
      operationId: update-webhook
      parameters:
      - name: id
        in: path
        required: true
        description: The subscription `id` (UUID) to change.
        schema:
          type: string
          format: uuid
        example: 2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookRequest'
            examples:
              events:
                summary: Change the events
                value:
                  events:
                  - message.delivered
                  - message.failed
              pause:
                summary: Pause deliveries
                value:
                  active: false
              rotate:
                summary: Rotate the secret and move the endpoint
                value:
                  url: https://example.com/vobiz/webhooks-v2
                  secret: YOUR_NEW_WEBHOOK_SECRET
      responses:
        '200':
          description: Updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The webhook wasn't found on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: subscription not found
        '500':
          description: The request couldn't be completed. Check that `id` is a subscription `id` returned by `GET /Webhook/`,
            then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: internal error
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.webhooks.updateWebhook({
              id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              events: ["message.delivered", "message.failed"]
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.webhooks.update_webhook(
              id="2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              events=[
                  "message.delivered",
                  "message.failed"
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateWebhookRequest{
                  ID: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
                  Events: []sms.WebhookEvent{
                      sms.WebhookEventMessageDelivered,
                      sms.WebhookEventMessageFailed,
                  },
              }
          c.Sms.Webhooks.UpdateWebhook(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().webhooks().updateWebhook(
              "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              UpdateWebhookRequest
                  .builder()
                  .events(
                      Optional.of(
                          Arrays.asList(WebhookEvent.MESSAGE_DELIVERED, WebhookEvent.MESSAGE_FAILED)
                      )
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.webhooks.update_webhook(
            id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
            events: %w[message.delivered message.failed]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Webhooks.UpdateWebhookAsync(
              new UpdateWebhookRequest
              {
                  Id = "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
                  Events = new List<WebhookEvent>()
                  {
                      WebhookEvent.MessageDelivered,
                      WebhookEvent.MessageFailed,
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->webhooks->updateWebhook(
              '2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e',
              new UpdateWebhookRequest([
                  'events' => [
                      WebhookEvent::MessageDelivered->value,
                      WebhookEvent::MessageFailed->value,
                  ],
              ]),
          );
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook
      description: Removes the subscription and stops all deliveries to its URL. The response is `200` with `{"status":"ok"}`.
        To stop deliveries temporarily and keep the configuration, set `active` to `false` with `PUT /Webhook/{id}/` instead.
      operationId: delete-webhook
      parameters:
      - name: id
        in: path
        required: true
        description: The subscription `id` (UUID) to delete.
        schema:
          type: string
          format: uuid
        example: 2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e
      responses:
        '200':
          description: Deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The webhook wasn't found on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: subscription not found
        '500':
          description: The request couldn't be completed. Check that `id` is a subscription `id` returned by `GET /Webhook/`,
            then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: internal error
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.webhooks.deleteWebhook({
              id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.webhooks.delete_webhook(
              id="2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteWebhookRequest{
                  ID: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              }
          c.Sms.Webhooks.DeleteWebhook(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().webhooks().deleteWebhook(
              "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
              DeleteWebhookRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.webhooks.delete_webhook(id: "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Webhooks.DeleteWebhookAsync(
              new DeleteWebhookRequest { Id = "2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->webhooks->deleteWebhook(
              '2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Broadcasts
      summary: Create a broadcast
      description: Creates a broadcast in `draft` status with zero `stats` and no recipients. Only `name` and `from` are required;
        `channel` defaults to `sms` and `ratePerSecond` to 5. Nothing is sent when you create a broadcast. Next, upload recipients
        with `POST /Broadcast/{id}/Recipient/`, check the rendered text with `GET /Broadcast/{id}/Preview/`, then start sending
        with `POST /Broadcast/{id}/Launch/`.
      operationId: create-broadcast
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BroadcastInput'
            examples:
              basic:
                summary: Template with variables
                value:
                  name: October pricing update
                  from: '+14155550100'
                  template: Hi {{name}}, your refund of {{amount}} is on its way.
                  ratePerSecond: 5
                  tag: pricing-oct
              scheduled:
                summary: Scheduled start
                value:
                  name: Weekend reminder
                  from: '+14155550100'
                  template: Hi {{name}}, your appointment is tomorrow at {{time}}.
                  scheduledAt: '2026-10-15T09:00:00Z'
              india:
                summary: India with DLT IDs
                value:
                  name: OTP reminder
                  from: '+919876543210'
                  template: Your OTP is {{otp}}.
                  dltEntityId: '1001234567890123456'
                  dltHeaderId: '1001234567'
                  dltTemplateId: '10012345678901234567'
      responses:
        '201':
          description: The new draft broadcast with zero stats.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: draft
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns: []
                stats:
                  total: 0
                  pending: 0
                  sent: 0
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
                startedAt: null
                completedAt: null
        '400':
          description: A field is missing or invalid. The `error` names the field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                body:
                  value:
                    error: invalid request body
                name:
                  value:
                    error: name is required
                nameLength:
                  value:
                    error: name is too long (255 characters max)
                from:
                  value:
                    error: from is required
                fromFormat:
                  value:
                    error: from must be a phone number or a sender ID (up to 11 letters and digits)
                channel:
                  value:
                    error: channel must be sms
                scheduledAt:
                  value:
                    error: scheduledAt must be an RFC 3339 timestamp
                rate:
                  value:
                    error: ratePerSecond must be between 1 and 50
                rateType:
                  value:
                    error: ratePerSecond must be an integer
                type:
                  value:
                    error: template must be a string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.createBroadcast({
              name: "October pricing update",
              from: "+14155550100",
              template: "Hi {{name}}, your refund of {{amount}} is on its way.",
              ratePerSecond: 5,
              tag: "pricing-oct"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.create_broadcast(
              name="October pricing update",
              from_="+14155550100",
              template="Hi {{name}}, your refund of {{amount}} is on its way.",
              rate_per_second=5,
              tag="pricing-oct",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.BroadcastInput{
                  Name: vobiz.String(
                      "October pricing update",
                  ),
                  From: vobiz.String(
                      "+14155550100",
                  ),
                  Template: vobiz.String(
                      "Hi {{name}}, your refund of {{amount}} is on its way.",
                  ),
                  RatePerSecond: vobiz.Int(
                      5,
                  ),
                  Tag: vobiz.String(
                      "pricing-oct",
                  ),
              }
          c.Sms.Broadcasts.CreateBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().createBroadcast(
              BroadcastInput
                  .builder()
                  .name("October pricing update")
                  .from("+14155550100")
                  .template("Hi {{name}}, your refund of {{amount}} is on its way.")
                  .ratePerSecond(5)
                  .tag("pricing-oct")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.create_broadcast(
            name: "October pricing update",
            from: "+14155550100",
            template: "Hi {{name}}, your refund of {{amount}} is on its way.",
            rate_per_second: 5,
            tag: "pricing-oct"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.CreateBroadcastAsync(
              new BroadcastInput
              {
                  Name = "October pricing update",
                  From = "+14155550100",
                  Template = "Hi {{name}}, your refund of {{amount}} is on its way.",
                  RatePerSecond = 5,
                  Tag = "pricing-oct",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->createBroadcast(
              new BroadcastInput([
                  'name' => 'October pricing update',
                  'from' => '+14155550100',
                  'template' => 'Hi {{name}}, your refund of {{amount}} is on its way.',
                  'ratePerSecond' => 5,
                  'tag' => 'pricing-oct',
              ]),
          );
    get:
      tags:
      - Broadcasts
      summary: List broadcasts
      description: Returns the broadcasts on your account, newest first, each with freshly counted `stats`. The response wraps
        the page in `broadcasts` and gives the account-wide count in `total`, so you can page with `limit` and `offset` until
        `offset` reaches `total`.
      operationId: list-broadcasts
      parameters:
      - name: limit
        in: query
        description: Maximum number of broadcasts to return, from 1 to 500. Defaults to 50 when you omit it or pass `0`. A
          value above 500 returns `400` with `limit must be between 1 and 500`, and a non-integer returns `400` with `limit
          must be an integer`.
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 50
      - name: offset
        in: query
        description: Number of broadcasts to skip before the page starts, for paging through results with `limit`. Defaults
          to `0`. A negative value returns `400` with `offset must be >= 0`, and a non-integer returns `400` with `offset
          must be an integer`.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of broadcasts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastList'
              example:
                broadcasts:
                - id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                  accountId: MA_XXXXXXXX
                  name: October pricing update
                  from: '+14155550100'
                  channel: sms
                  template: Hi {{name}}, your refund of {{amount}} is on its way.
                  status: completed
                  scheduledAt: null
                  ratePerSecond: 5
                  tag: pricing-oct
                  dltEntityId: ''
                  dltHeaderId: ''
                  dltTemplateId: ''
                  columns:
                  - phone
                  - name
                  - amount
                  stats:
                    total: 3
                    pending: 0
                    sent: 3
                    delivered: 0
                    failed: 0
                    optedOut: 0
                    skipped: 0
                  createdAt: '2026-10-12T10:30:00Z'
                  updatedAt: '2026-10-12T11:05:12Z'
                  startedAt: '2026-10-12T11:05:10Z'
                  completedAt: '2026-10-12T11:05:12Z'
                total: 1
        '400':
          description: '`limit` or `offset` is out of range or not an integer.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                limit:
                  value:
                    error: limit must be between 1 and 500
                offset:
                  value:
                    error: offset must be >= 0
                type:
                  value:
                    error: limit must be an integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.listBroadcasts()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.list_broadcasts()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListBroadcastsRequest{}
          c.Sms.Broadcasts.ListBroadcasts(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().listBroadcasts(
              ListBroadcastsRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.list_broadcasts
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.ListBroadcastsAsync(new ListBroadcastsRequest());
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->listBroadcasts(
              new ListBroadcastsRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    - name: id
      in: path
      required: true
      description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
        a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
      schema:
        type: string
        format: uuid
      example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
    get:
      tags:
      - Broadcasts
      summary: Retrieve a broadcast
      description: Returns one broadcast with its configuration, current `status` and freshly counted `stats`. Poll it while
        a broadcast runs to follow progress, or subscribe to the `broadcast.updated` WebSocket event. For per-recipient results,
        use `GET /Broadcast/{id}/Recipient/` or `GET /Broadcast/{id}/Export/`.
      operationId: get-broadcast
      responses:
        '200':
          description: The broadcast.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: running
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 1
                  sent: 2
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:05:11Z'
                startedAt: '2026-10-12T11:05:10Z'
                completedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account, or `id` is not a UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.getBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.get_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.GetBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().getBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              GetBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.get_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.GetBroadcastAsync(
              new GetBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->getBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
    put:
      tags:
      - Broadcasts
      summary: Update a broadcast
      description: Changes a `draft` broadcast. Send only the fields you want to change; fields you leave out, or send as
        `null`, keep their value, except `scheduledAt`, where `null` or `""` clears a scheduled start. The same validation
        as create applies, so `name` and `from` cannot be set to an empty string. A broadcast in any other status returns
        `409` with `cannot edit a broadcast that is <status>`.
      operationId: update-broadcast
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BroadcastUpdateInput'
            examples:
              template:
                summary: Change the template
                value:
                  template: Hi {{name}}, your refund of {{amount}} has been issued.
              clearSchedule:
                summary: Clear a scheduled start
                value:
                  scheduledAt: null
      responses:
        '200':
          description: The updated broadcast.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} has been issued.
                status: draft
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 3
                  sent: 0
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:42:00Z'
                startedAt: null
                completedAt: null
        '400':
          description: A field is invalid. Same messages as `POST /Broadcast/`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: ratePerSecond must be between 1 and 50
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is no longer a draft.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot edit a broadcast that is running
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.updateBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              body: {
                  template: "Hi {{name}}, your refund of {{amount}} has been issued."
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.update_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              template="Hi {{name}}, your refund of {{amount}} has been issued.",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
                  Body: &sms.BroadcastUpdateInput{
                      Template: vobiz.String(
                          "Hi {{name}}, your refund of {{amount}} has been issued.",
                      ),
                  },
              }
          c.Sms.Broadcasts.UpdateBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().updateBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              UpdateBroadcastRequest
                  .builder()
                  .body(
                      BroadcastUpdateInput
                          .builder()
                          .template("Hi {{name}}, your refund of {{amount}} has been issued.")
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.update_broadcast(
            id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
            template: "Hi {{name}}, your refund of {{amount}} has been issued."
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.UpdateBroadcastAsync(
              new UpdateBroadcastRequest
              {
                  Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
                  Body = new BroadcastUpdateInput
                  {
                      Template = "Hi {{name}}, your refund of {{amount}} has been issued.",
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->updateBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
              new UpdateBroadcastRequest([
                  'body' => new BroadcastUpdateInput([
                      'template' => 'Hi {{name}}, your refund of {{amount}} has been issued.',
                  ]),
              ]),
          );
    delete:
      tags:
      - Broadcasts
      summary: Delete a broadcast
      description: Permanently removes a `draft` or `cancelled` broadcast together with its recipient list and returns `204`
        with no body. Any other status returns `409` with `cannot delete a broadcast that is <status>`, so cancel a scheduled,
        running or paused broadcast first. Completed broadcasts are kept as your sending record.
      operationId: delete-broadcast
      responses:
        '204':
          description: Deleted. No body.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is scheduled, running, paused, completed or failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot delete a broadcast that is running
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.deleteBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.delete_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.DeleteBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().deleteBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              DeleteBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.delete_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.DeleteBroadcastAsync(
              new DeleteBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->deleteBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Recipient/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    - name: id
      in: path
      required: true
      description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
        a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
      schema:
        type: string
        format: uuid
      example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
    post:
      tags:
      - Broadcasts
      summary: Upload recipients
      description: Sets the recipient list of a `draft` broadcast; each upload replaces the previous list. Send `multipart/form-data`
        with a `.csv` or `.xlsx` `file` (10 MB maximum) to use template variables from extra columns, or JSON with a `numbers`
        array for a plain list. Numbers without a country code are normalised to E.164 with `defaultCountry` (default `US`).
        Duplicates are dropped, invalid rows are reported in `invalid`, and numbers that opted out of SMS from you are kept
        with status `opted_out` and are not sent. A broadcast can hold up to 10,000 recipients; a larger list returns `422`.
      operationId: upload-recipients
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadRecipientsFile'
            encoding:
              file:
                contentType: text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
          application/json:
            schema:
              $ref: '#/components/schemas/UploadRecipientsJSON'
            example:
              numbers:
              - '+14155550123'
              - '+14155550124'
              - 415 555 0125
              defaultCountry: US
      responses:
        '200':
          description: Upload summary. The broadcast's `columns` and `stats` are updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadResult'
              example:
                total: 5
                valid: 3
                invalid:
                - row: 4
                  value: abc
                  reason: contains letters or symbols
                invalidCount: 1
                duplicates: 1
                optedOut: 0
                columns:
                - phone
                - name
                - amount
        '400':
          description: The body or file is not usable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                noFile:
                  value:
                    error: multipart field "file" is required
                noNumbers:
                  value:
                    error: numbers is required
                body:
                  value:
                    error: 'body must be multipart with a "file" field, or JSON {"numbers": [...]}'
                extension:
                  value:
                    error: file must be .csv or .xlsx
                unreadable:
                  value:
                    error: 'could not read the file: check it is a valid CSV or XLSX'
                country:
                  value:
                    error: defaultCountry must be a supported ISO 3166-1 alpha-2 code
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is no longer a draft.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot change the recipients of a broadcast that is running
        '413':
          description: The file is larger than 10 MB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: file is larger than 10MB
        '422':
          description: The upload has more recipients than a broadcast can hold.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'too many recipients: the limit is 10000 per broadcast'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.uploadRecipients({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              numbers: ["+14155550123", "+14155550124", "415 555 0125"],
              defaultCountry: "US"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.upload_recipients(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              numbers=[
                  "+14155550123",
                  "+14155550124",
                  "415 555 0125"
              ],
              default_country="US",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UploadRecipientsJSON{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
                  Numbers: []string{
                      "+14155550123",
                      "+14155550124",
                      "415 555 0125",
                  },
                  DefaultCountry: sms.UploadRecipientsJSONDefaultCountryUs.Ptr(),
              }
          c.Sms.Broadcasts.UploadRecipients(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().uploadRecipients(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              UploadRecipientsJson
                  .builder()
                  .numbers(
                      Arrays.asList("+14155550123", "+14155550124", "415 555 0125")
                  )
                  .defaultCountry(UploadRecipientsJsonDefaultCountry.US)
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.upload_recipients(
            id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
            numbers: ["+14155550123", "+14155550124", "415 555 0125"],
            default_country: "US"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.UploadRecipientsAsync(
              new UploadRecipientsJson
              {
                  Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
                  Numbers = new List<string>() { "+14155550123", "+14155550124", "415 555 0125" },
                  DefaultCountry = UploadRecipientsJsonDefaultCountry.Us,
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->uploadRecipients(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
              new UploadRecipientsJson([
                  'numbers' => [
                      '+14155550123',
                      '+14155550124',
                      '415 555 0125',
                  ],
                  'defaultCountry' => UploadRecipientsJsonDefaultCountry::Us->value,
              ]),
          );
    get:
      tags:
      - Broadcasts
      summary: List recipients
      description: Returns the broadcast's recipients in upload order, each with its template `variables` and per-recipient
        send state. Filter by `status` to find failures, opted-out numbers or rows still waiting to send. The response gives
        the page in `recipients` and the count matching your filter in `total`. For a downloadable file of the same data,
        use `GET /Broadcast/{id}/Export/`.
      operationId: list-recipients
      parameters:
      - name: status
        in: query
        description: Return only recipients in this state, matched case-insensitively. `pending` waits to send, `sending`
          is in progress, `sent` and `delivered` track the message, `failed` has an `errorCode`, `opted_out` was excluded
          because the number opted out, and `skipped` was still pending when the broadcast was cancelled. Omit it to return
          every recipient; any other value returns `400`.
        schema:
          type: string
          enum:
          - pending
          - sending
          - sent
          - delivered
          - failed
          - opted_out
          - skipped
      - name: limit
        in: query
        description: Maximum number of recipients to return, from 1 to 500. Defaults to 50 when you omit it or pass `0`. A
          value above 500 returns `400` with `limit must be between 1 and 500`, and a non-integer returns `400` with `limit
          must be an integer`.
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 50
      - name: offset
        in: query
        description: Number of recipients to skip before the page starts, for paging through results with `limit`. Defaults
          to `0`. A negative value returns `400` with `offset must be >= 0`, and a non-integer returns `400` with `offset
          must be an integer`.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of recipients.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastRecipientList'
              example:
                recipients:
                - id: 1042
                  row: 2
                  to: '+14155550123'
                  variables:
                    phone: '+14155550123'
                    name: Priya
                    amount: $42.00
                  status: sent
                  messageId: 9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01
                  errorCode: ''
                  errorMessage: ''
                  sentAt: '2026-10-12T11:05:10Z'
                - id: 1043
                  row: 3
                  to: '+14155550124'
                  variables:
                    phone: '+14155550124'
                    name: Sam
                    amount: $18.50
                  status: pending
                  messageId: ''
                  errorCode: ''
                  errorMessage: ''
                  sentAt: null
                total: 2
        '400':
          description: '`status`, `limit` or `offset` is invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                status:
                  value:
                    error: status must be one of pending, sending, sent, delivered, failed, opted_out, skipped
                limit:
                  value:
                    error: limit must be between 1 and 500
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.listRecipients({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.list_recipients(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListRecipientsRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.ListRecipients(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().listRecipients(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              ListRecipientsRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.list_recipients(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.ListRecipientsAsync(
              new ListRecipientsRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->listRecipients(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
              new ListRecipientsRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Preview/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Broadcasts
      summary: Preview a broadcast
      description: Renders the template for the first pending recipients so you can check personalisation, encoding and segment
        counts before you launch. Nothing is sent and nothing is charged. `missingVariables` lists placeholders that have
        no matching upload column; they render as empty text, so fix the template or re-upload before launching. `estimatedSegments`
        totals the segments across every pending recipient, not only the samples shown.
      operationId: preview-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      - name: limit
        in: query
        description: Number of pending recipients to render in `samples`, from 1 to 50. Defaults to 5 when you omit it or
          pass `0`. A value above 50 returns `400` with `limit must be between 1 and 50`, and a non-integer returns `400`
          with `limit must be an integer`.
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 5
      responses:
        '200':
          description: Rendered samples and totals.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastPreview'
              example:
                samples:
                - to: '+14155550123'
                  text: Hi Priya, your refund of $42.00 is on its way.
                  segments: 1
                  encoding: GSM-7
                - to: '+14155550124'
                  text: Hi Sam, your refund of $18.50 is on its way.
                  segments: 1
                  encoding: GSM-7
                missingVariables: []
                estimatedSegments: 2
        '400':
          description: '`limit` is out of range.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: limit must be between 1 and 50
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.previewBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.preview_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.PreviewBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.PreviewBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().previewBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              PreviewBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.preview_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.PreviewBroadcastAsync(
              new PreviewBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->previewBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
              new PreviewBroadcastRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Export/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Broadcasts
      summary: Export results as CSV
      description: Downloads every recipient with its send result as a CSV file (`text/csv`), named `broadcast-<id>.csv`.
        The columns are `row`, `to`, `status`, `message_id`, `error_code`, `error_message` and `sent_at`, followed by one
        column per column of your upload. Text cells that start with `=`, `+`, `-`, `@`, a tab or a carriage return are prefixed
        with `'` so they open safely in spreadsheet applications. You can export a broadcast in any status, including a draft,
        to check the parsed list.
      operationId: export-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The CSV file.
          headers:
            Content-Disposition:
              description: Suggested filename, `broadcast-<id>.csv`.
              schema:
                type: string
              example: attachment; filename="broadcast-3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35.csv"
          content:
            text/csv:
              schema:
                type: string
              example: |
                row,to,status,message_id,error_code,error_message,sent_at,phone,name,amount
                2,+14155550123,sent,9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01,,,2026-10-12T11:05:10Z,+14155550123,Priya,$42.00
                3,+14155550124,skipped,,,,,+14155550124,Sam,$18.50
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.exportBroadcast({
              id: "id"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.export_broadcast(
              id="id",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ExportBroadcastRequest{
                  ID: "id",
              }
          c.Sms.Broadcasts.ExportBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().exportBroadcast(
              "id",
              ExportBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.export_broadcast(id: "id")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.ExportBroadcastAsync(new ExportBroadcastRequest { Id = "id" });
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->exportBroadcast(
              'id',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Launch/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Broadcasts
      summary: Launch a broadcast
      description: Starts sending. This sends real SMS to every `pending` recipient and charges your account per segment,
        so call it only with your own credentials on a list you have consent to message. Only a `draft` can be launched; it
        moves to `running`, or to `scheduled` when `scheduledAt` is in the future. Launch returns `422` when the template
        is empty, when no recipient is pending, or when a phone-number `from` is not an SMS number on your account. Each recipient
        is sent like `POST /Message/` with the broadcast's `tag` and DLT IDs and the idempotency key `broadcast:<broadcastId>:<recipientId>`,
        so no recipient is messaged twice.
      operationId: launch-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The broadcast, now `running` or `scheduled`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: running
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 3
                  sent: 0
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:05:10Z'
                startedAt: '2026-10-12T11:05:10Z'
                completedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is not a draft.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot launch a broadcast that is completed
        '422':
          description: The draft is not ready to send. Fix the template, recipients or sender and launch again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                template:
                  value:
                    error: template is empty
                recipients:
                  value:
                    error: the broadcast has no valid recipients to send to
                sender:
                  value:
                    error: +14155550100 is not an SMS number on this account
                route:
                  value:
                    error: no SMS route for sender EXAMPLE
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.launchBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.launch_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.LaunchBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.LaunchBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().launchBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              LaunchBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.launch_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.LaunchBroadcastAsync(
              new LaunchBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->launchBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Pause/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Broadcasts
      summary: Pause a broadcast
      description: Pauses a `running` broadcast. Sending stops after the messages already in flight, and pending recipients
        stay `pending` until you resume or cancel. Any other status returns `409` with `cannot pause a broadcast that is <status>`.
      operationId: pause-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The broadcast, now `paused`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: paused
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 1
                  sent: 2
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:05:11Z'
                startedAt: '2026-10-12T11:05:10Z'
                completedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is not running.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot pause a broadcast that is draft
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.pauseBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.pause_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.PauseBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.PauseBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().pauseBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              PauseBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.pause_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.PauseBroadcastAsync(
              new PauseBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->pauseBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Resume/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Broadcasts
      summary: Resume a broadcast
      description: Continues sending to the pending recipients of a `paused` broadcast and moves it back to `running`. This
        sends real messages and charges your account per segment. It also resumes a broadcast paused with `pauseReason` `insufficient_balance`
        once you have topped up. Any other status returns `409` with `cannot resume a broadcast that is <status>`.
      operationId: resume-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The broadcast, now `running`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: running
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 1
                  sent: 2
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 0
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:06:00Z'
                startedAt: '2026-10-12T11:05:10Z'
                completedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast is not paused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot resume a broadcast that is running
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.resumeBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.resume_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ResumeBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.ResumeBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().resumeBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              ResumeBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.resume_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.ResumeBroadcastAsync(
              new ResumeBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->resumeBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
  /api/v1/Account/{auth_id}/Sms/Broadcast/{id}/Cancel/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Broadcasts
      summary: Cancel a broadcast
      description: Stops a broadcast for good and sets `completedAt`. You can cancel from `draft`, `scheduled`, `running`
        or `paused`; a `completed`, `failed` or already `cancelled` broadcast returns `409`. Pending recipients become `skipped`,
        and messages already sent are unaffected. A cancelled broadcast cannot be resumed or edited, but it can be deleted.
      operationId: cancel-broadcast
      parameters:
      - name: id
        in: path
        required: true
        description: The broadcast's `id` (UUID), as returned by `POST /Broadcast/` or `GET /Broadcast/`. An id that is not
          a UUID, or that belongs to another account, returns `404` with `broadcast not found`.
        schema:
          type: string
          format: uuid
        example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The broadcast, now `cancelled`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
              example:
                id: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
                accountId: MA_XXXXXXXX
                name: October pricing update
                from: '+14155550100'
                channel: sms
                template: Hi {{name}}, your refund of {{amount}} is on its way.
                status: cancelled
                scheduledAt: null
                ratePerSecond: 5
                tag: pricing-oct
                dltEntityId: ''
                dltHeaderId: ''
                dltTemplateId: ''
                columns:
                - phone
                - name
                - amount
                stats:
                  total: 3
                  pending: 0
                  sent: 2
                  delivered: 0
                  failed: 0
                  optedOut: 0
                  skipped: 1
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:07:30Z'
                startedAt: '2026-10-12T11:05:10Z'
                completedAt: '2026-10-12T11:07:30Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
        '409':
          description: The broadcast has already completed, failed or been cancelled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: cannot cancel a broadcast that is completed
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.broadcasts.cancelBroadcast({
              id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.broadcasts.cancel_broadcast(
              id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CancelBroadcastRequest{
                  ID: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              }
          c.Sms.Broadcasts.CancelBroadcast(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().broadcasts().cancelBroadcast(
              "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
              CancelBroadcastRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.broadcasts.cancel_broadcast(id: "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Broadcasts.CancelBroadcastAsync(
              new CancelBroadcastRequest { Id = "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->broadcasts->cancelBroadcast(
              '3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35',
          );
  /api/v1/Account/{auth_id}/Sms/Sender/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - RCS Senders
      summary: Create an RCS sender
      description: 'Registers a new RCS sender (agent) with the RCS platform and stores it on your account with status `pending`.
        `provider` and `senderName` are required; the profile fields are reviewed by the RCS platform and the carriers before
        the sender can reach real users. Poll `GET /Sender/{id}/Status/` until the platform reports it as launched, then send
        with its `senderName` as `from` and `channel: rcs` on `POST /Message/`. A rejected request returns `400` with the
        platform''s reason in `error`.'
      operationId: create-sender
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSenderRequest'
            example:
              provider: YOUR_ROUTING_IDENTIFIER
              senderName: example-brand
              displayName: Example Brand
              description: Order updates and support for Example Brand customers.
              billingCategory: CONVERSATIONAL
              useCase: TRANSACTIONAL
              hostingRegion: NORTH_AMERICA
              brand:
                brandName: Example Brand
              color: '#1A73E8'
              phones:
              - phoneNumber: '+14155550100'
                label: Support
              emails:
              - address: support@example.com
                label: Support
              websites:
              - url: https://example.com
                label: Website
              bannerUrl: https://example.com/rcs/banner.jpg
              logoUrl: https://example.com/rcs/logo.png
              privacy:
                url: https://example.com/privacy
                label: Privacy policy
              termsOfService:
                url: https://example.com/terms
                label: Terms of service
      responses:
        '201':
          description: The new sender in status `pending`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
              example:
                id: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                senderName: example-brand
                displayName: Example Brand
                description: Order updates and support for Example Brand customers.
                billingCategory: CONVERSATIONAL
                useCase: TRANSACTIONAL
                hostingRegion: NORTH_AMERICA
                status: pending
                brand:
                  brandName: Example Brand
                color: '#1A73E8'
                phones:
                - phoneNumber: '+14155550100'
                  label: Support
                emails:
                - address: support@example.com
                  label: Support
                websites:
                - url: https://example.com
                  label: Website
                bannerUrl: https://example.com/rcs/banner.jpg
                logoUrl: https://example.com/rcs/logo.png
                privacy:
                  url: https://example.com/privacy
                  label: Privacy policy
                termsOfService:
                  url: https://example.com/terms
                  label: Terms of service
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '400':
          description: The body is invalid, `provider` is missing, the `senderName` is already in use, or the RCS platform
            rejected the sender. `error` explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid request body
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.createSender({
              provider: "YOUR_ROUTING_IDENTIFIER",
              senderName: "example-brand",
              displayName: "Example Brand",
              description: "Order updates and support for Example Brand customers.",
              billingCategory: "CONVERSATIONAL",
              useCase: "TRANSACTIONAL",
              hostingRegion: "NORTH_AMERICA",
              brand: {
                  brandName: "Example Brand"
              },
              color: "#1A73E8",
              phones: [{
                      phoneNumber: "+14155550100",
                      label: "Support"
                  }],
              emails: [{
                      address: "support@example.com",
                      label: "Support"
                  }],
              websites: [{
                      url: "https://example.com",
                      label: "Website"
                  }],
              bannerUrl: "https://example.com/rcs/banner.jpg",
              logoUrl: "https://example.com/rcs/logo.png",
              privacy: {
                  url: "https://example.com/privacy",
                  label: "Privacy policy"
              },
              termsOfService: {
                  url: "https://example.com/terms",
                  label: "Terms of service"
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          from vobiz.sms import SenderBrand, SenderPhone, SenderEmail, SenderWebsite, SenderLink

          client.sms.rcs_senders.create_sender(
              provider="YOUR_ROUTING_IDENTIFIER",
              sender_name="example-brand",
              display_name="Example Brand",
              description="Order updates and support for Example Brand customers.",
              billing_category="CONVERSATIONAL",
              use_case="TRANSACTIONAL",
              hosting_region="NORTH_AMERICA",
              brand=SenderBrand(
                  brand_name="Example Brand",
              ),
              color="#1A73E8",
              phones=[
                  SenderPhone(
                      phone_number="+14155550100",
                      label="Support",
                  )
              ],
              emails=[
                  SenderEmail(
                      address="support@example.com",
                      label="Support",
                  )
              ],
              websites=[
                  SenderWebsite(
                      url="https://example.com",
                      label="Website",
                  )
              ],
              banner_url="https://example.com/rcs/banner.jpg",
              logo_url="https://example.com/rcs/logo.png",
              privacy=SenderLink(
                  url="https://example.com/privacy",
                  label="Privacy policy",
              ),
              terms_of_service=SenderLink(
                  url="https://example.com/terms",
                  label="Terms of service",
              ),
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateSenderRequest{
                  Provider: "YOUR_ROUTING_IDENTIFIER",
                  SenderName: "example-brand",
                  DisplayName: vobiz.String(
                      "Example Brand",
                  ),
                  Description: vobiz.String(
                      "Order updates and support for Example Brand customers.",
                  ),
                  BillingCategory: vobiz.String(
                      "CONVERSATIONAL",
                  ),
                  UseCase: vobiz.String(
                      "TRANSACTIONAL",
                  ),
                  HostingRegion: vobiz.String(
                      "NORTH_AMERICA",
                  ),
                  Brand: &sms.SenderBrand{
                      BrandName: vobiz.String(
                          "Example Brand",
                      ),
                  },
                  Color: vobiz.String(
                      "#1A73E8",
                  ),
                  Phones: []*sms.SenderPhone{
                      &sms.SenderPhone{
                          PhoneNumber: vobiz.String(
                              "+14155550100",
                          ),
                          Label: vobiz.String(
                              "Support",
                          ),
                      },
                  },
                  Emails: []*sms.SenderEmail{
                      &sms.SenderEmail{
                          Address: vobiz.String(
                              "support@example.com",
                          ),
                          Label: vobiz.String(
                              "Support",
                          ),
                      },
                  },
                  Websites: []*sms.SenderWebsite{
                      &sms.SenderWebsite{
                          URL: vobiz.String(
                              "https://example.com",
                          ),
                          Label: vobiz.String(
                              "Website",
                          ),
                      },
                  },
                  BannerURL: vobiz.String(
                      "https://example.com/rcs/banner.jpg",
                  ),
                  LogoURL: vobiz.String(
                      "https://example.com/rcs/logo.png",
                  ),
                  Privacy: &sms.SenderLink{
                      URL: vobiz.String(
                          "https://example.com/privacy",
                      ),
                      Label: vobiz.String(
                          "Privacy policy",
                      ),
                  },
                  TermsOfService: &sms.SenderLink{
                      URL: vobiz.String(
                          "https://example.com/terms",
                      ),
                      Label: vobiz.String(
                          "Terms of service",
                      ),
                  },
              }
          c.Sms.RcsSenders.CreateSender(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().createSender(
              CreateSenderRequest
                  .builder()
                  .provider("YOUR_ROUTING_IDENTIFIER")
                  .senderName("example-brand")
                  .displayName("Example Brand")
                  .description("Order updates and support for Example Brand customers.")
                  .billingCategory("CONVERSATIONAL")
                  .useCase("TRANSACTIONAL")
                  .hostingRegion("NORTH_AMERICA")
                  .brand(
                      SenderBrand
                          .builder()
                          .brandName("Example Brand")
                          .build()
                  )
                  .color("#1A73E8")
                  .phones(
                      Optional.of(
                          Arrays.asList(
                              SenderPhone
                                  .builder()
                                  .phoneNumber("+14155550100")
                                  .label("Support")
                                  .build()
                          )
                      )
                  )
                  .emails(
                      Optional.of(
                          Arrays.asList(
                              SenderEmail
                                  .builder()
                                  .address("support@example.com")
                                  .label("Support")
                                  .build()
                          )
                      )
                  )
                  .websites(
                      Optional.of(
                          Arrays.asList(
                              SenderWebsite
                                  .builder()
                                  .url("https://example.com")
                                  .label("Website")
                                  .build()
                          )
                      )
                  )
                  .bannerUrl("https://example.com/rcs/banner.jpg")
                  .logoUrl("https://example.com/rcs/logo.png")
                  .privacy(
                      SenderLink
                          .builder()
                          .url("https://example.com/privacy")
                          .label("Privacy policy")
                          .build()
                  )
                  .termsOfService(
                      SenderLink
                          .builder()
                          .url("https://example.com/terms")
                          .label("Terms of service")
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.create_sender(
            provider: "YOUR_ROUTING_IDENTIFIER",
            sender_name: "example-brand",
            display_name: "Example Brand",
            description: "Order updates and support for Example Brand customers.",
            billing_category: "CONVERSATIONAL",
            use_case: "TRANSACTIONAL",
            hosting_region: "NORTH_AMERICA",
            brand: {
              brand_name: "Example Brand"
            },
            color: "#1A73E8",
            phones: [{
              phone_number: "+14155550100",
              label: "Support"
            }],
            emails: [{
              address: "support@example.com",
              label: "Support"
            }],
            websites: [{
              url: "https://example.com",
              label: "Website"
            }],
            banner_url: "https://example.com/rcs/banner.jpg",
            logo_url: "https://example.com/rcs/logo.png",
            privacy: {
              url: "https://example.com/privacy",
              label: "Privacy policy"
            },
            terms_of_service: {
              url: "https://example.com/terms",
              label: "Terms of service"
            }
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.CreateSenderAsync(
              new CreateSenderRequest
              {
                  Provider = "YOUR_ROUTING_IDENTIFIER",
                  SenderName = "example-brand",
                  DisplayName = "Example Brand",
                  Description = "Order updates and support for Example Brand customers.",
                  BillingCategory = "CONVERSATIONAL",
                  UseCase = "TRANSACTIONAL",
                  HostingRegion = "NORTH_AMERICA",
                  Brand = new SenderBrand { BrandName = "Example Brand" },
                  Color = "#1A73E8",
                  Phones = new List<SenderPhone>()
                  {
                      new SenderPhone { PhoneNumber = "+14155550100", Label = "Support" },
                  },
                  Emails = new List<SenderEmail>()
                  {
                      new SenderEmail { Address = "support@example.com", Label = "Support" },
                  },
                  Websites = new List<SenderWebsite>()
                  {
                      new SenderWebsite { Url = "https://example.com", Label = "Website" },
                  },
                  BannerUrl = "https://example.com/rcs/banner.jpg",
                  LogoUrl = "https://example.com/rcs/logo.png",
                  Privacy = new SenderLink { Url = "https://example.com/privacy", Label = "Privacy policy" },
                  TermsOfService = new SenderLink
                  {
                      Url = "https://example.com/terms",
                      Label = "Terms of service",
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->createSender(
              new CreateSenderRequest([
                  'provider' => 'YOUR_ROUTING_IDENTIFIER',
                  'senderName' => 'example-brand',
                  'displayName' => 'Example Brand',
                  'description' => 'Order updates and support for Example Brand customers.',
                  'billingCategory' => 'CONVERSATIONAL',
                  'useCase' => 'TRANSACTIONAL',
                  'hostingRegion' => 'NORTH_AMERICA',
                  'brand' => new SenderBrand([
                      'brandName' => 'Example Brand',
                  ]),
                  'color' => '#1A73E8',
                  'phones' => [
                      new SenderPhone([
                          'phoneNumber' => '+14155550100',
                          'label' => 'Support',
                      ]),
                  ],
                  'emails' => [
                      new SenderEmail([
                          'address' => 'support@example.com',
                          'label' => 'Support',
                      ]),
                  ],
                  'websites' => [
                      new SenderWebsite([
                          'url' => 'https://example.com',
                          'label' => 'Website',
                      ]),
                  ],
                  'bannerUrl' => 'https://example.com/rcs/banner.jpg',
                  'logoUrl' => 'https://example.com/rcs/logo.png',
                  'privacy' => new SenderLink([
                      'url' => 'https://example.com/privacy',
                      'label' => 'Privacy policy',
                  ]),
                  'termsOfService' => new SenderLink([
                      'url' => 'https://example.com/terms',
                      'label' => 'Terms of service',
                  ]),
              ]),
          );
    get:
      tags:
      - RCS Senders
      summary: List RCS senders
      description: Returns the RCS senders on your account as a bare JSON array, without a total count. Page through them
        with `limit` and `offset`; an empty array means you have reached the end. `status` here is the last stored value,
        so call `GET /Sender/{id}/Status/` for the latest state.
      operationId: list-senders
      parameters:
      - name: limit
        in: query
        description: Maximum number of items to return, from 1 to 100. Defaults to 20; a value outside that range or a non-integer
          is replaced by the default.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: offset
        in: query
        description: Number of items to skip before the page starts. Defaults to `0`. Pass a whole number of 0 or more.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: An array of senders. Empty when you have none.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Sender'
              example:
              - id: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                senderName: example-brand
                displayName: Example Brand
                description: Order updates and support for Example Brand customers.
                billingCategory: CONVERSATIONAL
                useCase: TRANSACTIONAL
                hostingRegion: NORTH_AMERICA
                status: pending
                brand:
                  brandName: Example Brand
                color: '#1A73E8'
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.listSenders()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.list_senders()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListSendersRequest{}
          c.Sms.RcsSenders.ListSenders(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().listSenders(
              ListSendersRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.list_senders
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.ListSendersAsync(new ListSendersRequest());
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->listSenders(
              new ListSendersRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Sender/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    - name: id
      in: path
      required: true
      description: The sender's `id` (UUID), as returned by `POST /Sender/` or `GET /Sender/`. An unknown id returns `sender
        not found`.
      schema:
        type: string
        format: uuid
      example: 5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b
    get:
      tags:
      - RCS Senders
      summary: Retrieve an RCS sender
      description: Returns one RCS sender as stored on your account, including its full profile. `status` is the last value
        stored on your account; call `GET /Sender/{id}/Status/` to refresh it from the RCS platform. An unknown id returns
        `404`.
      operationId: get-sender
      responses:
        '200':
          description: The sender.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
              example:
                id: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                senderName: example-brand
                displayName: Example Brand
                description: Order updates and support for Example Brand customers.
                billingCategory: CONVERSATIONAL
                useCase: TRANSACTIONAL
                hostingRegion: NORTH_AMERICA
                status: ''
                brand:
                  brandName: Example Brand
                color: '#1A73E8'
                phones:
                - label: Call us
                  phoneNumber: '+14155550100'
                emails:
                - label: Email support
                  address: support@example.com
                websites:
                - url: https://example.com/
                  label: Website
                bannerUrl: https://example.com/banner.png
                logoUrl: https://example.com/logo.png
                privacy:
                  url: https://example.com/privacy
                  label: Privacy policy
                termsOfService:
                  url: https://example.com/terms
                  label: Terms of service
                platform:
                  applicationId: default
                createdAt: '2026-11-02T14:08:38Z'
                updatedAt: '2026-11-13T06:43:59Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The sender wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: sender not found
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.getSender({
              id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.get_sender(
              id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetSenderRequest{
                  ID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              }
          c.Sms.RcsSenders.GetSender(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().getSender(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              GetSenderRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.get_sender(id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.GetSenderAsync(
              new GetSenderRequest { Id = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->getSender(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
          );
    put:
      tags:
      - RCS Senders
      summary: Update an RCS sender
      description: Updates the sender's profile on the RCS platform and then on your account, and returns the updated sender.
        Send only the fields you want to change; fields you leave out keep their value. `provider`, `senderName` and `hostingRegion`
        are fixed after creation. Errors, including an unknown id, return `400` with an `error` message.
      operationId: update-sender
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSenderRequest'
            example:
              displayName: Example Brand Support
              description: Order updates, returns and support for Example Brand customers.
              websites:
              - url: https://example.com/help
                label: Help centre
      responses:
        '200':
          description: The updated sender.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
              example:
                id: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                senderName: example-brand
                displayName: Example Brand Support
                description: Order updates, returns and support for Example Brand customers.
                billingCategory: CONVERSATIONAL
                useCase: TRANSACTIONAL
                hostingRegion: NORTH_AMERICA
                status: pending
                brand:
                  brandName: Example Brand
                color: '#1A73E8'
                websites:
                - url: https://example.com/help
                  label: Help centre
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T12:00:00Z'
        '400':
          description: The body is invalid, the sender does not exist on your account, or the RCS platform rejected the change.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                body:
                  value:
                    error: invalid request body
                notFound:
                  value:
                    error: sender not found
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.updateSender({
              id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              displayName: "Example Brand Support",
              description: "Order updates, returns and support for Example Brand customers.",
              websites: [{
                      url: "https://example.com/help",
                      label: "Help centre"
                  }]
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          from vobiz.sms import SenderWebsite

          client.sms.rcs_senders.update_sender(
              id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              display_name="Example Brand Support",
              description="Order updates, returns and support for Example Brand customers.",
              websites=[
                  SenderWebsite(
                      url="https://example.com/help",
                      label="Help centre",
                  )
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateSenderRequest{
                  ID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  DisplayName: vobiz.String(
                      "Example Brand Support",
                  ),
                  Description: vobiz.String(
                      "Order updates, returns and support for Example Brand customers.",
                  ),
                  Websites: []*sms.SenderWebsite{
                      &sms.SenderWebsite{
                          URL: vobiz.String(
                              "https://example.com/help",
                          ),
                          Label: vobiz.String(
                              "Help centre",
                          ),
                      },
                  },
              }
          c.Sms.RcsSenders.UpdateSender(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().updateSender(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              UpdateSenderRequest
                  .builder()
                  .displayName("Example Brand Support")
                  .description("Order updates, returns and support for Example Brand customers.")
                  .websites(
                      Optional.of(
                          Arrays.asList(
                              SenderWebsite
                                  .builder()
                                  .url("https://example.com/help")
                                  .label("Help centre")
                                  .build()
                          )
                      )
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.update_sender(
            id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
            display_name: "Example Brand Support",
            description: "Order updates, returns and support for Example Brand customers.",
            websites: [{
              url: "https://example.com/help",
              label: "Help centre"
            }]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.UpdateSenderAsync(
              new UpdateSenderRequest
              {
                  Id = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  DisplayName = "Example Brand Support",
                  Description = "Order updates, returns and support for Example Brand customers.",
                  Websites = new List<SenderWebsite>()
                  {
                      new SenderWebsite { Url = "https://example.com/help", Label = "Help centre" },
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->updateSender(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              new UpdateSenderRequest([
                  'displayName' => 'Example Brand Support',
                  'description' => 'Order updates, returns and support for Example Brand customers.',
                  'websites' => [
                      new SenderWebsite([
                          'url' => 'https://example.com/help',
                          'label' => 'Help centre',
                      ]),
                  ],
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/Sender/{id}/Status/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - RCS Senders
      summary: Refresh sender status
      description: Asks the RCS platform for the sender's current launch status, stores it on the sender and returns the full
        sender. Poll it after `POST /Sender/` or a profile update until `status` shows the sender is live, then start sending.
        Errors, including an unknown id, return `400` with an `error` message.
      operationId: get-sender-status
      parameters:
      - name: id
        in: path
        required: true
        description: The sender's `id` (UUID), as returned by `POST /Sender/` or `GET /Sender/`. An unknown id returns `sender
          not found`.
        schema:
          type: string
          format: uuid
        example: 5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b
      responses:
        '200':
          description: The sender with its refreshed `status`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
              example:
                id: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                senderName: example-brand
                displayName: Example Brand
                description: Order updates and support for Example Brand customers.
                billingCategory: CONVERSATIONAL
                useCase: TRANSACTIONAL
                hostingRegion: NORTH_AMERICA
                status: pending
                brand:
                  brandName: Example Brand
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T12:30:00Z'
        '400':
          description: The sender does not exist on your account, or the RCS platform did not return a status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                notFound:
                  value:
                    error: sender not found
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.getSenderStatus({
              id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.get_sender_status(
              id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetSenderStatusRequest{
                  ID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              }
          c.Sms.RcsSenders.GetSenderStatus(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().getSenderStatus(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              GetSenderStatusRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.get_sender_status(id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.GetSenderStatusAsync(
              new GetSenderStatusRequest { Id = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->getSenderStatus(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
          );
  /api/v1/Account/{auth_id}/Sms/Sender/{senderId}/Template/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    - name: senderId
      in: path
      required: true
      description: The `id` (UUID) of the RCS sender that owns the templates. An unknown sender returns `sender not found`.
      schema:
        type: string
        format: uuid
      example: 5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b
    post:
      tags:
      - RCS Senders
      summary: Create a template
      description: Registers a message template on an RCS sender with the RCS platform and returns it with status `pending`.
        `templateName`, `type` and `content` are passed to the platform unchanged, so use the template types and content shapes
        the RCS platform defines. Call `GET /Sender/{senderId}/Template/{templateName}/Status/` to follow approval. An unknown
        sender or a platform rejection returns `400`.
      operationId: create-template
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
            example:
              templateName: order-shipped
              type: TEXT
              content:
                text: Your order {{orderId}} has shipped and arrives on {{eta}}.
      responses:
        '201':
          description: The new template in status `pending`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
              example:
                id: c2e4a6b8-1d3f-4a5c-9e7b-6f8d0a2c4e61
                senderId: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                templateName: order-shipped
                type: TEXT
                status: pending
                content:
                  text: Your order {{orderId}} has shipped and arrives on {{eta}}.
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '400':
          description: The body is invalid, the sender does not exist on your account, or the RCS platform rejected the template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                body:
                  value:
                    error: invalid request body
                notFound:
                  value:
                    error: sender not found
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.createTemplate({
              senderId: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              templateName: "order-shipped",
              type: "TEXT",
              content: {
                  "text": "Your order {{orderId}} has shipped and arrives on {{eta}}."
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.create_template(
              sender_id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              template_name="order-shipped",
              type="TEXT",
              content={
                  "text": "Your order {{orderId}} has shipped and arrives on {{eta}}."
              },
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateTemplateRequest{
                  SenderID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName: "order-shipped",
                  Type: "TEXT",
                  Content: map[string]any{
                      "text": "Your order {{orderId}} has shipped and arrives on {{eta}}.",
                  },
              }
          c.Sms.RcsSenders.CreateTemplate(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().createTemplate(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              CreateTemplateRequest
                  .builder()
                  .templateName("order-shipped")
                  .type("TEXT")
                  .content(
                      new HashMap<String, Object>() {{
                          put("text", "Your order {{orderId}} has shipped and arrives on {{eta}}.");
                      }}
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.create_template(
            sender_id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
            template_name: "order-shipped",
            type: "TEXT",
            content: {}
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.CreateTemplateAsync(
              new CreateTemplateRequest
              {
                  SenderId = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName = "order-shipped",
                  Type = "TEXT",
                  Content = new Dictionary<string, object?>()
                  {
                      { "text", "Your order {{orderId}} has shipped and arrives on {{eta}}." },
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->createTemplate(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              new CreateTemplateRequest([
                  'templateName' => 'order-shipped',
                  'type' => 'TEXT',
                  'content' => [
                      'text' => "Your order {{orderId}} has shipped and arrives on {{eta}}.",
                  ],
              ]),
          );
    get:
      tags:
      - RCS Senders
      summary: List templates
      description: Returns the templates registered on one RCS sender as a bare JSON array, without a total count. Page through
        them with `limit` and `offset`. `status` is the last stored value; refresh one template with its `/status` endpoint.
      operationId: list-templates
      parameters:
      - name: limit
        in: query
        description: Maximum number of items to return, from 1 to 100. Defaults to 20; a value outside that range or a non-integer
          is replaced by the default.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: offset
        in: query
        description: Number of items to skip before the page starts. Defaults to `0`. Pass a whole number of 0 or more.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: An array of templates. Empty when the sender has none.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Template'
              example:
              - id: c2e4a6b8-1d3f-4a5c-9e7b-6f8d0a2c4e61
                senderId: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                templateName: order-shipped
                type: TEXT
                status: pending
                content:
                  text: Your order {{orderId}} has shipped and arrives on {{eta}}.
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          description: The sender wasn't found (`sender not found`), or the request couldn't be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: sender not found
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.listTemplates({
              senderId: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.list_templates(
              sender_id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListTemplatesRequest{
                  SenderID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              }
          c.Sms.RcsSenders.ListTemplates(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().listTemplates(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              ListTemplatesRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.list_templates(sender_id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.ListTemplatesAsync(
              new ListTemplatesRequest { SenderId = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->listTemplates(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              new ListTemplatesRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/Sender/{senderId}/Template/{templateName}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    - name: senderId
      in: path
      required: true
      description: The `id` (UUID) of the RCS sender that owns the templates. An unknown sender returns `sender not found`.
      schema:
        type: string
        format: uuid
      example: 5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b
    - name: templateName
      in: path
      required: true
      description: The template's `templateName`, exactly as you set it when you created the template on this sender.
      schema:
        type: string
      example: appointment_reminder
    get:
      tags:
      - RCS Senders
      summary: Retrieve a template
      description: Returns one template as stored on your account, including the `content` you submitted. For the latest approval
        state from the RCS platform, call `GET /Sender/{senderId}/Template/{templateName}/Status/`. An unknown sender or
        template returns `404`.
      operationId: get-template
      responses:
        '200':
          description: The template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
              example:
                id: c2e4a6b8-1d3f-4a5c-9e7b-6f8d0a2c4e61
                senderId: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                templateName: order-shipped
                type: TEXT
                status: pending
                content:
                  text: Your order {{orderId}} has shipped and arrives on {{eta}}.
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The sender or template wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                sender:
                  value:
                    error: sender not found
                template:
                  value:
                    error: template not found
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.getTemplate({
              senderId: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              templateName: "appointment_reminder"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.get_template(
              sender_id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              template_name="appointment_reminder",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetTemplateRequest{
                  SenderID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName: "appointment_reminder",
              }
          c.Sms.RcsSenders.GetTemplate(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().getTemplate(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              "appointment_reminder",
              GetTemplateRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.get_template(
            sender_id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
            template_name: "appointment_reminder"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.GetTemplateAsync(
              new GetTemplateRequest
              {
                  SenderId = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName = "appointment_reminder",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->getTemplate(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              'appointment_reminder',
          );
    delete:
      tags:
      - RCS Senders
      summary: Delete a template
      description: Removes the template from the RCS platform and from your account, and returns `204` with no body. You cannot
        send with the template afterwards. An unknown sender or template returns `400`.
      operationId: delete-template
      responses:
        '204':
          description: Deleted. No body.
        '400':
          description: The sender or template does not exist on your account, or the RCS platform rejected the deletion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                sender:
                  value:
                    error: sender not found
                template:
                  value:
                    error: template not found
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.deleteTemplate({
              senderId: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              templateName: "appointment_reminder"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.delete_template(
              sender_id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              template_name="appointment_reminder",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteTemplateRequest{
                  SenderID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName: "appointment_reminder",
              }
          c.Sms.RcsSenders.DeleteTemplate(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().deleteTemplate(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              "appointment_reminder",
              DeleteTemplateRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.delete_template(
            sender_id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
            template_name: "appointment_reminder"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.DeleteTemplateAsync(
              new DeleteTemplateRequest
              {
                  SenderId = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName = "appointment_reminder",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->deleteTemplate(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              'appointment_reminder',
          );
  /api/v1/Account/{auth_id}/Sms/Sender/{senderId}/Template/{templateName}/Status/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - RCS Senders
      summary: Refresh template status
      description: Asks the RCS platform for the template's current approval status, stores it on the template and returns
        the full template. Poll it after `POST /Sender/{senderId}/Template/` until the template is approved. Errors,
        including an unknown sender or template, return `400` with an `error` message.
      operationId: get-template-status
      parameters:
      - name: senderId
        in: path
        required: true
        description: The `id` (UUID) of the RCS sender that owns the templates. An unknown sender returns `sender not found`.
        schema:
          type: string
          format: uuid
        example: 5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b
      - name: templateName
        in: path
        required: true
        description: The template's `templateName`, exactly as you set it when you created the template on this sender.
        schema:
          type: string
        example: appointment_reminder
      responses:
        '200':
          description: The template with its refreshed `status`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
              example:
                id: c2e4a6b8-1d3f-4a5c-9e7b-6f8d0a2c4e61
                senderId: 7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21
                accountId: MA_XXXXXXXX
                provider: YOUR_ROUTING_IDENTIFIER
                templateName: order-shipped
                type: TEXT
                status: pending
                content:
                  text: Your order {{orderId}} has shipped and arrives on {{eta}}.
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T12:30:00Z'
        '400':
          description: The sender or template does not exist on your account, or the RCS platform did not return a status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                sender:
                  value:
                    error: sender not found
                template:
                  value:
                    error: template not found
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.rcsSenders.getTemplateStatus({
              senderId: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              templateName: "appointment_reminder"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.rcs_senders.get_template_status(
              sender_id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              template_name="appointment_reminder",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetTemplateStatusRequest{
                  SenderID: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName: "appointment_reminder",
              }
          c.Sms.RcsSenders.GetTemplateStatus(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().rcsSenders().getTemplateStatus(
              "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
              "appointment_reminder",
              GetTemplateStatusRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.rcs_senders.get_template_status(
            sender_id: "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
            template_name: "appointment_reminder"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.RcsSenders.GetTemplateStatusAsync(
              new GetTemplateStatusRequest
              {
                  SenderId = "5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
                  TemplateName = "appointment_reminder",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->rcsSenders->getTemplateStatus(
              '5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b',
              'appointment_reminder',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Brands
      summary: Create a brand
      description: 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. `name` and `brandType` are required; send every other field your business
        has, because the registry reviews them when you register. Nothing is submitted for review until you call `POST /TenDlc/Brand/{id}/Register/`.
        Pass a `referenceId` so that a retried request (for example after a `502`) reconciles to the same brand instead of
        creating a second one. Next, register the brand, then create a campaign under it with `POST /TenDlc/Campaign/`.
      operationId: create-brand
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandRequest'
            examples:
              privateCompany:
                summary: US private company
                value:
                  referenceId: brand-example-corp-01
                  name: Example Corp
                  legalName: Example Corporation Inc.
                  brandType: TENDLC_PRIVATE_COMPANY
                  legalEntityType: PRIVATE_COMPANY
                  vertical: TECHNOLOGY
                  website: https://example.com
                  supportEmail: support@example.com
                  supportPhone: '+14155550100'
                  taxId: 12-3456789
                  taxIdIssuingCountry: US
                  countryCode: US
                  address:
                    street: 100 Example Street
                    city: San Francisco
                    state: CA
                    zipCode: '94105'
                  businessContactFirstName: Alex
                  businessContactLastName: Doe
                  businessContactEmail: alex.doe@example.com
      responses:
        '201':
          description: The brand was created in `DRAFT` stage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Brand'
              example:
                id: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                accountId: MA_XXXXXXXX
                name: Example Corp
                legalName: Example Corporation Inc.
                brandType: TENDLC_PRIVATE_COMPANY
                stage: DRAFT
                website: https://example.com
                supportEmail: support@example.com
                supportPhone: '+14155550100'
                vertical: TECHNOLOGY
                taxId: 12-3456789
                taxIdIssuingCountry: US
                countryCode: US
                address:
                  street: 100 Example Street
                  city: San Francisco
                  state: CA
                  zipCode: '94105'
                businessContactFirstName: Alex
                businessContactLastName: Doe
                businessContactEmail: alex.doe@example.com
                legalEntityType: PRIVATE_COMPANY
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T10:30:00Z'
        '400':
          description: Invalid body or a missing required field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                name:
                  value:
                    error: 'invalid request: name is required'
                brandType:
                  value:
                    error: 'invalid request: brandType is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: The registry brand this request resolves to is already linked to a brand on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'conflict: provider brand 7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b already linked'
        '422':
          description: The US 10DLC registry rejected the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: legalName is required for TENDLC_PRIVATE_COMPANY'
        '502':
          description: The US 10DLC registry did not answer. Retry with the same `referenceId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '503':
          description: Registration is temporarily unavailable. Retry later or contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.createBrand({
              referenceId: "brand-example-corp-01",
              name: "Example Corp",
              legalName: "Example Corporation Inc.",
              brandType: "TENDLC_PRIVATE_COMPANY",
              website: "https://example.com",
              supportEmail: "support@example.com",
              supportPhone: "+14155550100",
              vertical: "TECHNOLOGY",
              taxId: "12-3456789",
              taxIdIssuingCountry: "US",
              countryCode: "US",
              address: {
                  street: "100 Example Street",
                  city: "San Francisco",
                  state: "CA",
                  zipCode: "94105"
              },
              businessContactFirstName: "Alex",
              businessContactLastName: "Doe",
              businessContactEmail: "alex.doe@example.com",
              legalEntityType: "PRIVATE_COMPANY"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          from vobiz.sms import BrandAddress

          client.sms.brands.create_brand(
              reference_id="brand-example-corp-01",
              name="Example Corp",
              legal_name="Example Corporation Inc.",
              brand_type="TENDLC_PRIVATE_COMPANY",
              website="https://example.com",
              support_email="support@example.com",
              support_phone="+14155550100",
              vertical="TECHNOLOGY",
              tax_id="12-3456789",
              tax_id_issuing_country="US",
              country_code="US",
              address=BrandAddress(
                  street="100 Example Street",
                  city="San Francisco",
                  state="CA",
                  zip_code="94105",
              ),
              business_contact_first_name="Alex",
              business_contact_last_name="Doe",
              business_contact_email="alex.doe@example.com",
              legal_entity_type="PRIVATE_COMPANY",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateBrandRequest{
                  ReferenceID: vobiz.String(
                      "brand-example-corp-01",
                  ),
                  Name: "Example Corp",
                  LegalName: vobiz.String(
                      "Example Corporation Inc.",
                  ),
                  BrandType: sms.CreateBrandRequestBrandTypeTendlcPrivateCompany,
                  Website: vobiz.String(
                      "https://example.com",
                  ),
                  SupportEmail: vobiz.String(
                      "support@example.com",
                  ),
                  SupportPhone: vobiz.String(
                      "+14155550100",
                  ),
                  Vertical: vobiz.String(
                      "TECHNOLOGY",
                  ),
                  TaxID: vobiz.String(
                      "12-3456789",
                  ),
                  TaxIDIssuingCountry: vobiz.String(
                      "US",
                  ),
                  CountryCode: vobiz.String(
                      "US",
                  ),
                  Address: &sms.BrandAddress{
                      Street: vobiz.String(
                          "100 Example Street",
                      ),
                      City: vobiz.String(
                          "San Francisco",
                      ),
                      State: vobiz.String(
                          "CA",
                      ),
                      ZipCode: vobiz.String(
                          "94105",
                      ),
                  },
                  BusinessContactFirstName: vobiz.String(
                      "Alex",
                  ),
                  BusinessContactLastName: vobiz.String(
                      "Doe",
                  ),
                  BusinessContactEmail: vobiz.String(
                      "alex.doe@example.com",
                  ),
                  LegalEntityType: vobiz.String(
                      "PRIVATE_COMPANY",
                  ),
              }
          c.Sms.Brands.CreateBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().createBrand(
              CreateBrandRequest
                  .builder()
                  .name("Example Corp")
                  .brandType(CreateBrandRequestBrandType.TENDLC_PRIVATE_COMPANY)
                  .referenceId("brand-example-corp-01")
                  .legalName("Example Corporation Inc.")
                  .website("https://example.com")
                  .supportEmail("support@example.com")
                  .supportPhone("+14155550100")
                  .vertical("TECHNOLOGY")
                  .taxId("12-3456789")
                  .taxIdIssuingCountry("US")
                  .countryCode("US")
                  .address(
                      BrandAddress
                          .builder()
                          .street("100 Example Street")
                          .city("San Francisco")
                          .state("CA")
                          .zipCode("94105")
                          .build()
                  )
                  .businessContactFirstName("Alex")
                  .businessContactLastName("Doe")
                  .businessContactEmail("alex.doe@example.com")
                  .legalEntityType("PRIVATE_COMPANY")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.create_brand(
            reference_id: "brand-example-corp-01",
            name: "Example Corp",
            legal_name: "Example Corporation Inc.",
            brand_type: "TENDLC_PRIVATE_COMPANY",
            website: "https://example.com",
            support_email: "support@example.com",
            support_phone: "+14155550100",
            vertical: "TECHNOLOGY",
            tax_id: "12-3456789",
            tax_id_issuing_country: "US",
            country_code: "US",
            address: {
              street: "100 Example Street",
              city: "San Francisco",
              state: "CA",
              zip_code: "94105"
            },
            business_contact_first_name: "Alex",
            business_contact_last_name: "Doe",
            business_contact_email: "alex.doe@example.com",
            legal_entity_type: "PRIVATE_COMPANY"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.CreateBrandAsync(
              new CreateBrandRequest
              {
                  ReferenceId = "brand-example-corp-01",
                  Name = "Example Corp",
                  LegalName = "Example Corporation Inc.",
                  BrandType = CreateBrandRequestBrandType.TendlcPrivateCompany,
                  Website = "https://example.com",
                  SupportEmail = "support@example.com",
                  SupportPhone = "+14155550100",
                  Vertical = "TECHNOLOGY",
                  TaxId = "12-3456789",
                  TaxIdIssuingCountry = "US",
                  CountryCode = "US",
                  Address = new BrandAddress
                  {
                      Street = "100 Example Street",
                      City = "San Francisco",
                      State = "CA",
                      ZipCode = "94105",
                  },
                  BusinessContactFirstName = "Alex",
                  BusinessContactLastName = "Doe",
                  BusinessContactEmail = "alex.doe@example.com",
                  LegalEntityType = "PRIVATE_COMPANY",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->createBrand(
              new CreateBrandRequest([
                  'referenceId' => 'brand-example-corp-01',
                  'name' => 'Example Corp',
                  'legalName' => 'Example Corporation Inc.',
                  'brandType' => CreateBrandRequestBrandType::TendlcPrivateCompany->value,
                  'website' => 'https://example.com',
                  'supportEmail' => 'support@example.com',
                  'supportPhone' => '+14155550100',
                  'vertical' => 'TECHNOLOGY',
                  'taxId' => '12-3456789',
                  'taxIdIssuingCountry' => 'US',
                  'countryCode' => 'US',
                  'address' => new BrandAddress([
                      'street' => '100 Example Street',
                      'city' => 'San Francisco',
                      'state' => 'CA',
                      'zipCode' => '94105',
                  ]),
                  'businessContactFirstName' => 'Alex',
                  'businessContactLastName' => 'Doe',
                  'businessContactEmail' => 'alex.doe@example.com',
                  'legalEntityType' => 'PRIVATE_COMPANY',
              ]),
          );
    get:
      tags:
      - 10DLC Brands
      summary: List brands
      description: Returns every brand on your account as a bare JSON array, newest first. The list is not paginated and reads
        the records stored on your account without contacting the registry; deleted brands are left out. Call `GET /TenDlc/Brand/{id}/`
        for the latest registry state of one brand.
      operationId: list-brands
      responses:
        '200':
          description: All brands on your account.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Brand'
              example:
              - id: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                accountId: MA_XXXXXXXX
                name: Example Corp
                legalName: Example Corporation Inc.
                brandType: TENDLC_PRIVATE_COMPANY
                stage: SUBMITTED
                registrationStatus: ACTIVE
                brandIdentityStatus: VERIFIED
                website: https://example.com
                supportEmail: support@example.com
                supportPhone: '+14155550100'
                vertical: TECHNOLOGY
                taxId: 12-3456789
                taxIdIssuingCountry: US
                countryCode: US
                address:
                  street: 100 Example Street
                  city: San Francisco
                  state: CA
                  zipCode: '94105'
                businessContactFirstName: Alex
                businessContactLastName: Doe
                lastSyncedAt: '2026-10-16T21:17:05Z'
                createdAt: '2026-10-06T08:58:02Z'
                updatedAt: '2026-10-06T18:51:11Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.listBrands()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.list_brands()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Brands.ListBrands(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().listBrands();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.list_brands
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.ListBrandsAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->listBrands();
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Brands
      summary: Retrieve a brand
      description: 'Returns one brand after refreshing its `stage`, `registrationStatus`, `brandIdentityStatus` and `rejectionReasons`
        from the US 10DLC registry. The refresh is best-effort: if the registry is slow to answer, you get the stored record
        and `lastSyncedAt` tells you how fresh it is. Poll this endpoint (or listen for the `10dlc.brand.updated` WebSocket
        event) after registering to follow the review.'
      operationId: get-brand
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '200':
          description: The brand with its current registry state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Brand'
              example:
                id: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                accountId: MA_XXXXXXXX
                name: Example Corp
                legalName: Example Corporation Inc.
                brandType: TENDLC_PRIVATE_COMPANY
                stage: SUBMITTED
                registrationStatus: ACTIVE
                brandIdentityStatus: VERIFIED
                website: https://example.com
                supportEmail: support@example.com
                supportPhone: '+14155550100'
                vertical: TECHNOLOGY
                taxId: 12-3456789
                taxIdIssuingCountry: US
                countryCode: US
                address:
                  street: 100 Example Street
                  city: San Francisco
                  state: CA
                  zipCode: '94105'
                businessContactFirstName: Alex
                businessContactLastName: Doe
                businessContactEmail: alex.doe@example.com
                legalEntityType: PRIVATE_COMPANY
                lastSyncedAt: '2026-10-16T21:17:05Z'
                createdAt: '2026-10-06T08:58:02Z'
                updatedAt: '2026-10-06T18:51:11Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.getBrand({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.get_brand(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetBrandRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.GetBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().getBrand(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              GetBrandRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.get_brand(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.GetBrandAsync(
              new GetBrandRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->getBrand(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
    put:
      tags:
      - 10DLC Brands
      summary: Update a brand
      description: 'Replaces the brand with the body you send and pushes the change to the US 10DLC registry. This is a full
        replacement, not a patch: send the same shape as create, including `name` and `brandType`, and any field you leave
        out is cleared. `referenceId` is not used on update. Use it to correct a brand before registering it, or to fix the
        points listed in `rejectionReasons` before resubmitting.'
      operationId: update-brand
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandRequest'
            example:
              name: Example Corp
              legalName: Example Corporation Inc.
              brandType: TENDLC_PRIVATE_COMPANY
              legalEntityType: PRIVATE_COMPANY
              vertical: TECHNOLOGY
              website: https://example.com
              supportEmail: help@example.com
              supportPhone: '+14155550100'
              taxId: 12-3456789
              taxIdIssuingCountry: US
              countryCode: US
              address:
                street: 100 Example Street
                city: San Francisco
                state: CA
                zipCode: '94105'
              businessContactFirstName: Alex
              businessContactLastName: Doe
              businessContactEmail: alex.doe@example.com
      responses:
        '200':
          description: The updated brand.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Brand'
              example:
                id: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                accountId: MA_XXXXXXXX
                name: Example Corp
                legalName: Example Corporation Inc.
                brandType: TENDLC_PRIVATE_COMPANY
                stage: DRAFT
                website: https://example.com
                supportEmail: help@example.com
                supportPhone: '+14155550100'
                vertical: TECHNOLOGY
                taxId: 12-3456789
                taxIdIssuingCountry: US
                countryCode: US
                address:
                  street: 100 Example Street
                  city: San Francisco
                  state: CA
                  zipCode: '94105'
                businessContactFirstName: Alex
                businessContactLastName: Doe
                businessContactEmail: alex.doe@example.com
                legalEntityType: PRIVATE_COMPANY
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:02:45Z'
        '400':
          description: Invalid body or a missing required field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: name is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry rejected the update. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: brand is under review; wait for the registrar''s decision'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.updateBrand({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              body: {
                  name: "Example Corp",
                  legalName: "Example Corporation Inc.",
                  brandType: "TENDLC_PRIVATE_COMPANY",
                  website: "https://example.com",
                  supportEmail: "help@example.com",
                  supportPhone: "+14155550100",
                  vertical: "TECHNOLOGY",
                  taxId: "12-3456789",
                  taxIdIssuingCountry: "US",
                  countryCode: "US",
                  address: {
                      street: "100 Example Street",
                      city: "San Francisco",
                      state: "CA",
                      zipCode: "94105"
                  },
                  businessContactFirstName: "Alex",
                  businessContactLastName: "Doe",
                  businessContactEmail: "alex.doe@example.com",
                  legalEntityType: "PRIVATE_COMPANY"
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          from vobiz.sms import BrandAddress

          client.sms.brands.update_brand(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              name="Example Corp",
              legal_name="Example Corporation Inc.",
              brand_type="TENDLC_PRIVATE_COMPANY",
              website="https://example.com",
              support_email="help@example.com",
              support_phone="+14155550100",
              vertical="TECHNOLOGY",
              tax_id="12-3456789",
              tax_id_issuing_country="US",
              country_code="US",
              address=BrandAddress(
                  street="100 Example Street",
                  city="San Francisco",
                  state="CA",
                  zip_code="94105",
              ),
              business_contact_first_name="Alex",
              business_contact_last_name="Doe",
              business_contact_email="alex.doe@example.com",
              legal_entity_type="PRIVATE_COMPANY",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateBrandRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                  Body: &sms.CreateBrandRequest{
                      Name: "Example Corp",
                      LegalName: vobiz.String(
                          "Example Corporation Inc.",
                      ),
                      BrandType: sms.CreateBrandRequestBrandTypeTendlcPrivateCompany,
                      Website: vobiz.String(
                          "https://example.com",
                      ),
                      SupportEmail: vobiz.String(
                          "help@example.com",
                      ),
                      SupportPhone: vobiz.String(
                          "+14155550100",
                      ),
                      Vertical: vobiz.String(
                          "TECHNOLOGY",
                      ),
                      TaxID: vobiz.String(
                          "12-3456789",
                      ),
                      TaxIDIssuingCountry: vobiz.String(
                          "US",
                      ),
                      CountryCode: vobiz.String(
                          "US",
                      ),
                      Address: &sms.BrandAddress{
                          Street: vobiz.String(
                              "100 Example Street",
                          ),
                          City: vobiz.String(
                              "San Francisco",
                          ),
                          State: vobiz.String(
                              "CA",
                          ),
                          ZipCode: vobiz.String(
                              "94105",
                          ),
                      },
                      BusinessContactFirstName: vobiz.String(
                          "Alex",
                      ),
                      BusinessContactLastName: vobiz.String(
                          "Doe",
                      ),
                      BusinessContactEmail: vobiz.String(
                          "alex.doe@example.com",
                      ),
                      LegalEntityType: vobiz.String(
                          "PRIVATE_COMPANY",
                      ),
                  },
              }
          c.Sms.Brands.UpdateBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().updateBrand(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              UpdateBrandRequest
                  .builder()
                  .body(
                      CreateBrandRequest
                          .builder()
                          .name("Example Corp")
                          .brandType(CreateBrandRequestBrandType.TENDLC_PRIVATE_COMPANY)
                          .legalName("Example Corporation Inc.")
                          .website("https://example.com")
                          .supportEmail("help@example.com")
                          .supportPhone("+14155550100")
                          .vertical("TECHNOLOGY")
                          .taxId("12-3456789")
                          .taxIdIssuingCountry("US")
                          .countryCode("US")
                          .address(
                              BrandAddress
                                  .builder()
                                  .street("100 Example Street")
                                  .city("San Francisco")
                                  .state("CA")
                                  .zipCode("94105")
                                  .build()
                          )
                          .businessContactFirstName("Alex")
                          .businessContactLastName("Doe")
                          .businessContactEmail("alex.doe@example.com")
                          .legalEntityType("PRIVATE_COMPANY")
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.update_brand(
            id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
            name: "Example Corp",
            legal_name: "Example Corporation Inc.",
            brand_type: "TENDLC_PRIVATE_COMPANY",
            website: "https://example.com",
            support_email: "help@example.com",
            support_phone: "+14155550100",
            vertical: "TECHNOLOGY",
            tax_id: "12-3456789",
            tax_id_issuing_country: "US",
            country_code: "US",
            address: {
              street: "100 Example Street",
              city: "San Francisco",
              state: "CA",
              zip_code: "94105"
            },
            business_contact_first_name: "Alex",
            business_contact_last_name: "Doe",
            business_contact_email: "alex.doe@example.com",
            legal_entity_type: "PRIVATE_COMPANY"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.UpdateBrandAsync(
              new UpdateBrandRequest
              {
                  Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                  Body = new CreateBrandRequest
                  {
                      Name = "Example Corp",
                      LegalName = "Example Corporation Inc.",
                      BrandType = CreateBrandRequestBrandType.TendlcPrivateCompany,
                      Website = "https://example.com",
                      SupportEmail = "help@example.com",
                      SupportPhone = "+14155550100",
                      Vertical = "TECHNOLOGY",
                      TaxId = "12-3456789",
                      TaxIdIssuingCountry = "US",
                      CountryCode = "US",
                      Address = new BrandAddress
                      {
                          Street = "100 Example Street",
                          City = "San Francisco",
                          State = "CA",
                          ZipCode = "94105",
                      },
                      BusinessContactFirstName = "Alex",
                      BusinessContactLastName = "Doe",
                      BusinessContactEmail = "alex.doe@example.com",
                      LegalEntityType = "PRIVATE_COMPANY",
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->updateBrand(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
              new UpdateBrandRequest([
                  'body' => new CreateBrandRequest([
                      'name' => 'Example Corp',
                      'legalName' => 'Example Corporation Inc.',
                      'brandType' => CreateBrandRequestBrandType::TendlcPrivateCompany->value,
                      'website' => 'https://example.com',
                      'supportEmail' => 'help@example.com',
                      'supportPhone' => '+14155550100',
                      'vertical' => 'TECHNOLOGY',
                      'taxId' => '12-3456789',
                      'taxIdIssuingCountry' => 'US',
                      'countryCode' => 'US',
                      'address' => new BrandAddress([
                          'street' => '100 Example Street',
                          'city' => 'San Francisco',
                          'state' => 'CA',
                          'zipCode' => '94105',
                      ]),
                      'businessContactFirstName' => 'Alex',
                      'businessContactLastName' => 'Doe',
                      'businessContactEmail' => 'alex.doe@example.com',
                      'legalEntityType' => 'PRIVATE_COMPANY',
                  ]),
              ]),
          );
    delete:
      tags:
      - 10DLC Brands
      summary: Delete a brand
      description: 'Deletes the brand from your account and from the US 10DLC registry and returns `204` with no body. A brand
        that still owns campaigns returns `409` with `conflict: brand still has N campaign(s); delete them first`, so delete
        or deregister its campaigns first. Deletion cannot be undone; a new brand needs a new registration.'
      operationId: delete-brand
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '204':
          description: The brand was deleted. No body.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '409':
          description: The brand still has campaigns.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'conflict: brand still has 2 campaign(s); delete them first'
        '422':
          description: The US 10DLC registry declined the deletion. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: brand has active campaigns'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.deleteBrand({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.delete_brand(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteBrandRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.DeleteBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().deleteBrand(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              DeleteBrandRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.delete_brand(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.DeleteBrandAsync(
              new DeleteBrandRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->deleteBrand(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/Register/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Brands
      summary: Register a brand
      description: Submits the brand to the US 10DLC registry for identity verification. The brand moves from `DRAFT` to `SUBMITTED`
        and `registrationStatus` starts tracking the registrar's decision (`PENDING`, then `ACTIVE` or `REJECTED`). The request
        has no body and returns the refreshed brand. Submit only when the brand details are final and you intend to register
        this business. Follow progress with `GET /TenDlc/Brand/{id}/` or `GET /TenDlc/Brand/{id}/RegistrarStatuses/`.
      operationId: register-brand
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '200':
          description: The brand after submission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Brand'
              example:
                id: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                accountId: MA_XXXXXXXX
                name: Example Corp
                legalName: Example Corporation Inc.
                brandType: TENDLC_PRIVATE_COMPANY
                stage: SUBMITTED
                registrationStatus: PENDING
                brandIdentityStatus: UNVERIFIED
                website: https://example.com
                supportEmail: support@example.com
                supportPhone: '+14155550100'
                vertical: TECHNOLOGY
                taxId: 12-3456789
                taxIdIssuingCountry: US
                countryCode: US
                businessContactFirstName: Alex
                businessContactLastName: Doe
                legalEntityType: PRIVATE_COMPANY
                lastSyncedAt: '2026-10-12T11:05:00Z'
                createdAt: '2026-10-12T10:30:00Z'
                updatedAt: '2026-10-12T11:05:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry rejected the submission. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: taxId is required for TENDLC_PRIVATE_COMPANY'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '503':
          description: Registration is temporarily unavailable. Retry later or contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.registerBrand({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.register_brand(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.RegisterBrandRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.RegisterBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().registerBrand(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              RegisterBrandRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.register_brand(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.RegisterBrandAsync(
              new RegisterBrandRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->registerBrand(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/RegistrarStatuses/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Brands
      summary: List brand registrar statuses
      description: Returns the brand's state at each registrar that has reviewed it, read live from the US 10DLC registry.
        Each entry carries the registrar's `state` and, when the registrar reports them, the identity result, the authentication
        status and a rejection reason. An empty array means no registrar has recorded a state yet. Use it to see why a brand
        is pending or rejected.
      operationId: brand-registrar-statuses
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '200':
          description: One entry per registrar.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BrandRegistrarStatus'
              example:
              - registrar: TCR
                state: ACTIVE
                brandIdentityStatus: VERIFIED
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found on your account or at the registry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              examples:
                account:
                  summary: Not on your account
                  value:
                    error: brand not found
                registry:
                  summary: Not found at the registry
                  value:
                    error: 'registration provider rejected the request: Requested brand not found'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.brandRegistrarStatuses({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.brand_registrar_statuses(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.BrandRegistrarStatusesRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.BrandRegistrarStatuses(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().brandRegistrarStatuses(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              BrandRegistrarStatusesRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.brand_registrar_statuses(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.BrandRegistrarStatusesAsync(
              new BrandRegistrarStatusesRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->brandRegistrarStatuses(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/BrandAuthVerification/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Brands
      summary: Request brand authentication
      description: 'Starts the registry''s brand authentication for a brand whose `brandType` is `TENDLC_PUBLIC_COMPANY`.
        The registry sends a two-factor verification request to the brand''s `businessContactEmail`, and the brand shows `registrationStatus`
        `PENDING_2FA` until the contact completes it. The request has no body and returns `202` with `{"status":"requested"}`.
        Any other brand type returns `400` with `invalid request: brand authentication is only available for TENDLC_PUBLIC_COMPANY
        brands`.'
      operationId: brand-auth-verification
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '202':
          description: The request was accepted. Track progress with `GET /TenDlc/Brand/{id}/RegistrarStatuses/`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAuthRequested'
              example:
                status: requested
        '400':
          description: The brand is not a public company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: brand authentication is only available for TENDLC_PUBLIC_COMPANY brands'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: brand is not yet submitted'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.brandAuthVerification({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.brand_auth_verification(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.BrandAuthVerificationRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.BrandAuthVerification(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().brandAuthVerification(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              BrandAuthVerificationRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.brand_auth_verification(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.BrandAuthVerificationAsync(
              new BrandAuthVerificationRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->brandAuthVerification(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/Resend2fa/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Brands
      summary: Resend brand 2FA verification
      description: Asks the registry to send the brand-authentication verification again to the brand's `businessContactEmail`.
        Use it when a `TENDLC_PUBLIC_COMPANY` brand is `PENDING_2FA` and the contact did not receive or let the first request
        expire. The request has no body and returns `202` with `{"status":"requested"}`. Any other brand type returns `400`.
      operationId: resend-2fa
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '202':
          description: The request was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAuthRequested'
              example:
                status: requested
        '400':
          description: The brand is not a public company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: brand authentication is only available for TENDLC_PUBLIC_COMPANY brands'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: no pending 2FA for this brand'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.resend2Fa({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.resend2fa(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.Resend2FaRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.Resend2Fa(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().resend2Fa(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              Resend2FaRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.resend2fa(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.Resend2FaAsync(
              new Resend2FaRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->resend2Fa(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/Vet/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Brands
      summary: Vet a brand
      description: Requests an external vet of a registered brand from the US 10DLC registry. A successful vet can raise the
        brand's trust tier and, with it, the throughput carriers grant its campaigns. `type` defaults to `STANDARD`; any value
        other than `STANDARD`, `ENHANCED` or `POLITICAL` returns `400`. Every call files a new vetting request, so send it
        only when you intend to. The response is the registry's vetting record, returned as received; list past vets with
        `GET /TenDlc/Brand/{id}/Vets/`.
      operationId: vet-brand
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandVetRequest'
            example:
              type: STANDARD
      responses:
        '200':
          description: The registry's vetting record. Keys follow the registry's schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryRecord'
              example:
                vettingId: 4b3a2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d
                vettingClass: STANDARD
                vettingStatus: PENDING
                createDate: '2026-10-12T11:10:00Z'
        '400':
          description: '`type` is not one of the accepted values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: type must be one of STANDARD, ENHANCED, POLITICAL'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry declined the vet. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: brand must be registered before vetting'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.vetBrand({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              type: "STANDARD"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.vet_brand(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              type="STANDARD",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.BrandVetRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                  Type: sms.BrandVetRequestTypeStandard.Ptr(),
              }
          c.Sms.Brands.VetBrand(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().vetBrand(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              BrandVetRequest
                  .builder()
                  .type(BrandVetRequestType.STANDARD)
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.vet_brand(
            id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
            type: "STANDARD"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.VetBrandAsync(
              new BrandVetRequest
              {
                  Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                  Type = BrandVetRequestType.Standard,
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->vetBrand(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
              new BrandVetRequest([
                  'type' => BrandVetRequestType::Standard->value,
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Brand/{id}/Vets/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Brands
      summary: List brand vets
      description: 'Returns the brand''s vetting records from the US 10DLC registry, one page at a time. The body is `{"results":
        [...], "paging": {...}}`, where each result is a registry vetting record passed through as received. `page` must be
        0 or more and `size` between 0 and 100; other values return `400` with `page must be >= 0 and size between 0 and 100`.'
      operationId: list-brand-vets
      parameters:
      - name: id
        in: path
        required: true
        description: Brand ID (UUID) returned by `POST /TenDlc/Brand/`. An unknown ID, an ID from another account, or a value
          that is not a UUID returns `404` with `{"error":"brand not found"}`.
        schema:
          type: string
          format: uuid
        example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      - name: page
        in: query
        description: Zero-based page index. Defaults to `0`. Must be 0 or more; a negative value returns `400`. A value that
          is not an integer is treated as `0`.
        schema:
          type: integer
          minimum: 0
          default: 0
      - name: size
        in: query
        description: Records per page, from 0 to 100. Defaults to `20`; `0` or a value that is not an integer also gives the
          default page size. A value above 100 returns `400`.
        schema:
          type: integer
          minimum: 0
          maximum: 100
          default: 20
      responses:
        '200':
          description: Vetting records for the brand, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandVetList'
              example:
                results: []
                paging:
                  page: 0
                  size: 10
                  totalPages: 0
                  totalResults: 0
        '400':
          description: '`page` or `size` is out of range.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: page must be >= 0 and size between 0 and 100
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The brand wasn't found on your account or at the registry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              examples:
                account:
                  summary: Not on your account
                  value:
                    error: brand not found
                registry:
                  summary: Not found at the registry
                  value:
                    error: 'registration provider rejected the request: Requested brand not found'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.brands.listBrandVets({
              id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.brands.list_brand_vets(
              id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListBrandVetsRequest{
                  ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              }
          c.Sms.Brands.ListBrandVets(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().brands().listBrandVets(
              "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
              ListBrandVetsRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.brands.list_brand_vets(id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Brands.ListBrandVetsAsync(
              new ListBrandVetsRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->brands->listBrandVets(
              '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
              new ListBrandVetsRequest([]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Create a campaign
      description: Creates a 10DLC campaign, the messaging program you run under one of your brands, and mirrors it to the
        US 10DLC registry in `DRAFT` stage. `name` and `brandId` are required; `campaignType` defaults to `TEN_DIGIT_LONG_CODE`.
        Upload any `supportingDocuments` or `mmsSampleFiles` with `POST /TenDlc/Document/` first. Pass a `referenceId` so a
        retried request reconciles to the same campaign. Next, submit the campaign with `POST /TenDlc/Campaign/{id}/Register/`;
        toll-free verification uses `POST /TenDlc/Campaign/TollFree/` instead.
      operationId: create-campaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCampaignRequest'
            example:
              referenceId: campaign-account-alerts-01
              brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
              name: Example Corp account alerts
              campaignType: TEN_DIGIT_LONG_CODE
              useCases:
              - ALERTS
              messageTypes:
              - SMS
              programSummary: Example Corp sends account and support alerts to customers who opted in on the sign-up form.
                Reply STOP to opt out, HELP for help.
              confirmationMessage: 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates
                may apply. Reply HELP for help, STOP to opt out.'
              helpMessage: 'Example Corp: For help email support@example.com. Reply STOP to opt out.'
              stopMessage: 'Example Corp: You have been unsubscribed. Reply HELP for help.'
              exampleMessages:
              - 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP
                to opt out.'
              - 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out.'
              customerCarePhone: '+14155550100'
              customerCareEmail: support@example.com
              termsAndConditionsUrl: https://example.com/terms
              privacyPolicyUrl: https://example.com/privacy
              optIns:
                web:
                  url: https://example.com/signup
                  callToAction: By checking this box you agree to receive account alerts from Example Corp. Msg frequency
                    varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.
              lowVolume: true
              embeddedLink: true
              numbers:
              - '14155550100'
      responses:
        '201':
          description: The campaign was created in `DRAFT` stage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: DRAFT
                programSummary: Example Corp sends account and support alerts to customers who opted in on the sign-up form.
                  Reply STOP to opt out, HELP for help.
                confirmationMessage: 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data
                  rates may apply. Reply HELP for help, STOP to opt out.'
                helpMessage: 'Example Corp: For help email support@example.com. Reply STOP to opt out.'
                stopMessage: 'Example Corp: You have been unsubscribed. Reply HELP for help.'
                customerCarePhone: '+14155550100'
                customerCareEmail: support@example.com
                exampleMessages:
                - 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP
                  to opt out.'
                - 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out.'
                termsAndConditionsUrl: https://example.com/terms
                privacyPolicyUrl: https://example.com/privacy
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                optIns:
                  web:
                    url: https://example.com/signup
                    callToAction: By checking this box you agree to receive account alerts from Example Corp. Msg frequency
                      varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                numbers:
                - '14155550100'
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-06T14:28:25Z'
        '400':
          description: Invalid body, a toll-free `campaignType`, or a document that is not on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                name:
                  value:
                    error: 'invalid request: name is required'
                tollFree:
                  value:
                    error: 'invalid request: toll-free campaigns use POST /v1/10dlc/campaigns/toll-free'
                documents:
                  value:
                    error: 'invalid request: supportingDocuments/mmsSampleFiles reference unknown documents; upload them via
                      POST /v1/10dlc/documents first'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: '`brandId` is not a brand on your account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: The US 10DLC registry rejected the campaign. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: maximum number of campaigns reached for this brand'
        '502':
          description: The US 10DLC registry did not answer. Retry with the same `referenceId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '503':
          description: Registration is temporarily unavailable. Retry later or contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.createCampaign({
              name: "Example Corp account alerts",
              programSummary: "Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
              confirmationMessage: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
              helpMessage: "Example Corp: For help email support@example.com. Reply STOP to opt out.",
              stopMessage: "Example Corp: You have been unsubscribed. Reply HELP for help.",
              customerCarePhone: "+14155550100",
              customerCareEmail: "support@example.com",
              termsAndConditionsUrl: "https://example.com/terms",
              privacyPolicyUrl: "https://example.com/privacy",
              exampleMessages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.", "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out."],
              useCases: ["ALERTS"],
              messageTypes: ["SMS"],
              optIns: {
                  "web": {
                      "url": "https://example.com/signup",
                      "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."
                  }
              },
              lowVolume: true,
              embeddedLink: true,
              numbers: ["14155550100"],
              referenceId: "campaign-account-alerts-01",
              brandId: "5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60",
              campaignType: "TEN_DIGIT_LONG_CODE"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.create_campaign(
              name="Example Corp account alerts",
              program_summary="Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
              confirmation_message="Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
              help_message="Example Corp: For help email support@example.com. Reply STOP to opt out.",
              stop_message="Example Corp: You have been unsubscribed. Reply HELP for help.",
              customer_care_phone="+14155550100",
              customer_care_email="support@example.com",
              terms_and_conditions_url="https://example.com/terms",
              privacy_policy_url="https://example.com/privacy",
              example_messages=[
                  "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.",
                  "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out."
              ],
              use_cases=[
                  "ALERTS"
              ],
              message_types=[
                  "SMS"
              ],
              opt_ins={
                  "web": {"url": "https://example.com/signup", "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."}
              },
              low_volume=True,
              embedded_link=True,
              numbers=[
                  "14155550100"
              ],
              reference_id="campaign-account-alerts-01",
              brand_id="5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60",
              campaign_type="TEN_DIGIT_LONG_CODE",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CreateCampaignRequest{
                  Name: vobiz.String(
                      "Example Corp account alerts",
                  ),
                  ProgramSummary: vobiz.String(
                      "Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
                  ),
                  ConfirmationMessage: vobiz.String(
                      "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
                  ),
                  HelpMessage: vobiz.String(
                      "Example Corp: For help email support@example.com. Reply STOP to opt out.",
                  ),
                  StopMessage: vobiz.String(
                      "Example Corp: You have been unsubscribed. Reply HELP for help.",
                  ),
                  CustomerCarePhone: vobiz.String(
                      "+14155550100",
                  ),
                  CustomerCareEmail: vobiz.String(
                      "support@example.com",
                  ),
                  TermsAndConditionsURL: vobiz.String(
                      "https://example.com/terms",
                  ),
                  PrivacyPolicyURL: vobiz.String(
                      "https://example.com/privacy",
                  ),
                  ExampleMessages: []string{
                      "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.",
                      "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out.",
                  },
                  UseCases: []string{
                      "ALERTS",
                  },
                  MessageTypes: []string{
                      "SMS",
                  },
                  OptIns: map[string]any{
                      "web": map[string]any{
                          "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.",
                          "url": "https://example.com/signup",
                      },
                  },
                  LowVolume: vobiz.Bool(
                      true,
                  ),
                  EmbeddedLink: vobiz.Bool(
                      true,
                  ),
                  Numbers: []string{
                      "14155550100",
                  },
                  ReferenceID: vobiz.String(
                      "campaign-account-alerts-01",
                  ),
                  BrandID: "5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60",
                  CampaignType: sms.CreateCampaignRequestCampaignTypeTenDigitLongCode.Ptr(),
              }
          c.Sms.Campaigns.CreateCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: "import com.vobiz.api.VobizApiClient;\n\nVobizApiClient client = VobizApiClient\n    .builder()\n    .apiKey(\"\
          MA_XXXXXXXX\")\n    .authToken(\"YOUR_AUTH_TOKEN\")\n    .build();\n\nclient.sms().campaigns().createCampaign(\n\
          \    CreateCampaignRequest\n        .builder()\n        .brandId(\"5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60\")\n   \
          \     .name(\"Example Corp account alerts\")\n        .programSummary(\"Example Corp sends account and support alerts\
          \ to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.\")\n        .confirmationMessage(\"\
          Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP\
          \ for help, STOP to opt out.\")\n        .helpMessage(\"Example Corp: For help email support@example.com. Reply\
          \ STOP to opt out.\")\n        .stopMessage(\"Example Corp: You have been unsubscribed. Reply HELP for help.\")\n\
          \        .customerCarePhone(\"+14155550100\")\n        .customerCareEmail(\"support@example.com\")\n        .termsAndConditionsUrl(\"\
          https://example.com/terms\")\n        .privacyPolicyUrl(\"https://example.com/privacy\")\n        .exampleMessages(\n\
          \            Optional.of(\n                Arrays.asList(\"Example Corp: Your support ticket #48213 was updated.\
          \ View it at https://example.com/support. Reply STOP to opt out.\", \"Example Corp: Your account balance is low.\
          \ Add funds at https://example.com/wallet. Reply STOP to opt out.\")\n            )\n        )\n        .useCases(\n\
          \            Optional.of(\n                Arrays.asList(\"ALERTS\")\n            )\n        )\n        .messageTypes(\n\
          \            Optional.of(\n                Arrays.asList(\"SMS\")\n            )\n        )\n        .optIns(\n\
          \            new HashMap<String, Object>() {{\n                put(\"web\", new \n                HashMap<String,\
          \ Object>() {{put(\"url\", \"https://example.com/signup\");\n                    put(\"callToAction\", \"By checking\
          \ this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply.\
          \ Reply STOP to opt out, HELP for help.\");\n                }});\n            }}\n        )\n        .lowVolume(true)\n\
          \        .embeddedLink(true)\n        .numbers(\n            Optional.of(\n                Arrays.asList(\"14155550100\"\
          )\n            )\n        )\n        .referenceId(\"campaign-account-alerts-01\")\n        .campaignType(CreateCampaignRequestCampaignType.TEN_DIGIT_LONG_CODE)\n\
          \        .build()\n);\n"
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.create_campaign(
            name: "Example Corp account alerts",
            program_summary: "Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
            confirmation_message: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
            help_message: "Example Corp: For help email support@example.com. Reply STOP to opt out.",
            stop_message: "Example Corp: You have been unsubscribed. Reply HELP for help.",
            customer_care_phone: "+14155550100",
            customer_care_email: "support@example.com",
            terms_and_conditions_url: "https://example.com/terms",
            privacy_policy_url: "https://example.com/privacy",
            example_messages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.", "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out."],
            use_cases: ["ALERTS"],
            message_types: ["SMS"],
            opt_ins: {},
            low_volume: true,
            embedded_link: true,
            numbers: ["14155550100"],
            reference_id: "campaign-account-alerts-01",
            brand_id: "5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60",
            campaign_type: "TEN_DIGIT_LONG_CODE"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.CreateCampaignAsync(
              new CreateCampaignRequest
              {
                  Name = "Example Corp account alerts",
                  ProgramSummary =
                      "Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
                  ConfirmationMessage =
                      "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
                  HelpMessage = "Example Corp: For help email support@example.com. Reply STOP to opt out.",
                  StopMessage = "Example Corp: You have been unsubscribed. Reply HELP for help.",
                  CustomerCarePhone = "+14155550100",
                  CustomerCareEmail = "support@example.com",
                  TermsAndConditionsUrl = "https://example.com/terms",
                  PrivacyPolicyUrl = "https://example.com/privacy",
                  ExampleMessages = new List<string>()
                  {
                      "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.",
                      "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out.",
                  },
                  UseCases = new List<string>() { "ALERTS" },
                  MessageTypes = new List<string>() { "SMS" },
                  OptIns = new Dictionary<string, object?>()
                  {
                      {
                          "web",
                          new Dictionary<object, object?>()
                          {
                              {
                                  "callToAction",
                                  "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."
                              },
                              { "url", "https://example.com/signup" },
                          }
                      },
                  },
                  LowVolume = true,
                  EmbeddedLink = true,
                  Numbers = new List<string>() { "14155550100" },
                  ReferenceId = "campaign-account-alerts-01",
                  BrandId = "5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60",
                  CampaignType = CreateCampaignRequestCampaignType.TenDigitLongCode,
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->createCampaign(
              new CreateCampaignRequest([
                  'name' => 'Example Corp account alerts',
                  'programSummary' => 'Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.',
                  'confirmationMessage' => 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.',
                  'helpMessage' => 'Example Corp: For help email support@example.com. Reply STOP to opt out.',
                  'stopMessage' => 'Example Corp: You have been unsubscribed. Reply HELP for help.',
                  'customerCarePhone' => '+14155550100',
                  'customerCareEmail' => 'support@example.com',
                  'termsAndConditionsUrl' => 'https://example.com/terms',
                  'privacyPolicyUrl' => 'https://example.com/privacy',
                  'exampleMessages' => [
                      'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.',
                      'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out.',
                  ],
                  'useCases' => [
                      'ALERTS',
                  ],
                  'messageTypes' => [
                      'SMS',
                  ],
                  'optIns' => [
                      'web' => [
                          'url' => "https://example.com/signup",
                          'callToAction' => "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.",
                      ],
                  ],
                  'lowVolume' => true,
                  'embeddedLink' => true,
                  'numbers' => [
                      '14155550100',
                  ],
                  'referenceId' => 'campaign-account-alerts-01',
                  'brandId' => '5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60',
                  'campaignType' => CreateCampaignRequestCampaignType::TenDigitLongCode->value,
              ]),
          );
    get:
      tags:
      - 10DLC Campaigns
      summary: List campaigns
      description: Returns every 10DLC and toll-free campaign on your account as a bare JSON array, newest first. The list
        is not paginated and reads the records stored on your account without contacting the registry. Toll-free campaigns
        have `campaignType` `TOLL_FREE_UNIFIED_NUMBER` and no `brandId`. Call `GET /TenDlc/Campaign/{id}/` for the latest registry
        state of one campaign.
      operationId: list-campaigns
      responses:
        '200':
          description: All campaigns on your account.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Campaign'
              example:
              - id: 9c1b3e5f-7a2d-4b8c-a0e1-2f3d4c5b6a72
                accountId: MA_XXXXXXXX
                name: Example Corp toll-free notifications
                campaignType: TOLL_FREE_UNIFIED_NUMBER
                stage: IN_REVIEW
                programSummary: Example Corp sends account and support notifications to customers who opted in on the contact
                  form.
                customerCarePhone: '+14155550100'
                customerCareEmail: support@example.com
                exampleMessages:
                - 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out,
                  HELP for help.'
                termsAndConditionsUrl: https://example.com/terms
                privacyPolicyUrl: https://example.com/privacy
                useCases:
                - NOTIFICATIONS
                optIns:
                  web:
                    url: https://example.com/contact
                    callToAction: By checking this box you agree to receive account notifications from Example Corp. Reply
                      STOP to opt out, HELP for help.
                lowVolume: false
                ageGated: false
                directLending: false
                embeddedLink: false
                embeddedPhone: false
                numbers:
                - '+18335550100'
                lastSyncedAt: '2026-10-17T08:46:46Z'
                createdAt: '2026-10-08T04:36:40Z'
                updatedAt: '2026-10-15T19:19:02Z'
              - id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: REGISTERED
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                numbers:
                - '14155550100'
                lastSyncedAt: '2026-10-17T08:46:48Z'
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-14T17:19:03Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.listCampaigns()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.list_campaigns()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Campaigns.ListCampaigns(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().listCampaigns();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.list_campaigns
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.ListCampaignsAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->listCampaigns();
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/TollFree/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Create a toll-free campaign
      description: Starts toll-free verification for one or more toll-free numbers. The business details travel inside the
        request, so no brand is needed; only `name` is required, but the registry reviews every field you send. The campaign
        is created with `campaignType` `TOLL_FREE_UNIFIED_NUMBER` and no `brandId`. Pass a `referenceId` so a retried request
        reconciles to the same campaign, then submit it with `POST /TenDlc/Campaign/{id}/Register/`.
      operationId: create-toll-free-campaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TollFreeCampaignRequest'
            example:
              referenceId: tollfree-notifications-01
              name: Example Corp toll-free notifications
              useCase: NOTIFICATIONS
              messageVolume: TEN_THOUSAND
              numbers:
              - '+18335550100'
              programSummary: Example Corp sends account and support notifications to customers who opted in on the contact
                form. Reply STOP to opt out, HELP for help.
              exampleMessage: 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP
                to opt out, HELP for help.'
              optIns:
                web:
                  url: https://example.com/contact
                  callToAction: By checking this box you agree to receive account notifications from Example Corp. Reply STOP
                    to opt out, HELP for help.
              optInImageURLs:
              - https://example.com/opt-in-screenshot.png
              privacyPolicyUrl: https://example.com/privacy
              termsAndConditionsUrl: https://example.com/terms
              legalName: Example Corporation Inc.
              businessName: Example Corp
              businessWebsite: https://example.com
              countryCode: US
              address:
                street: 100 Example Street
                city: San Francisco
                state: CA
                zipCode: '94105'
              businessContactFirstName: Alex
              businessContactLastName: Doe
              supportPhone: '+14155550100'
              supportEmail: support@example.com
              customerCareEmail: support@example.com
              taxId: 12-3456789
              taxIdIssuingCountry: US
              legalEntityType: PRIVATE_COMPANY
      responses:
        '201':
          description: The toll-free campaign was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 9c1b3e5f-7a2d-4b8c-a0e1-2f3d4c5b6a72
                accountId: MA_XXXXXXXX
                name: Example Corp toll-free notifications
                campaignType: TOLL_FREE_UNIFIED_NUMBER
                stage: DRAFT
                programSummary: Example Corp sends account and support notifications to customers who opted in on the contact
                  form. Reply STOP to opt out, HELP for help.
                customerCarePhone: '+14155550100'
                customerCareEmail: support@example.com
                exampleMessages:
                - 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out,
                  HELP for help.'
                termsAndConditionsUrl: https://example.com/terms
                privacyPolicyUrl: https://example.com/privacy
                useCases:
                - NOTIFICATIONS
                optIns:
                  web:
                    url: https://example.com/contact
                    callToAction: By checking this box you agree to receive account notifications from Example Corp. Reply
                      STOP to opt out, HELP for help.
                lowVolume: false
                ageGated: false
                directLending: false
                embeddedLink: false
                embeddedPhone: false
                numbers:
                - '+18335550100'
                createdAt: '2026-10-08T04:36:40Z'
                updatedAt: '2026-10-08T04:36:40Z'
        '400':
          description: Invalid body, a missing `name`, or a `priorityId` that is not a UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                name:
                  value:
                    error: 'invalid request: name is required'
                priorityId:
                  value:
                    error: 'invalid request: priorityId must be a UUID'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The US 10DLC registry rejected the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: number +18335550100 is already in a verification'
        '502':
          description: The US 10DLC registry did not answer. Retry with the same `referenceId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '503':
          description: Registration is temporarily unavailable. Retry later or contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.createTollFreeCampaign({
              referenceId: "tollfree-notifications-01",
              name: "Example Corp toll-free notifications",
              privacyPolicyUrl: "https://example.com/privacy",
              termsAndConditionsUrl: "https://example.com/terms",
              messageVolume: "TEN_THOUSAND",
              numbers: ["+18335550100"],
              useCase: "NOTIFICATIONS",
              programSummary: "Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.",
              exampleMessage: "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.",
              optIns: {
                  "web": {
                      "url": "https://example.com/contact",
                      "callToAction": "By checking this box you agree to receive account notifications from Example Corp. Reply STOP to opt out, HELP for help."
                  }
              },
              optInImageURLs: ["https://example.com/opt-in-screenshot.png"],
              countryCode: "US",
              address: {
                  street: "100 Example Street",
                  city: "San Francisco",
                  state: "CA",
                  zipCode: "94105"
              },
              supportPhone: "+14155550100",
              supportEmail: "support@example.com",
              businessContactFirstName: "Alex",
              businessContactLastName: "Doe",
              legalName: "Example Corporation Inc.",
              businessName: "Example Corp",
              businessWebsite: "https://example.com",
              customerCareEmail: "support@example.com",
              taxId: "12-3456789",
              taxIdIssuingCountry: "US",
              legalEntityType: "PRIVATE_COMPANY"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          from vobiz.sms import BrandAddress

          client.sms.campaigns.create_toll_free_campaign(
              reference_id="tollfree-notifications-01",
              name="Example Corp toll-free notifications",
              privacy_policy_url="https://example.com/privacy",
              terms_and_conditions_url="https://example.com/terms",
              message_volume="TEN_THOUSAND",
              numbers=[
                  "+18335550100"
              ],
              use_case="NOTIFICATIONS",
              program_summary="Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.",
              example_message="Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.",
              opt_ins={
                  "web": {"url": "https://example.com/contact", "callToAction": "By checking this box you agree to receive account notifications from Example Corp. Reply STOP to opt out, HELP for help."}
              },
              opt_in_image_ur_ls=[
                  "https://example.com/opt-in-screenshot.png"
              ],
              country_code="US",
              address=BrandAddress(
                  street="100 Example Street",
                  city="San Francisco",
                  state="CA",
                  zip_code="94105",
              ),
              support_phone="+14155550100",
              support_email="support@example.com",
              business_contact_first_name="Alex",
              business_contact_last_name="Doe",
              legal_name="Example Corporation Inc.",
              business_name="Example Corp",
              business_website="https://example.com",
              customer_care_email="support@example.com",
              tax_id="12-3456789",
              tax_id_issuing_country="US",
              legal_entity_type="PRIVATE_COMPANY",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.TollFreeCampaignRequest{
                  ReferenceID: vobiz.String(
                      "tollfree-notifications-01",
                  ),
                  Name: "Example Corp toll-free notifications",
                  PrivacyPolicyURL: vobiz.String(
                      "https://example.com/privacy",
                  ),
                  TermsAndConditionsURL: vobiz.String(
                      "https://example.com/terms",
                  ),
                  MessageVolume: vobiz.String(
                      "TEN_THOUSAND",
                  ),
                  Numbers: []string{
                      "+18335550100",
                  },
                  UseCase: vobiz.String(
                      "NOTIFICATIONS",
                  ),
                  ProgramSummary: vobiz.String(
                      "Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.",
                  ),
                  ExampleMessage: vobiz.String(
                      "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.",
                  ),
                  OptIns: map[string]any{
                      "web": map[string]any{
                          "callToAction": "By checking this box you agree to receive account notifications from Example Corp. Reply STOP to opt out, HELP for help.",
                          "url": "https://example.com/contact",
                      },
                  },
                  OptInImageUrLs: []string{
                      "https://example.com/opt-in-screenshot.png",
                  },
                  CountryCode: vobiz.String(
                      "US",
                  ),
                  Address: &sms.BrandAddress{
                      Street: vobiz.String(
                          "100 Example Street",
                      ),
                      City: vobiz.String(
                          "San Francisco",
                      ),
                      State: vobiz.String(
                          "CA",
                      ),
                      ZipCode: vobiz.String(
                          "94105",
                      ),
                  },
                  SupportPhone: vobiz.String(
                      "+14155550100",
                  ),
                  SupportEmail: vobiz.String(
                      "support@example.com",
                  ),
                  BusinessContactFirstName: vobiz.String(
                      "Alex",
                  ),
                  BusinessContactLastName: vobiz.String(
                      "Doe",
                  ),
                  LegalName: vobiz.String(
                      "Example Corporation Inc.",
                  ),
                  BusinessName: vobiz.String(
                      "Example Corp",
                  ),
                  BusinessWebsite: vobiz.String(
                      "https://example.com",
                  ),
                  CustomerCareEmail: vobiz.String(
                      "support@example.com",
                  ),
                  TaxID: vobiz.String(
                      "12-3456789",
                  ),
                  TaxIDIssuingCountry: vobiz.String(
                      "US",
                  ),
                  LegalEntityType: vobiz.String(
                      "PRIVATE_COMPANY",
                  ),
              }
          c.Sms.Campaigns.CreateTollFreeCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: "import com.vobiz.api.VobizApiClient;\n\nVobizApiClient client = VobizApiClient\n    .builder()\n    .apiKey(\"\
          MA_XXXXXXXX\")\n    .authToken(\"YOUR_AUTH_TOKEN\")\n    .build();\n\nclient.sms().campaigns().createTollFreeCampaign(\n\
          \    TollFreeCampaignRequest\n        .builder()\n        .name(\"Example Corp toll-free notifications\")\n    \
          \    .referenceId(\"tollfree-notifications-01\")\n        .privacyPolicyUrl(\"https://example.com/privacy\")\n \
          \       .termsAndConditionsUrl(\"https://example.com/terms\")\n        .messageVolume(\"TEN_THOUSAND\")\n      \
          \  .numbers(\n            Optional.of(\n                Arrays.asList(\"+18335550100\")\n            )\n       \
          \ )\n        .useCase(\"NOTIFICATIONS\")\n        .programSummary(\"Example Corp sends account and support notifications\
          \ to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.\")\n        .exampleMessage(\"\
          Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP\
          \ for help.\")\n        .optIns(\n            new HashMap<String, Object>() {{\n                put(\"web\", new\
          \ \n                HashMap<String, Object>() {{put(\"url\", \"https://example.com/contact\");\n               \
          \     put(\"callToAction\", \"By checking this box you agree to receive account notifications from Example Corp.\
          \ Reply STOP to opt out, HELP for help.\");\n                }});\n            }}\n        )\n        .optInImageUrLs(\n\
          \            Optional.of(\n                Arrays.asList(\"https://example.com/opt-in-screenshot.png\")\n      \
          \      )\n        )\n        .countryCode(\"US\")\n        .address(\n            BrandAddress\n               \
          \ .builder()\n                .street(\"100 Example Street\")\n                .city(\"San Francisco\")\n      \
          \          .state(\"CA\")\n                .zipCode(\"94105\")\n                .build()\n        )\n        .supportPhone(\"\
          +14155550100\")\n        .supportEmail(\"support@example.com\")\n        .businessContactFirstName(\"Alex\")\n \
          \       .businessContactLastName(\"Doe\")\n        .legalName(\"Example Corporation Inc.\")\n        .businessName(\"\
          Example Corp\")\n        .businessWebsite(\"https://example.com\")\n        .customerCareEmail(\"support@example.com\"\
          )\n        .taxId(\"12-3456789\")\n        .taxIdIssuingCountry(\"US\")\n        .legalEntityType(\"PRIVATE_COMPANY\"\
          )\n        .build()\n);\n"
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.create_toll_free_campaign(
            reference_id: "tollfree-notifications-01",
            name: "Example Corp toll-free notifications",
            privacy_policy_url: "https://example.com/privacy",
            terms_and_conditions_url: "https://example.com/terms",
            message_volume: "TEN_THOUSAND",
            numbers: ["+18335550100"],
            use_case: "NOTIFICATIONS",
            program_summary: "Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.",
            example_message: "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.",
            opt_ins: {},
            opt_in_image_ur_ls: ["https://example.com/opt-in-screenshot.png"],
            country_code: "US",
            address: {
              street: "100 Example Street",
              city: "San Francisco",
              state: "CA",
              zip_code: "94105"
            },
            support_phone: "+14155550100",
            support_email: "support@example.com",
            business_contact_first_name: "Alex",
            business_contact_last_name: "Doe",
            legal_name: "Example Corporation Inc.",
            business_name: "Example Corp",
            business_website: "https://example.com",
            customer_care_email: "support@example.com",
            tax_id: "12-3456789",
            tax_id_issuing_country: "US",
            legal_entity_type: "PRIVATE_COMPANY"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.CreateTollFreeCampaignAsync(
              new TollFreeCampaignRequest
              {
                  ReferenceId = "tollfree-notifications-01",
                  Name = "Example Corp toll-free notifications",
                  PrivacyPolicyUrl = "https://example.com/privacy",
                  TermsAndConditionsUrl = "https://example.com/terms",
                  MessageVolume = "TEN_THOUSAND",
                  Numbers = new List<string>() { "+18335550100" },
                  UseCase = "NOTIFICATIONS",
                  ProgramSummary =
                      "Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.",
                  ExampleMessage =
                      "Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.",
                  OptIns = new Dictionary<string, object?>()
                  {
                      {
                          "web",
                          new Dictionary<object, object?>()
                          {
                              {
                                  "callToAction",
                                  "By checking this box you agree to receive account notifications from Example Corp. Reply STOP to opt out, HELP for help."
                              },
                              { "url", "https://example.com/contact" },
                          }
                      },
                  },
                  OptInImageUrLs = new List<string>() { "https://example.com/opt-in-screenshot.png" },
                  CountryCode = "US",
                  Address = new BrandAddress
                  {
                      Street = "100 Example Street",
                      City = "San Francisco",
                      State = "CA",
                      ZipCode = "94105",
                  },
                  SupportPhone = "+14155550100",
                  SupportEmail = "support@example.com",
                  BusinessContactFirstName = "Alex",
                  BusinessContactLastName = "Doe",
                  LegalName = "Example Corporation Inc.",
                  BusinessName = "Example Corp",
                  BusinessWebsite = "https://example.com",
                  CustomerCareEmail = "support@example.com",
                  TaxId = "12-3456789",
                  TaxIdIssuingCountry = "US",
                  LegalEntityType = "PRIVATE_COMPANY",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->createTollFreeCampaign(
              new TollFreeCampaignRequest([
                  'referenceId' => 'tollfree-notifications-01',
                  'name' => 'Example Corp toll-free notifications',
                  'privacyPolicyUrl' => 'https://example.com/privacy',
                  'termsAndConditionsUrl' => 'https://example.com/terms',
                  'messageVolume' => 'TEN_THOUSAND',
                  'numbers' => [
                      '+18335550100',
                  ],
                  'useCase' => 'NOTIFICATIONS',
                  'programSummary' => 'Example Corp sends account and support notifications to customers who opted in on the contact form. Reply STOP to opt out, HELP for help.',
                  'exampleMessage' => 'Example Corp: Your account balance is low. Add funds at https://example.com/wallet. Reply STOP to opt out, HELP for help.',
                  'optIns' => [
                      'web' => [
                          'url' => "https://example.com/contact",
                          'callToAction' => "By checking this box you agree to receive account notifications from Example Corp. Reply STOP to opt out, HELP for help.",
                      ],
                  ],
                  'optInImageUrLs' => [
                      'https://example.com/opt-in-screenshot.png',
                  ],
                  'countryCode' => 'US',
                  'address' => new BrandAddress([
                      'street' => '100 Example Street',
                      'city' => 'San Francisco',
                      'state' => 'CA',
                      'zipCode' => '94105',
                  ]),
                  'supportPhone' => '+14155550100',
                  'supportEmail' => 'support@example.com',
                  'businessContactFirstName' => 'Alex',
                  'businessContactLastName' => 'Doe',
                  'legalName' => 'Example Corporation Inc.',
                  'businessName' => 'Example Corp',
                  'businessWebsite' => 'https://example.com',
                  'customerCareEmail' => 'support@example.com',
                  'taxId' => '12-3456789',
                  'taxIdIssuingCountry' => 'US',
                  'legalEntityType' => 'PRIVATE_COMPANY',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/Priorities/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Campaigns
      summary: List campaign priorities
      description: Returns the priority options available to your account at the US 10DLC registry, as a JSON array. Pass
        an option's `id` as `priorityId` when you create or register a toll-free campaign. An empty array means no priority
        options apply to your account, and you can omit `priorityId`.
      operationId: campaign-priorities
      responses:
        '200':
          description: Priority options, as returned by the registry.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PriorityOption'
              example:
              - id: 2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d
                name: Standard
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.campaignPriorities()
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.campaign_priorities()
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          c.Sms.Campaigns.CampaignPriorities(
                  context.TODO(),
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().campaignPriorities();
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.campaign_priorities
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.CampaignPrioritiesAsync();
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->campaignPriorities();
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Campaigns
      summary: Retrieve a campaign
      description: Returns one campaign after refreshing its `stage` and review feedback (`rejectionReasons`) from the US
        10DLC registry. If the registry is slow to answer, you get the stored record and `lastSyncedAt` tells you how fresh
        it is. Poll this endpoint (or listen for the `10dlc.campaign.updated` WebSocket event) after registering until `stage`
        settles at `REGISTERED` or `REJECTED`.
      operationId: get-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      responses:
        '200':
          description: The campaign with its current registry state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              examples:
                registered:
                  summary: Registered 10DLC campaign
                  value:
                    id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                    accountId: MA_XXXXXXXX
                    brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                    name: Example Corp account alerts
                    campaignType: TEN_DIGIT_LONG_CODE
                    stage: REGISTERED
                    programSummary: Example Corp sends account and support alerts to customers who opted in on the sign-up
                      form. Reply STOP to opt out, HELP for help.
                    confirmationMessage: 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg &
                      data rates may apply. Reply HELP for help, STOP to opt out.'
                    helpMessage: 'Example Corp: For help email support@example.com. Reply STOP to opt out.'
                    stopMessage: 'Example Corp: You have been unsubscribed. Reply HELP for help.'
                    customerCarePhone: '+14155550100'
                    customerCareEmail: support@example.com
                    exampleMessages:
                    - 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply
                      STOP to opt out.'
                    termsAndConditionsUrl: https://example.com/terms
                    privacyPolicyUrl: https://example.com/privacy
                    useCases:
                    - ALERTS
                    messageTypes:
                    - SMS
                    optIns:
                      web:
                        url: https://example.com/signup
                        callToAction: By checking this box you agree to receive account alerts from Example Corp. Msg frequency
                          varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.
                    lowVolume: true
                    ageGated: false
                    directLending: false
                    embeddedLink: true
                    embeddedPhone: false
                    numbers:
                    - '14155550100'
                    lastSyncedAt: '2026-10-17T08:46:48Z'
                    createdAt: '2026-10-06T14:28:25Z'
                    updatedAt: '2026-10-14T17:19:03Z'
                rejected:
                  summary: Rejected toll-free campaign with review feedback
                  value:
                    id: 9c1b3e5f-7a2d-4b8c-a0e1-2f3d4c5b6a72
                    accountId: MA_XXXXXXXX
                    name: Example Corp toll-free notifications
                    campaignType: TOLL_FREE_UNIFIED_NUMBER
                    stage: REJECTED
                    useCases:
                    - NOTIFICATIONS
                    lowVolume: false
                    ageGated: false
                    directLending: false
                    embeddedLink: false
                    embeddedPhone: false
                    numbers:
                    - '+18335550100'
                    rejectionReasons:
                      rejectionDate: '2026-10-15T19:11:53Z'
                      rejectionDetails:
                      - errorCode: '9999'
                        description: The campaign must be attached to a registered brand whose details match its official
                          records.
                        recommendedAction: null
                        rejectionCategory: OTHER
                      rejectionReasons:
                      - The campaign must be attached to a registered brand whose details match its official records.
                    lastSyncedAt: '2026-10-17T08:46:46Z'
                    createdAt: '2026-10-08T04:36:40Z'
                    updatedAt: '2026-10-15T19:19:02Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.getCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.get_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetCampaignRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              }
          c.Sms.Campaigns.GetCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().getCampaign(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              GetCampaignRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.get_campaign(id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.GetCampaignAsync(
              new GetCampaignRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->getCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
          );
    put:
      tags:
      - 10DLC Campaigns
      summary: Update a campaign
      description: 'Replaces the editable fields of a 10DLC campaign and pushes the change to the US 10DLC registry. This
        is a full replacement: `name` is required and any field you leave out is cleared. `campaignType` and the brand stay
        as created, and `referenceId` is not used. The registry accepts updates while the campaign is `DRAFT` or `REJECTED`.
        Toll-free campaigns return `400` on this endpoint.'
      operationId: update-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCampaignRequest'
            example:
              name: Example Corp account alerts
              useCases:
              - ALERTS
              messageTypes:
              - SMS
              programSummary: Example Corp sends account, billing and support alerts to customers who opted in on the sign-up
                form. Reply STOP to opt out, HELP for help.
              confirmationMessage: 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates
                may apply. Reply HELP for help, STOP to opt out.'
              helpMessage: 'Example Corp: For help email support@example.com. Reply STOP to opt out.'
              stopMessage: 'Example Corp: You have been unsubscribed. Reply HELP for help.'
              exampleMessages:
              - 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP
                to opt out.'
              customerCarePhone: '+14155550100'
              customerCareEmail: support@example.com
              termsAndConditionsUrl: https://example.com/terms
              privacyPolicyUrl: https://example.com/privacy
              optIns:
                web:
                  url: https://example.com/signup
                  callToAction: By checking this box you agree to receive account alerts from Example Corp. Msg frequency
                    varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.
              lowVolume: true
              embeddedLink: true
      responses:
        '200':
          description: The updated campaign.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: DRAFT
                programSummary: Example Corp sends account, billing and support alerts to customers who opted in on the sign-up
                  form. Reply STOP to opt out, HELP for help.
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-06T15:02:10Z'
        '400':
          description: Invalid body, a missing `name`, or a toll-free campaign.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                name:
                  value:
                    error: 'invalid request: name is required'
                tollFree:
                  value:
                    error: 'invalid request: toll-free campaigns cannot be updated through this endpoint'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the update, for example because the campaign is under review. `error`
            carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: campaign can only be updated in DRAFT or REJECTED stage'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.updateCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              name: "Example Corp account alerts",
              programSummary: "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
              confirmationMessage: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
              helpMessage: "Example Corp: For help email support@example.com. Reply STOP to opt out.",
              stopMessage: "Example Corp: You have been unsubscribed. Reply HELP for help.",
              customerCarePhone: "+14155550100",
              customerCareEmail: "support@example.com",
              termsAndConditionsUrl: "https://example.com/terms",
              privacyPolicyUrl: "https://example.com/privacy",
              exampleMessages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out."],
              useCases: ["ALERTS"],
              messageTypes: ["SMS"],
              optIns: {
                  "web": {
                      "url": "https://example.com/signup",
                      "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."
                  }
              },
              lowVolume: true,
              embeddedLink: true
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.update_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              name="Example Corp account alerts",
              program_summary="Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
              confirmation_message="Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
              help_message="Example Corp: For help email support@example.com. Reply STOP to opt out.",
              stop_message="Example Corp: You have been unsubscribed. Reply HELP for help.",
              customer_care_phone="+14155550100",
              customer_care_email="support@example.com",
              terms_and_conditions_url="https://example.com/terms",
              privacy_policy_url="https://example.com/privacy",
              example_messages=[
                  "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out."
              ],
              use_cases=[
                  "ALERTS"
              ],
              message_types=[
                  "SMS"
              ],
              opt_ins={
                  "web": {"url": "https://example.com/signup", "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."}
              },
              low_volume=True,
              embedded_link=True,
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateCampaignRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Name: vobiz.String(
                      "Example Corp account alerts",
                  ),
                  ProgramSummary: vobiz.String(
                      "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
                  ),
                  ConfirmationMessage: vobiz.String(
                      "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
                  ),
                  HelpMessage: vobiz.String(
                      "Example Corp: For help email support@example.com. Reply STOP to opt out.",
                  ),
                  StopMessage: vobiz.String(
                      "Example Corp: You have been unsubscribed. Reply HELP for help.",
                  ),
                  CustomerCarePhone: vobiz.String(
                      "+14155550100",
                  ),
                  CustomerCareEmail: vobiz.String(
                      "support@example.com",
                  ),
                  TermsAndConditionsURL: vobiz.String(
                      "https://example.com/terms",
                  ),
                  PrivacyPolicyURL: vobiz.String(
                      "https://example.com/privacy",
                  ),
                  ExampleMessages: []string{
                      "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.",
                  },
                  UseCases: []string{
                      "ALERTS",
                  },
                  MessageTypes: []string{
                      "SMS",
                  },
                  OptIns: map[string]any{
                      "web": map[string]any{
                          "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.",
                          "url": "https://example.com/signup",
                      },
                  },
                  LowVolume: vobiz.Bool(
                      true,
                  ),
                  EmbeddedLink: vobiz.Bool(
                      true,
                  ),
              }
          c.Sms.Campaigns.UpdateCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: "import com.vobiz.api.VobizApiClient;\n\nVobizApiClient client = VobizApiClient\n    .builder()\n    .apiKey(\"\
          MA_XXXXXXXX\")\n    .authToken(\"YOUR_AUTH_TOKEN\")\n    .build();\n\nclient.sms().campaigns().updateCampaign(\n\
          \    \"4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24\",\n    UpdateCampaignRequest\n        .builder()\n        .name(\"\
          Example Corp account alerts\")\n        .programSummary(\"Example Corp sends account, billing and support alerts\
          \ to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.\")\n        .confirmationMessage(\"\
          Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP\
          \ for help, STOP to opt out.\")\n        .helpMessage(\"Example Corp: For help email support@example.com. Reply\
          \ STOP to opt out.\")\n        .stopMessage(\"Example Corp: You have been unsubscribed. Reply HELP for help.\")\n\
          \        .customerCarePhone(\"+14155550100\")\n        .customerCareEmail(\"support@example.com\")\n        .termsAndConditionsUrl(\"\
          https://example.com/terms\")\n        .privacyPolicyUrl(\"https://example.com/privacy\")\n        .exampleMessages(\n\
          \            Optional.of(\n                Arrays.asList(\"Example Corp: Your support ticket #48213 was updated.\
          \ View it at https://example.com/support. Reply STOP to opt out.\")\n            )\n        )\n        .useCases(\n\
          \            Optional.of(\n                Arrays.asList(\"ALERTS\")\n            )\n        )\n        .messageTypes(\n\
          \            Optional.of(\n                Arrays.asList(\"SMS\")\n            )\n        )\n        .optIns(\n\
          \            new HashMap<String, Object>() {{\n                put(\"web\", new \n                HashMap<String,\
          \ Object>() {{put(\"url\", \"https://example.com/signup\");\n                    put(\"callToAction\", \"By checking\
          \ this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply.\
          \ Reply STOP to opt out, HELP for help.\");\n                }});\n            }}\n        )\n        .lowVolume(true)\n\
          \        .embeddedLink(true)\n        .build()\n);\n"
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.update_campaign(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            name: "Example Corp account alerts",
            program_summary: "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
            confirmation_message: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
            help_message: "Example Corp: For help email support@example.com. Reply STOP to opt out.",
            stop_message: "Example Corp: You have been unsubscribed. Reply HELP for help.",
            customer_care_phone: "+14155550100",
            customer_care_email: "support@example.com",
            terms_and_conditions_url: "https://example.com/terms",
            privacy_policy_url: "https://example.com/privacy",
            example_messages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out."],
            use_cases: ["ALERTS"],
            message_types: ["SMS"],
            opt_ins: {},
            low_volume: true,
            embedded_link: true
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.UpdateCampaignAsync(
              new UpdateCampaignRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Name = "Example Corp account alerts",
                  ProgramSummary =
                      "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.",
                  ConfirmationMessage =
                      "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.",
                  HelpMessage = "Example Corp: For help email support@example.com. Reply STOP to opt out.",
                  StopMessage = "Example Corp: You have been unsubscribed. Reply HELP for help.",
                  CustomerCarePhone = "+14155550100",
                  CustomerCareEmail = "support@example.com",
                  TermsAndConditionsUrl = "https://example.com/terms",
                  PrivacyPolicyUrl = "https://example.com/privacy",
                  ExampleMessages = new List<string>()
                  {
                      "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.",
                  },
                  UseCases = new List<string>() { "ALERTS" },
                  MessageTypes = new List<string>() { "SMS" },
                  OptIns = new Dictionary<string, object?>()
                  {
                      {
                          "web",
                          new Dictionary<object, object?>()
                          {
                              {
                                  "callToAction",
                                  "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."
                              },
                              { "url", "https://example.com/signup" },
                          }
                      },
                  },
                  LowVolume = true,
                  EmbeddedLink = true,
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->updateCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new UpdateCampaignRequest([
                  'name' => 'Example Corp account alerts',
                  'programSummary' => 'Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.',
                  'confirmationMessage' => 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.',
                  'helpMessage' => 'Example Corp: For help email support@example.com. Reply STOP to opt out.',
                  'stopMessage' => 'Example Corp: You have been unsubscribed. Reply HELP for help.',
                  'customerCarePhone' => '+14155550100',
                  'customerCareEmail' => 'support@example.com',
                  'termsAndConditionsUrl' => 'https://example.com/terms',
                  'privacyPolicyUrl' => 'https://example.com/privacy',
                  'exampleMessages' => [
                      'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.',
                  ],
                  'useCases' => [
                      'ALERTS',
                  ],
                  'messageTypes' => [
                      'SMS',
                  ],
                  'optIns' => [
                      'web' => [
                          'url' => "https://example.com/signup",
                          'callToAction' => "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.",
                      ],
                  ],
                  'lowVolume' => true,
                  'embeddedLink' => true,
              ]),
          );
    delete:
      tags:
      - 10DLC Campaigns
      summary: Delete a campaign
      description: Deletes the campaign from your account and from the US 10DLC registry and returns `204` with no body. The
        registry accepts deletion while the campaign is `DRAFT`, `DEREGISTERED` or `REJECTED`; deregister a registered campaign
        with `POST /TenDlc/Campaign/{id}/Deregister/` first. Delete all of a brand's campaigns before you delete the brand.
      operationId: delete-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      responses:
        '204':
          description: The campaign was deleted. No body.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the deletion. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: campaign must be deregistered before deletion'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.deleteCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.delete_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeleteCampaignRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              }
          c.Sms.Campaigns.DeleteCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().deleteCampaign(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              DeleteCampaignRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.delete_campaign(id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.DeleteCampaignAsync(
              new DeleteCampaignRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->deleteCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/Register/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Register a campaign
      description: Submits the campaign to the US 10DLC registry for review and returns the refreshed campaign. The `stage`
        moves out of `DRAFT`; poll `GET /TenDlc/Campaign/{id}/` until it settles at `REGISTERED` or `REJECTED`. The body is
        optional and carries a `priorityId` from `GET /TenDlc/Campaign/Priorities/` for toll-free campaigns; a value that is
        not a UUID returns `400`. Submit only when the campaign details are final and you intend to run this program.
      operationId: register-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignRegisterRequest'
            example:
              priorityId: 2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d
      responses:
        '200':
          description: The campaign after submission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: IN_REVIEW
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                numbers:
                - '14155550100'
                lastSyncedAt: '2026-10-06T15:10:00Z'
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-06T15:10:00Z'
        '400':
          description: '`priorityId` is not a UUID.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: priorityId must be a UUID'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry rejected the submission. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: brand must be ACTIVE before campaigns can be registered'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '503':
          description: Registration is temporarily unavailable. Retry later or contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.registerCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              priorityId: "2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.register_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              priority_id="2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CampaignRegisterRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  PriorityID: vobiz.String(
                      "2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d",
                  ),
              }
          c.Sms.Campaigns.RegisterCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().registerCampaign(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              CampaignRegisterRequest
                  .builder()
                  .priorityId("2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.register_campaign(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            priority_id: "2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d"
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.RegisterCampaignAsync(
              new CampaignRegisterRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  PriorityId = "2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->registerCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new CampaignRegisterRequest([
                  'priorityId' => '2c9e4b7a-1d3f-4a5b-8c6d-0e9f8a7b6c5d',
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/Deregister/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Deregister a campaign
      description: Withdraws a registered campaign from the US 10DLC registry and returns the campaign. Once deregistration
        completes, traffic on the campaign's numbers is no longer covered by this registration, so move the numbers to another
        registered campaign first if you keep sending. The request has no body. A deregistered campaign can then be deleted
        with `DELETE /TenDlc/Campaign/{id}/`.
      operationId: deregister-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      responses:
        '200':
          description: The campaign after deregistration was requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: REGISTERED_PENDING_DEREGISTRATION
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                numbers:
                - '14155550100'
                lastSyncedAt: '2026-10-18T09:00:00Z'
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-18T09:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: campaign is not registered'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.deregisterCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.deregister_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.DeregisterCampaignRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              }
          c.Sms.Campaigns.DeregisterCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().deregisterCampaign(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              DeregisterCampaignRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.deregister_campaign(id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.DeregisterCampaignAsync(
              new DeregisterCampaignRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->deregisterCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/Appeal/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Appeal a campaign rejection
      description: 'Asks the US 10DLC registry to reconsider a `REJECTED` campaign and returns the campaign after the appeal
        is filed. Fix the campaign with `PUT /TenDlc/Campaign/{id}/` first, then explain what changed in `reason`, which is
        required (`400` with `invalid request: reason is required` otherwise). Follow the outcome with `GET /TenDlc/Campaign/{id}/`.'
      operationId: appeal-campaign
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignAppealRequest'
            example:
              reason: Updated the program summary and opt-in call to action to match the brand's registered details.
      responses:
        '200':
          description: The campaign after the appeal was filed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 9c1b3e5f-7a2d-4b8c-a0e1-2f3d4c5b6a72
                accountId: MA_XXXXXXXX
                name: Example Corp toll-free notifications
                campaignType: TOLL_FREE_UNIFIED_NUMBER
                stage: APPEALED
                useCases:
                - NOTIFICATIONS
                lowVolume: false
                ageGated: false
                directLending: false
                embeddedLink: false
                embeddedPhone: false
                numbers:
                - '+18335550100'
                lastSyncedAt: '2026-10-16T10:00:00Z'
                createdAt: '2026-10-08T04:36:40Z'
                updatedAt: '2026-10-16T10:00:00Z'
        '400':
          description: '`reason` is missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: reason is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the appeal. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: only REJECTED campaigns can be appealed'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.appealCampaign({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              reason: "Updated the program summary and opt-in call to action to match the brand's registered details."
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.appeal_campaign(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              reason="Updated the program summary and opt-in call to action to match the brand\'s registered details.",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CampaignAppealRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Reason: "Updated the program summary and opt-in call to action to match the brand's registered details.",
              }
          c.Sms.Campaigns.AppealCampaign(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().appealCampaign(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              CampaignAppealRequest
                  .builder()
                  .reason("Updated the program summary and opt-in call to action to match the brand's registered details.")
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.appeal_campaign(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            reason: "Updated the program summary and opt-in call to action to match the brand's registered details."
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.AppealCampaignAsync(
              new CampaignAppealRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Reason =
                      "Updated the program summary and opt-in call to action to match the brand's registered details.",
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->appealCampaign(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new CampaignAppealRequest([
                  'reason' => "Updated the program summary and opt-in call to action to match the brand's registered details.",
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/UpdateRegistration/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Update a campaign registration
      description: 'Asks the US 10DLC registry to update the set of numbers covered by a registered campaign, without deregistering
        it. Provide `numbers`, `numberKeys`, or both; if both are empty the call returns `400` with `invalid request: numbers
        or numberKeys is required`. The response is the campaign; the `numbers` list stored on your account is left as it
        was. Use `POST` and `DELETE /TenDlc/Campaign/{id}/Number/` for incremental changes.'
      operationId: update-campaign-registration
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignNumbersRequest'
            example:
              numbers:
              - '14155550100'
              - '14155550101'
      responses:
        '200':
          description: The campaign after the registry accepted the update request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              example:
                id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11
                accountId: MA_XXXXXXXX
                brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60
                name: Example Corp account alerts
                campaignType: TEN_DIGIT_LONG_CODE
                stage: REGISTERED_PENDING_UPDATE
                useCases:
                - ALERTS
                messageTypes:
                - SMS
                lowVolume: true
                ageGated: false
                directLending: false
                embeddedLink: true
                embeddedPhone: false
                numbers:
                - '14155550100'
                lastSyncedAt: '2026-10-18T09:30:00Z'
                createdAt: '2026-10-06T14:28:25Z'
                updatedAt: '2026-10-18T09:30:00Z'
        '400':
          description: Neither `numbers` nor `numberKeys` was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: numbers or numberKeys is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: campaign is not registered'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.updateCampaignRegistration({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              body: {
                  numbers: ["14155550100", "14155550101"]
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.update_campaign_registration(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              numbers=[
                  "14155550100",
                  "14155550101"
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UpdateCampaignRegistrationRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body: &sms.CampaignNumbersRequest{
                      Numbers: []string{
                          "14155550100",
                          "14155550101",
                      },
                  },
              }
          c.Sms.Campaigns.UpdateCampaignRegistration(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().updateCampaignRegistration(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              UpdateCampaignRegistrationRequest
                  .builder()
                  .body(
                      CampaignNumbersRequest
                          .builder()
                          .numbers(
                              Optional.of(
                                  Arrays.asList("14155550100", "14155550101")
                              )
                          )
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.update_campaign_registration(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            numbers: %w[14155550100 14155550101]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.UpdateCampaignRegistrationAsync(
              new UpdateCampaignRegistrationRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body = new CampaignNumbersRequest
                  {
                      Numbers = new List<string>() { "14155550100", "14155550101" },
                  },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->updateCampaignRegistration(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new UpdateCampaignRegistrationRequest([
                  'body' => new CampaignNumbersRequest([
                      'numbers' => [
                          '14155550100',
                          '14155550101',
                      ],
                  ]),
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/NetworkStatuses/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Campaigns
      summary: List campaign network statuses
      description: Returns the campaign's status at each US carrier network, read live from the US 10DLC registry. Each entry
        names the network and its `state`, plus the message class, throughput and brand tier when the network reports them.
        Use it after the campaign reaches `REGISTERED` to see which networks have provisioned it and what throughput they
        grant.
      operationId: campaign-network-statuses
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      responses:
        '200':
          description: One entry per US carrier network.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CampaignNetworkStatus'
              example:
              - network: T_MOBILE
                state: ACTIVE
                messageClass: '24'
                throughput: 2000
                brandTier: LOW
              - network: ATT
                state: ACTIVE
                messageClass: T
                throughput: 75
              - network: VERIZON
                state: ACTIVE
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found on your account or at the registry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              examples:
                account:
                  summary: Not on your account
                  value:
                    error: campaign not found
                registry:
                  summary: Not found at the registry
                  value:
                    error: 'registration provider rejected the request: Requested campaign not found'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.campaignNetworkStatuses({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.campaign_network_statuses(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.CampaignNetworkStatusesRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              }
          c.Sms.Campaigns.CampaignNetworkStatuses(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().campaignNetworkStatuses(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              CampaignNetworkStatusesRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.campaign_network_statuses(id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.CampaignNetworkStatusesAsync(
              new CampaignNetworkStatusesRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->campaignNetworkStatuses(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Campaign/{id}/Number/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Campaigns
      summary: List campaign numbers
      description: 'Returns the numbers attached to the campaign at the US 10DLC registry, as `{"numberPreviews": [...]}`.
        Each entry gives the number, its country and the registry `numberKey`, which you can pass in `numberKeys` on the number
        endpoints. Use it to confirm which numbers the registry associates with the campaign.'
      operationId: list-campaign-numbers
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      responses:
        '200':
          description: Numbers attached to the campaign.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignNumberList'
              example:
                numberPreviews:
                - numberKey: 6f5e4d3c2b1a4c9d8e7f0a1b2c3d4e5f
                  number: '14155550100'
                  countryCode: US
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found on your account or at the registry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              examples:
                account:
                  summary: Not on your account
                  value:
                    error: campaign not found
                registry:
                  summary: Not found at the registry
                  value:
                    error: 'registration provider rejected the request: Requested campaign not found'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.listCampaignNumbers({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24"
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.list_campaign_numbers(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.ListCampaignNumbersRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              }
          c.Sms.Campaigns.ListCampaignNumbers(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().listCampaignNumbers(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              ListCampaignNumbersRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.list_campaign_numbers(id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.ListCampaignNumbersAsync(
              new ListCampaignNumbersRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24" }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->listCampaignNumbers(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
          );
    post:
      tags:
      - 10DLC Campaigns
      summary: Add numbers to a campaign
      description: Attaches numbers to the campaign at the US 10DLC registry and adds the `numbers` values to the campaign's
        `numbers` list on your account. Provide `numbers`, `numberKeys`, or both; if both are empty the call returns `400`.
        Returns `200` with `{"status":"ok"}`. Attach only numbers on your account that you send this program from.
      operationId: add-campaign-numbers
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignNumbersRequest'
            example:
              numbers:
              - '14155550101'
      responses:
        '200':
          description: The numbers were added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '400':
          description: Neither `numbers` nor `numberKeys` was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: numbers or numberKeys is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: number 14155550101 is attached to another campaign'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.addCampaignNumbers({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              body: {
                  numbers: ["14155550101"]
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.add_campaign_numbers(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              numbers=[
                  "14155550101"
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.AddCampaignNumbersRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body: &sms.CampaignNumbersRequest{
                      Numbers: []string{
                          "14155550101",
                      },
                  },
              }
          c.Sms.Campaigns.AddCampaignNumbers(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().addCampaignNumbers(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              AddCampaignNumbersRequest
                  .builder()
                  .body(
                      CampaignNumbersRequest
                          .builder()
                          .numbers(
                              Optional.of(
                                  Arrays.asList("14155550101")
                              )
                          )
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.add_campaign_numbers(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            numbers: ["14155550101"]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.AddCampaignNumbersAsync(
              new AddCampaignNumbersRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body = new CampaignNumbersRequest { Numbers = new List<string>() { "14155550101" } },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->addCampaignNumbers(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new AddCampaignNumbersRequest([
                  'body' => new CampaignNumbersRequest([
                      'numbers' => [
                          '14155550101',
                      ],
                  ]),
              ]),
          );
    delete:
      tags:
      - 10DLC Campaigns
      summary: Remove numbers from a campaign
      description: Detaches numbers from the campaign at the US 10DLC registry and removes the `numbers` values from the campaign's
        `numbers` list on your account. Send `numbers`, `numberKeys`, or both in the `DELETE` request body; if both are empty
        the call returns `400`. Returns `200` with `{"status":"ok"}`. Messages from a detached number are no longer covered
        by this campaign.
      operationId: remove-campaign-numbers
      parameters:
      - name: id
        in: path
        required: true
        description: Campaign ID (UUID) returned by `POST /TenDlc/Campaign/` or `POST /TenDlc/Campaign/TollFree/`. An unknown
          ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`.
        schema:
          type: string
          format: uuid
        example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignNumbersRequest'
            example:
              numbers:
              - '14155550101'
      responses:
        '200':
          description: The numbers were removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '400':
          description: Neither `numbers` nor `numberKeys` was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'invalid request: numbers or numberKeys is required'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The campaign wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: campaign not found
        '422':
          description: The US 10DLC registry declined the request. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: number 14155550101 is not attached to this campaign'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          await client.sms.campaigns.removeCampaignNumbers({
              id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              body: {
                  numbers: ["14155550101"]
              }
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.remove_campaign_numbers(
              id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              numbers=[
                  "14155550101"
              ],
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.RemoveCampaignNumbersRequest{
                  ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body: &sms.CampaignNumbersRequest{
                      Numbers: []string{
                          "14155550101",
                      },
                  },
              }
          c.Sms.Campaigns.RemoveCampaignNumbers(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().removeCampaignNumbers(
              "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
              RemoveCampaignNumbersRequest
                  .builder()
                  .body(
                      CampaignNumbersRequest
                          .builder()
                          .numbers(
                              Optional.of(
                                  Arrays.asList("14155550101")
                              )
                          )
                          .build()
                  )
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.remove_campaign_numbers(
            id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
            numbers: ["14155550101"]
          )
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.RemoveCampaignNumbersAsync(
              new RemoveCampaignNumbersRequest
              {
                  Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
                  Body = new CampaignNumbersRequest { Numbers = new List<string>() { "14155550101" } },
              }
          );
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->removeCampaignNumbers(
              '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24',
              new RemoveCampaignNumbersRequest([
                  'body' => new CampaignNumbersRequest([
                      'numbers' => [
                          '14155550101',
                      ],
                  ]),
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Document/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - 10DLC Campaigns
      summary: Upload a document
      description: Uploads a supporting document or MMS sample file for campaign registration and stores it at the US 10DLC
        registry. Send `multipart/form-data` with the file in a part named `document` that carries a filename; the file can
        be up to 10 MB (`413` above that). The response is the document record; reference its `documentId` in a campaign's
        `supportingDocuments` or `mmsSampleFiles`, and use the same value to download it again.
      operationId: upload-document
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - document
              properties:
                document:
                  type: string
                  format: binary
                  description: The file to upload, as the `document` part of a `multipart/form-data` body. The part must include
                    a filename; a missing part returns `400` with `multipart field "document" is required`. Maximum 10 MB.
            encoding:
              document:
                contentType: application/octet-stream, image/*, application/pdf
      responses:
        '201':
          description: The document was stored at the registry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              example:
                id: 3d2c1b0a-9e8f-4d7c-b6a5-4f3e2d1c0b9a
                accountId: MA_XXXXXXXX
                provider: primary
                documentId: 7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b
                documentName: opt-in-screenshot.png
                contentType: image/png
                contentLength: 48213
                createdAt: '2026-10-12T10:30:00Z'
        '400':
          description: The `document` part is missing, unreadable, or has no filename.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missing:
                  value:
                    error: multipart field "document" is required
                filename:
                  value:
                    error: 'invalid request: document filename is required'
                unreadable:
                  value:
                    error: cannot read document
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '413':
          description: The file is larger than 10 MB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: document exceeds 10MB
        '422':
          description: The US 10DLC registry declined the file. `error` carries the registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: 'registration provider rejected the request: file type must be PDF or an image'
        '502':
          description: The US 10DLC registry did not answer. Retry the upload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          import { createReadStream } from "fs";
          await client.sms.campaigns.uploadDocument({
              document: fs.createReadStream("/path/to/your/file")
          })
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.upload_document(
              document="example_document",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.UploadDocumentRequest{
                  Document: strings.NewReader(
                      "",
                  ),
              }
          c.Sms.Campaigns.UploadDocument(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().uploadDocument(
              null,
              UploadDocumentRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.upload_document
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.UploadDocumentAsync(new UploadDocumentRequest());
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->uploadDocument(
              new UploadDocumentRequest([
                  'document' => File::createFromString("example_document", "example_document"),
              ]),
          );
  /api/v1/Account/{auth_id}/Sms/TenDlc/Document/{id}/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - 10DLC Campaigns
      summary: Download a document
      description: 'Downloads a document you uploaded with `POST /TenDlc/Document/`. The response body is the file itself,
        with the file''s own `Content-Type` and a `Content-Disposition: attachment` header that carries the original filename.
        Look the file up by its `documentId`, not by the record `id`.'
      operationId: get-document
      parameters:
      - name: id
        in: path
        required: true
        description: The `documentId` (UUID) returned by `POST /TenDlc/Document/`, not the record `id`. A value that is not
          a UUID, or a document that is not on your account, returns `404` with `{"error":"document not found"}`.
        schema:
          type: string
          format: uuid
        example: 7b5d3f1a-9e7c-4a5b-8d3f-1b9e7c5a3d26
      responses:
        '200':
          description: The file bytes.
          headers:
            Content-Disposition:
              description: '`attachment; filename="<documentName>"`.'
              schema:
                type: string
              example: attachment; filename="opt-in-screenshot.png"
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The document wasn't found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: document not found
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
      - lang: typescript
        label: Node SDK
        source: |
          import { VobizClient } from "@vobiz/sdk";

          const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });

          const file = await client.sms.campaigns.getDocument({
              id: "7b5d3f1a-9e7c-4a5b-8d3f-1b9e7c5a3d26"
          });
          const bytes = await file.arrayBuffer();
      - lang: python
        label: Python SDK
        source: |
          from vobiz import Vobiz

          client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

          client.sms.campaigns.get_document(
              id="id",
          )
      - lang: go
        label: Go SDK
        source: |
          import (
              "context"

              vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
              "github.com/vobiz-ai/Vobiz-Go-SDK/client"
              "github.com/vobiz-ai/Vobiz-Go-SDK/option"
              "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
          )

          c := client.NewClient(
              option.WithAPIKey("MA_XXXXXXXX"),
              option.WithAuthToken("YOUR_AUTH_TOKEN"),
          )

          request := &sms.GetDocumentRequest{
                  ID: "id",
              }
          c.Sms.Campaigns.GetDocument(
                  context.TODO(),
                  request,
              )
      - lang: java
        label: Java SDK
        source: |
          import com.vobiz.api.VobizApiClient;

          VobizApiClient client = VobizApiClient
              .builder()
              .apiKey("MA_XXXXXXXX")
              .authToken("YOUR_AUTH_TOKEN")
              .build();

          client.sms().campaigns().getDocument(
              "id",
              GetDocumentRequest
                  .builder()
                  .build()
          );
      - lang: ruby
        label: Ruby SDK
        source: |
          require 'vobiz'

          client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')

          client.sms.campaigns.get_document(id: "id")
      - lang: csharp
        label: C# SDK
        source: |
          using Vobiz;
          using Vobiz.Sms;

          var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

          await client.Sms.Campaigns.GetDocumentAsync(new GetDocumentRequest { Id = "id" });
      - lang: php
        label: PHP SDK
        source: |
          <?php

          require 'vendor/autoload.php';

          use Vobiz\VobizClient;

          $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');

          $client->sms->campaigns->getDocument(
              'id',
          );
  /api/v1/Account/{auth_id}/Sms/Lookup/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    post:
      tags:
      - Number lookup
      summary: Look up numbers
      description: |-
        Checks up to 100 numbers against the mobile network (an HLR lookup) without messaging them. For each number it returns whether it is valid and reachable, its country, the network that serves it, and whether it was ported or is roaming. Use it to clean a list before a broadcast or to validate a number at sign-up.

        Results come back in the order you sent the numbers, one per distinct input. An input that cannot be read as a phone number gets `valid: false` and a `reason`, and is not sent to the network. A result for the same number from the last 24 hours is reused (`cached: true`) unless you set `fresh`. Numbers sent to the network count toward a daily limit of 1000 per account (UTC day); cached results and unreadable inputs do not. Every looked-up number is recorded in `GET /Lookup/History/`.
      operationId: lookup-numbers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupRequest'
            example:
              numbers:
              - '+14155550123'
              - '12345'
              defaultCountry: US
      responses:
        '200':
          description: One result per distinct input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupResponse'
              example:
                results:
                - input: '+14155550123'
                  number: '+14155550123'
                  valid: false
                  status:
                    group: REJECTED
                    name: REJECTED_ROUTE_NOT_AVAILABLE
                    description: Route not available
                  error: null
                  country:
                    iso: US
                    name: United States
                    dialCode: '1'
                  network: null
                  originalNetwork: null
                  ported: false
                  portedNetwork: null
                  roaming: false
                  roamingNetwork: null
                  cached: false
                  checkedAt: '2026-10-12T10:30:00Z'
                - input: '12345'
                  number: ''
                  valid: false
                  reason: too short
                  status: null
                  error: null
                  country: null
                  network: null
                  originalNetwork: null
                  ported: false
                  portedNetwork: null
                  roaming: false
                  roamingNetwork: null
                  cached: false
                  checkedAt: '2026-10-12T10:30:00Z'
        '400':
          description: The body is not a JSON object (or is larger than 256 KB), or `numbers` is missing or empty.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                body:
                  value:
                    error: invalid request body
                numbers:
                  value:
                    error: numbers is required
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: More than 100 numbers, an unsupported `defaultCountry`, or the request was rejected by the network.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                tooMany:
                  value:
                    error: 'too many numbers: at most 100 per request'
                country:
                  value:
                    error: unsupported defaultCountry
        '429':
          description: The request would go over the daily lookup limit, or the lookup service is busy. Nothing was looked
            up; retry later, or with fewer numbers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                daily:
                  value:
                    error: 'daily number lookup limit reached: 995 of 1000 used today (UTC), this request needs 10 more'
                busy:
                  value:
                    error: number lookup is busy, try again shortly
        '502':
          description: The lookup couldn't be completed. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number lookup failed, try again later
        '503':
          description: Number lookup is temporarily unavailable. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: number lookup is not available yet
        '500':
          $ref: '#/components/responses/ServerError'
  /api/v1/Account/{auth_id}/Sms/Lookup/History/:
    parameters:
    - $ref: '#/components/parameters/AuthId'
    get:
      tags:
      - Number lookup
      summary: List lookup history
      description: Returns your past number lookups, newest first, with the total count for paging. Each entry is the result
        as it was returned, with `cached` showing whether it came from the cache. Inputs that could not be read as a phone
        number, and numbers that got no answer, are not recorded.
      operationId: list-lookup-history
      parameters:
      - name: limit
        in: query
        description: Maximum number of lookups to return. Defaults to `50`; `0` or a negative value also gives `50`, and
          a value above `200` returns `200`. A non-integer returns `400` with `limit must be an integer`.
        schema:
          type: integer
          minimum: 1
          maximum: 200
          default: 50
      - name: offset
        in: query
        description: Number of lookups to skip before the page starts. Defaults to `0`. A negative value returns `400` with
          `offset must not be negative`, and a non-integer returns `400` with `offset must be an integer`.
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of past lookups.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupHistory'
              example:
                lookups:
                - input: +1 415 555 0123
                  number: '+14155550123'
                  valid: false
                  status:
                    group: REJECTED
                    name: REJECTED_ROUTE_NOT_AVAILABLE
                    description: Route not available
                  error: null
                  country:
                    iso: US
                    name: United States
                    dialCode: '1'
                  network: null
                  originalNetwork: null
                  ported: false
                  portedNetwork: null
                  roaming: false
                  roamingNetwork: null
                  cached: false
                  checkedAt: '2026-10-12T10:30:00Z'
                total: 1
        '400':
          description: '`limit` or `offset` is not an integer, or `offset` is negative.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                limit:
                  value:
                    error: limit must be an integer
                offset:
                  value:
                    error: offset must not be negative
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
