Path parameters

• ChatServiceSid string Required

  The SID of the Conversation 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}$.

• ConversationSid string Required

  The unique ID of the Conversation for this message.

• MessageSid string Required

  The SID of the message within a Conversation the delivery receipt belongs to.

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

Query parameters

• PageSize integer(int64)

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

  Minimum value is 1, maximum value is 50.

• 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

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

    • account_sid string | null

      The unique ID of the Account responsible for this participant.

      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 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}$.

    • 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}$.

    • message_sid string | null

      The SID of the message within a Conversation the delivery receipt belongs to

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IM[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: ^DY[0-9a-fA-F]{32}$.

    • channel_message_sid string | null

      A messaging channel-specific identifier for the message delivered to participant e.g. SMxx for SMS, WAxx for Whatsapp etc.

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

    • participant_sid string | null

      The unique ID of the participant the delivery receipt belongs to.

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

    • status string

      The message delivery status, can be read, failed, delivered, undelivered, sent or null.

      Values are read, failed, delivered, undelivered, or sent.

    • error_code integer

      The message delivery error code for a failed status,

      Default value is 0.

    • 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 delivery receipt has not been updated.

    • url string(uri) | null

      An absolute API resource URL for this delivery receipt.

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