GET /v1/ParticipantConversations

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

Servers

Query parameters

Name Type Required Description
Identity String No

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.

PageSize Integer No

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

Page Integer No

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

Address String No

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.

PageToken String No

The page token. This is provided by the API.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.