Skip to main content
POST
/
api
/
v1
/
voice
/
sessions
Create a new voice session
curl --request POST \
  --url https://dev-chat-engine.actualize.ae/api/v1/voice/sessions \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "phoneNumber": "<string>",
  "platform": "<string>",
  "metadata": {},
  "direction": "<string>"
}
'
{
  "id": "<string>",
  "agent": {},
  "metadata": {},
  "state": "IDLE",
  "createdAt": "2023-11-07T05:31:56Z"
}

Body

application/json
​
platform
string
required

The Platform where the session is initiated

​
metadata
object
required

Metadata for the chat session

​
direction
string
required

The direction of the voice session, ex: INBOUND or OUTBOUND

​
agentId
string

The ID of the agent for this voice session

​
phoneNumber
string

The phone number attched to the agent

Response

The voice session has been created successfully.

​
id
string
required

The unique identifier for the voice session

​
agent
object
required

The details of the current agent

​
metadata
object
required

Metadata for the voice session

​
state
enum<string>
required

The current state of the voice session

Available options:
IDLE,
ACTIVE,
CLOSED
​
createdAt
string<date-time>
required

The creation timestamp of the voice session