Path parameters

• ChatServiceSid string Required

  The SID of the Conversation Service the Participant resource is associated with.

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

• ConversationSid string Required

  The unique ID of the Conversation for messages.

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 100.

  Minimum value is 1, maximum value is 100.

• 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

    • account_sid string | null

      The unique ID of the Account responsible for this message.

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

    • chat_service_sid string | null

      The SID of the Conversation Service the Participant resource is associated with.

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

    • conversation_sid string | null

      The unique ID of the Conversation for this message.

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

    • sid string | null

      A 34 character string that uniquely identifies this resource.

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

    • index integer

      The index of the message within the Conversation.

      Default value is 0.

    • author string | null

      The channel specific identifier of the message's author. Defaults to system.

    • body string | null

      The content of the message, can be up to 1,600 characters long.

    • media array | null

      An array of objects that describe the Message's media, if the message contains media. Each 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.

    • attributes string | null

      A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

    • participant_sid string | null

      The unique ID of messages's author participant. Null in case of system sent message.

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

    • date_created string(date-time) | null

      The date that this resource was created.

    • date_updated string(date-time) | null

      The date that this resource was last updated. null if the message has not been edited.

    • delivery

      An object that contains the summary of delivery statuses for the message to non-chat participants.

    • url string(uri) | null

      An absolute API resource URL for this message.

    • links object(uri-map) | null

      Contains an absolute API resource URL to access the delivery & read receipts of this message.

    • content_sid string | null

      The unique ID of the multi-channel Rich Content template.

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

  • 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)