Skip to main content
GET
/
api
/
sip
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/sip \
  --header 'X-API-Key: <api-key>'
{
  "allowedCidrRanges": [
    "<string>"
  ],
  "allowAllAgents": false,
  "allowedAgents": [
    {
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "toUserPattern": "<string>"
    }
  ],
  "domain": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key

Response

200 - application/json
​
allowedAgents
object[]
required

Calls must match a pattern for one of these agents (or the global agent pattern if allowAllAgents is true) to be accepted.

Maximum length: 20
​
domain
string
required

The domain used for SIP invites for your account.

​
allowedCidrRanges
string<ipv4-cidr>[]

The list of IPv4 CIDR ranges from which incoming SIP calls will be accepted.

​
allowAllAgents
boolean
default:false

If true, adds an implicit allowance for requests matching agent_<agent_id>@<anydomain> for any of your agents.