Skip to main content
POST
/
api
/
v2
/
sip
/
registration
/
available
Check SIP registration AOR availability
curl --request POST \
  --url 'https://api.vida.dev/api/v2/sip/registration/available?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aor": "1001@sip.example.com",
  "username": "1001",
  "sipRealm": "sip.example.com"
}
'
{
  "success": true,
  "available": true,
  "message": "AOR is available"
}

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
​
aor
string

Full SIP AOR to validate

Example:

"1001@sip.example.com"

​
username
string

Username portion used to build the AOR when aor is omitted

Example:

"1001"

​
sipRealm
string

SIP realm combined with username to build the AOR

Example:

"sip.example.com"

Response

Availability response

​
success
boolean
Example:

true

​
available
boolean
Example:

true

​
message
string
Example:

"AOR is available"