Skip to main content
POST
/
api
/
sip
/
registrations
cURL
curl --request POST \
  --url https://api.ultravox.ai/api/sip/registrations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "username": "<string>",
  "password": "<string>",
  "proxy": "<string>",
  "outboundProxy": "<string>",
  "authUser": "<string>"
}
'
{
  "registrationId": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "username": "<string>",
  "proxy": "<string>",
  "successful": true,
  "outboundProxy": "<string>",
  "authUser": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key

Body

application/json
​
username
string
required

The SIP username to register as.

Maximum string length: 60
​
password
string
required

The SIP password for username.

​
proxy
string
required

The SIP server to register with.

Maximum string length: 100
​
outboundProxy
string | null

A proxy used to reach your SIP server for registration. Most often unset, but may be used if you need to register as alice@trunk.com using proxy.trunk.com for example.

Maximum string length: 100
​
authUser
string | null

The authentication username, if different from the SIP username. Most often unset.

Maximum string length: 60

Response

201 - application/json
​
registrationId
string
required
​
created
string<date-time>
required
​
username
string
required

The SIP username to register as.

Maximum string length: 60
​
proxy
string
required

The SIP server to register with.

Maximum string length: 100
​
successful
boolean | null
required

Whether the registration was successfully created and is now active. May be null if status is not available yet.

​
outboundProxy
string | null

A proxy used to reach your SIP server for registration. Most often unset, but may be used if you need to register as alice@trunk.com using proxy.trunk.com for example.

Maximum string length: 100
​
authUser
string | null

The authentication username, if different from the SIP username. Most often unset.

Maximum string length: 60