Skip to main content
GET
/
chat
/
sessions
/
{session_id}
Get a chat session
curl --request GET \
  --url https://api.open.cx/chat/sessions/{session_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "ai_closure_type": "assumed_resolved",
  "sentiment": "angry",
  "channel": {
    "type": "web"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "contact": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "phone_number": "<string>",
    "name": "<string>",
    "custom_data": {}
  },
  "language": "<string>",
  "assignee_id": "<string>",
  "custom_data": {},
  "team": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>"
  },
  "handoff": {
    "summary": "<string>",
    "sentiment": "angry"
  },
  "ticketing_system": {
    "name": "dynamics365",
    "external_id": "<string>",
    "id_type": "conversation_id"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
session_id
string
required

Response

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
open,
closed_resolved,
closed_unresolved
​
ai_closure_type
enum<string> | null
required
Available options:
assumed_resolved,
handed_off,
resolved
​
sentiment
enum<string> | null
required
Available options:
angry,
happy,
neutral
​
channel
object
required
​
created_at
string<date-time> | null
required

ISO 8601 date-time string

​
updated_at
string<date-time> | null
required

ISO 8601 date-time string

​
contact
object
​
language
string
​
assignee_id
string
​
custom_data
object
​
team
object

Present if the session is assigned to a team.

​
handoff
object

Present if the conversation was handed off to a human.

​
ticketing_system
object

Present if the session is associated with a ticketing system.