Path parameters

• ChatServiceSid string Required

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

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

Query parameters

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • delivery_receipts array[object]
    Hide delivery_receipts attributes Show delivery_receipts attributes array[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}$.

    • channel_message_sid string | null

      A messaging channel-specific identifier for the message delivered to participant

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

    • chat_service_sid string | null

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

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

    • error_code integer | null

      The message delivery error code for a failed status

    • message_sid string | null

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

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

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

    • status string | null

      The message delivery status

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

    • url string(uri) | null

      An absolute 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)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)