Skip to main content
POST
/
api
/
v2
/
sip
/
registration
Create or update SIP registration
curl --request POST \
  --url 'https://api.vida.dev/api/v2/sip/registration?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aor": "1001@sip.example.com",
  "username": "1001",
  "authUsername": "auth-1001",
  "password": "supersecret",
  "sipRealm": "sip.example.com",
  "proxy": "sip.example.com:5061",
  "port": 5060,
  "transport": "TLS",
  "subscribe": false
}
'
{
  "success": true,
  "message": "Registration updated successfully"
}

Documentation Index

Fetch the complete documentation index at: https://vida.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
​
aor
string

Full SIP Address of Record

Example:

"1001@sip.example.com"

​
username
string

SIP username

Example:

"1001"

​
authUsername
string

SIP auth username (Authorization header)

Example:

"auth-1001"

​
password
string

SIP password

Example:

"supersecret"

​
sipRealm
string

SIP realm / domain

Example:

"sip.example.com"

​
proxy
string

Outbound proxy

Example:

"sip.example.com:5061"

​
port
number

Registration port

Example:

5060

​
transport
string

Transport protocol

Example:

"TLS"

​
subscribe
boolean

Whether to subscribe for presence

Example:

false

Response

Registration updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Registration updated successfully"