GET
/
chat
/
sessions
curl --request GET \
  --url http://localhost:8080/chat/sessions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "open",
      "channel": {
        "type": "web"
      },
      "contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "phone_number": "<string>",
        "name": "<string>",
        "custom_data": {}
      },
      "language": "<string>",
      "assignee_id": "<string>",
      "handoff": {
        "sentiment": "angry",
        "summary": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
handed_off
boolean
​
channel_type
enum<string>
Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
api,
web_voice
​
status
enum<string>
Available options:
open,
closed_resolved,
closed_unresolved
​
cursor
string

Pagination cursor to fetch the next set of results

Response

200
application/json

Paginated response.

​
items
object[]
required
​
next
string | null
required

The cursor for the request to get the next set of items. Null if there is no more data.

Was this page helpful?

Get a chat sessionUpdate a chat session