REST endpoints

Delete SIP hooks

Removes the specified hosts from the cache. Hosts defined in the application configuration cannot be removed. If a host exists in the original server configuration, it will revert to its config value after deletion of a cached override. Hosts that only exist in cache will be completely removed.

The changes take effect immediately and persist across server restarts.

Request Body

Array of host names to remove (case-insensitive).

Returns

200 OK - Updated list of SIP hooks after deletion
400 Bad Request - If the hosts array is empty
500 Internal Server Error - If writing the cache fails

DELETE

sip

hooks

Deletes SIP hooks by host name.

curl --request DELETE \
  --url https://api.sayna.ai/sip/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hosts": [
    "example.com",
    "other.com"
  ]
}
'

{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}

Remove SIP webhook forwarding entries by host name.

Body: { hosts: [] } array of host names (case-insensitive); empty arrays are rejected.
Hosts present in server config revert to their config values after deletion; cache-only hosts are removed entirely.
Changes apply immediately and persist across restarts. Auth still applies when AUTH_REQUIRED=true; failures return 500 if cache writing fails.

Authorizations

Authorization

string

header

required

Authentication token for protected endpoints. Can be provided as Authorization: Bearer <token> or ?api_key=<token>. Required when AUTH_REQUIRED is enabled.

Body

application/json

Request body for deleting SIP hooks.

Contains a list of host names to remove from the SIP hooks cache.

hosts

string[]

List of host names to remove (case-insensitive). Hosts that exist in the original config will revert to their config values.

Example:

["example.com", "other.com"]

Response

Updated list of SIP hooks after deletion

Response body for SIP hooks operations.

hooks

object[]

required

List of all configured SIP hooks

Show child attributes

SIP transferInitiates 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 1. Validate the phone number format 2. Check LiveKit handlers are configured 3. Check room access via metadata auth_id 4. Verify the participant exists and is a SIP participant 5. Execute the SIP transfer 6. Return success or appropriate error

Deletes SIP hooks by host name.

curl --request DELETE \
  --url https://api.sayna.ai/sip/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hosts": [
    "example.com",
    "other.com"
  ]
}
'

{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}