Sign in
ConversationsV1ParticipantConversation

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

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

get/v1/Services/{ChatServiceSid}/ParticipantConversations

Path parameters

ChatServiceSidstring required

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

Query parameters

Identitystring

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.

Addressstring

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.

PageSizeinteger

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

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

Changed in 5 of the 51 revisions of this API.61

  • v192d1169c37c22See the full diff
    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

  • v19e5a9439b5b31See the full diff
    • ▲

      for the query request parameter PageSize, the max was decreased from 1000.00 to 50.00

      request-parameter-max-decreased

  • v1b4d0e634cd692See the full diff
    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

  • v12cf60eb95eb91See the full diff
    • ▲

      for the query request parameter PageSize, the format changed from no format to int64

      request-parameter-type-changed

  • v14e3f150aaa781See the full diff
    • ○

      api tag ConversationsV1ParticipantConversation added

      api-tag-added