sip
Handler for POST /sip/transfer endpoint
Initiates a SIP REFER transfer for a participant in a LiveKit room. The transfer moves an ongoing SIP call to a different phone number.
Arguments
- state - Shared application state containing LiveKit handlers
- auth - Authentication context for room metadata authorization
- request - Transfer request with room name, participant identity, and destination
Returns
- Response - JSON response with transfer status or error
Errors
- 400 Bad Request - Invalid phone number format or empty fields
- 404 Not Found - Room not found, not accessible, or participant not found
- 500 Internal Server Error - LiveKit not configured or transfer operation failed
Flow
- Validate the phone number format
- Check LiveKit handlers are configured
- Check room access via metadata auth_id
- Verify the participant exists and is a SIP participant
- Execute the SIP transfer
- Return success or appropriate error
post/sip/transfer
Request body
Example request
{
"participant_identity": "sip_participant_456",
"room_name": "call-room-123",
"transfer_to": "+15551234567"
}Response
Transfer initiated successfully
Example response
{
"participant_identity": "sip_participant_456",
"room_name": "call-room-123",
"status": "initiated",
"transfer_to": "tel:+15551234567"
}Changes
Changed in 3 of the 13 revisions of this API.13
- ○
the endpoint scheme security
authwas added to the APIapi-security-added
- ○
the endpoint scheme security
bearer_authwas removed from the APIapi-security-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
endpoint added
endpoint-added
- ○
- ▲
api path removed without deprecation
api-path-removed-without-deprecation
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲