Path parameters

• ServiceSid string Required

  The SID of the Service to read the Message resources from.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

• ChannelSid string Required

  The SID of the Channel the Message resource to read belongs to. This value can be the Channel resource's sid or unique_name.

Query parameters

• Order string

  The sort order of the returned messages. Can be: asc (ascending) or desc (descending) with asc as the default.

  Values are asc or desc.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • messages array[object]
    Hide messages attributes Show messages attributes object

    • sid string | null

      The unique string that we created to identify the Message resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IM[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the Message resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • attributes string | null

      The JSON string that stores application-specific data. If attributes have not been set, {} is returned.

    • service_sid string | null

      The SID of the Service the Message resource is associated with.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • to string | null

      The SID of the Channel that the message was sent to.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

    • channel_sid string | null

      The SID of the Channel the Message resource belongs to.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • last_updated_by string | null

      The Identity of the User who last updated the Message, if applicable.

    • was_edited boolean | null

      Whether the message has been edited since it was created.

    • from string | null

      The Identity of the message's author. The default value is system.

    • body string | null

      The content of the message.

    • index integer

      The index of the message within the Channel. Indices may skip numbers, but will always be in order of when the message was received.

      Default value is 0.

    • type string | null

      The Message type. Can be: text or media.

    • media

      An object that describes the Message's media, if the message contains media. The object contains these fields: content_type with the MIME type of the media, filename with the name of the media, sid with the SID of the Media resource, and size with the media object's file size in bytes. If the Message has no media, this value is null.

    • url string(uri) | null

      The absolute URL of the Message resource.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)