Skip to main content
PATCH
/
api
/
sessions
/
{session_id}
Update Session
curl --request PATCH \
  --url http://localhost:8000/api/sessions/{session_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "CREATED",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "metadata": {}
}
'
{
  "room_name": "<string>",
  "id": "<string>",
  "status": "CREATED",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "user_id": "<string>",
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "session_data": {},
  "agent_name": "<string>",
  "call_direction": "INBOUND",
  "outbound_phone_number": "<string>",
  "call_status": "RINGING",
  "analysis": {},
  "transferred_to": "<string>",
  "transfer_type": "WARM",
  "transfer_timestamp": "2023-11-07T05:31:56Z"
}

Path Parameters

​
session_id
string
required

Body

application/json
​
status
enum<string> | null
Available options:
CREATED,
ACTIVE,
COMPLETED,
FAILED
​
ended_at
string<date-time> | null
​
duration
integer | null
​
metadata
Metadata · object

Response

Successful Response

​
room_name
string
required
​
id
string
required
​
status
enum<string>
required
Available options:
CREATED,
ACTIVE,
COMPLETED,
FAILED
​
started_at
string<date-time> | null
required
​
ended_at
string<date-time> | null
required
​
duration
integer | null
required
​
user_id
string
required
​
agent_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
session_data
Session Data · object
​
agent_name
string | null
​
call_direction
enum<string> | null
Available options:
INBOUND,
OUTBOUND
​
outbound_phone_number
string | null
​
call_status
enum<string> | null
Available options:
RINGING,
ANSWERED,
COMPLETED,
FAILED,
NO_ANSWER
​
analysis
Analysis · object
​
transferred_to
string | null
​
transfer_type
enum<string> | null
Available options:
WARM,
COLD
​
transfer_timestamp
string<date-time> | null