Sign in
ConversationsV1Conversation

Retrieve a list of conversations in your service

Retrieve a list of conversations in your service

get/v1/Services/{ChatServiceSid}/Conversations

Path parameters

ChatServiceSidstring required

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

Query parameters

StartDatestring

Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

EndDatestring

Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

State'inactive' | 'active' | 'closed' | 'initializing'

Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active

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

PageSizeinteger

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

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 9 of the 51 revisions of this API.648

  • v1b0b12d0bcb0b11See the full diff
    • ●

      added the new initializing enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value initializing to the query request parameter State

      request-parameter-enum-value-added

  • 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 100.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 ConversationsV1Conversation added

      api-tag-added

  • v1c97a0ea6ca203See the full diff
    • ○

      added the new optional query request parameter EndDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter StartDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter State

      new-optional-request-parameter

  • v10b8a5f28bf643See the full diff
    • ●

      deleted the query request parameter EndDate

      request-parameter-removed

    • ●

      deleted the query request parameter StartDate

      request-parameter-removed

    • ●

      deleted the query request parameter State

      request-parameter-removed

  • v1023bc1efea853See the full diff
    • ○

      added the new optional query request parameter EndDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter StartDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter State

      new-optional-request-parameter