Retrieve a list of all Conversations that this Participant belongs to by identity

GET /v1/ParticipantConversations

Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a default conversation service.

Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.

Query parameters

  • Identity string

    A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.

  • Address string

    A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.

  • 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
    • conversations array[object]
      Hide conversations attributes Show conversations attributes
      • account_sid string | null

        The unique ID of the Account responsible for this conversation.

        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 unique ID of the Conversation Service this conversation belongs to.

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

      • conversation_attributes string | null

        An optional string metadata field you can use to store any data you wish.

      • conversation_created_by string | null

        Creator of this conversation.

      • conversation_date_created string(date-time) | null

        The date that this conversation was created.

      • conversation_date_updated string(date-time) | null

        The date that this conversation was last updated.

      • conversation_friendly_name string | null

        The human-readable name of this conversation.

      • conversation_sid string | null

        The unique ID of the Conversation this Participant belongs to.

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

      • conversation_state string | null

        The current state of this User Conversation

        Values are inactive, active, or closed.

      • conversation_timers

        Timer date values for this conversation.

      • conversation_unique_name string | null

        An application-defined string that uniquely identifies the Conversation resource

      • links object(uri-map) | null

        Absolute URLs to access the participant and conversation of this Participant Conversation.

      • participant_identity string | null

        A unique string identifier for the conversation participant as Conversation User.

      • participant_messaging_binding

        Information about how this participant exchanges messages with the conversation.

      • participant_sid string | null

        The unique ID of the Participant.

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

      • participant_user_sid string | null

        The unique ID for the conversation participant as Conversation User.

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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/ParticipantConversations 
curl \
 -X GET https://conversations.twilio.com/v1/ParticipantConversations \
 --user "username:password"
Response examples (200) 
{
  "conversations": [
    {
      "account_sid": "string",
      "chat_service_sid": "string",
      "conversation_attributes": "string",
      "conversation_created_by": "string",
      "conversation_date_created": "2023-05-04T09:42:00+00:00",
      "conversation_date_updated": "2023-05-04T09:42:00+00:00",
      "conversation_friendly_name": "string",
      "conversation_sid": "string",
      "conversation_state": "inactive",
      "conversation_unique_name": "string",
      "links": {},
      "participant_identity": "string",
      "participant_sid": "string",
      "participant_user_sid": "string"
    }
  ],
  "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"
  }
}