Sign in

v1

latestOpenAPI 3.0.12026-07-2691137122.3 KB
CallingService

Create Call

post/api/v1/calling/create-call

Request body

type'web_call' | 'outbound_call' required

Call type

agent_idstring required

Agent UUID

from_phone_numberstring required

Caller ID (for outbound)

to_phone_numberstring required

Destination phone (for outbound)

metadataobject

Custom key-value metadata

prompt_dynamic_variablesobject

Variables for agent prompt

Example request

{
  "type": "outbound_call",
  "agent_id": "<string>",
  "from_phone_number": "<string>",
  "to_phone_number": "<string>",
  "metadata": {},
  "prompt_dynamic_variables": {}
}

Response

Successful response

successboolean
messagestring
access_tokenstring

LiveKit access token

room_idstring

Room ID for the created call session

session_idstring

Call session UUID

urlstring

LiveKit WebSocket URL

Example response

{
  "success": true,
  "message": "call created successfully",
  "access_token": "<string>",
  "room_id": "call_019eb7e0-075d-742b-91ea-94cddde0534a",
  "session_id": "019eb7e0-075d-742b-91ea-94cddde0534a",
  "url": "<string>"
}