Path parameters

• ChatServiceSid string Required

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

• UserSid string Required

  The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.

Query parameters

• PageSize integer

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

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • conversations array[object]
    Hide conversations attributes Show conversations attributes array[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}$.

    • attributes string | null

      An optional string metadata field you can use to store any data you wish.

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

    • conversation_sid string | null

      The unique ID of the Conversation for this User Conversation.

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

    • conversation_state string | null

      The current state of this User Conversation

      Values are inactive, active, or closed.

    • created_by string | null

      Creator of this conversation.

    • date_created string(date-time) | null

      The date that this conversation was created.

    • date_updated string(date-time) | null

      The date that this conversation was last updated.

    • friendly_name string | null

      The human-readable name of this conversation.

    • last_read_message_index integer | null

      The index of the last read Message .

    • links object(uri-map) | null

      Absolute URLs to access the participant and conversation of this user conversation.

    • notification_level string | null

      The Notification Level of this User Conversation.

      Values are default or muted.

    • participant_sid string | null

      Participant Sid.

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

    • timers

      Timer date values for this conversation.

    • unique_name string | null

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

    • unread_messages_count integer | null

      The number of unread Messages in the Conversation.

    • url string(uri) | null
    • user_sid string | null

      The unique ID for the User.

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

  • meta object
    Hide meta attributes Show meta attributes object

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