GET /v1/Services/{ChatServiceSid}/Conversations

Retrieve a list of conversations in your service

Servers

Path parameters

Name Type Required Description
ChatServiceSid String Yes

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

Query parameters

Name Type Required Description
State String No

State for sorting and filtering list of Conversations. Can be active, inactive or closed

Possible values:

  • "inactive"
  • "active"
  • "closed"
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.

StartDate String No

Start date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the start time of the date is used (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.

EndDate String No

End date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the end time of the date is used (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.

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.