Sign in

v1

latestOpenAPI 3.1.0Apache-2.02026-07-17144068.3 KB
sip

Handler for POST /sip/call endpoint

Initiates an outbound SIP call through LiveKit. The optional sip object in the request body allows overriding global SIP configuration on a per-request basis. Request body values take priority over global config, enabling different SIP providers or credentials for specific calls.

post/sip/call

Request body

from_phone_numberstring required

Phone number the call will originate from. Must be configured in your SIP provider. Supports international format (+1234567890).

participant_identitystring required

Identity for the SIP participant in the room

participant_namestring required

Display name for the SIP participant in the room

room_namestring required

The LiveKit room name to connect the call to

to_phone_numberstring required

Phone number to dial. Supports international format (+1234567890), national format (07123456789), or extensions (1234).

Example request

{
  "from_phone_number": "+15105550123",
  "participant_identity": "caller-456",
  "participant_name": "John Doe",
  "room_name": "call-room-123",
  "sip": {
    "auth_password": "secure_password_456",
    "auth_username": "sip_user_123",
    "outbound_address": "sip.provider.com:5060"
  },
  "to_phone_number": "+15551234567"
}

Response

Call initiated successfully

participant_idstring required

The unique participant ID assigned by LiveKit

participant_identitystring required

The identity of the SIP participant in the room

room_namestring required

The room name where the call was connected

sip_call_idstring required

The unique SIP call ID for tracking

statusstring required

Status of the call request ("initiated")

Example response

{
  "participant_id": "PA_abc123",
  "participant_identity": "caller-456",
  "room_name": "call-room-123",
  "sip_call_id": "SC_xyz789",
  "status": "initiated"
}