Path parameters

• ChatServiceSid string Required

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

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

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(int64)

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

  Minimum value is 1, maximum value is 50.

• Page integer

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

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • conversations array[object]
    Hide conversations attributes Show conversations attributes object

    • 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}$.

    • 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 string that identifies 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}$.

    • participant_identity string | null

      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.

    • participant_messaging_binding

      Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.

    • 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_unique_name string | null

      An application-defined string that uniquely identifies the Conversation resource.

    • conversation_friendly_name string | null

      The human-readable name of this conversation, limited to 256 characters. Optional.

    • conversation_attributes string | null

      An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

    • conversation_date_created string(date-time) | null

      The date that this conversation was created, given in ISO 8601 format.

    • conversation_date_updated string(date-time) | null

      The date that this conversation was last updated, given in ISO 8601 format.

    • conversation_created_by string | null

      Identity of the creator of this Conversation.

    • conversation_state string

      The current state of this User Conversation. One of inactive, active or closed.

      Values are inactive, active, or closed.

    • conversation_timers

      Timer date values representing state update for this conversation.

    • links object(uri-map) | null

      Contains absolute URLs to access the participant and conversation of this conversation.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)