Retrieve a list of all delivery and read receipts of the conversation message

GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts

A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation.

Retrieve a list of all delivery and read receipts of the conversation message

Path parameters

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
      • 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
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts 
curl \
 -X GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts \
 --user "username:password"
Response examples (200) 
{
  "delivery_receipts": [
    {
      "account_sid": "string",
      "channel_message_sid": "string",
      "chat_service_sid": "string",
      "conversation_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "error_code": 42,
      "message_sid": "string",
      "participant_sid": "string",
      "sid": "string",
      "status": "read",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}