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

# List messages

> 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`).



## OpenAPI

````yaml openapi-sms.yaml GET /messages
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/sms`


    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token`
    headers.

    The account is taken from your credentials; you never put an account ID in a
    path or body.

    Field names in this API are camelCase.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai/api/v1/sms
    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: 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.
paths:
  /messages:
    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 / ISO
            8601 timestamp such as `2026-10-01T00:00:00Z`.
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: >-
            Only messages created before this time, as an RFC 3339 / ISO 8601
            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'
        '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([]),
            );
components:
  schemas:
    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` you sent in the request, or `0` when you omitted it. The
            page itself holds at most 100 messages, and 20 when `limit` is
            omitted.
        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 /messages`, with the total number of
        matches so you can page through the rest.
    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
            /messages/{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
            /conversations/{id}/messages` 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).
    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.
  responses:
    Unauthorized:
      description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or invalid credentials
    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
  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.

````

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