SIP Endpoints
Create an Endpoint
Create a new SIP endpoint that can be used to make and receive calls through IP phones, softphones, or SIP clients. Each endpoint is assigned a unique SIP URI and endpoint ID.
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Endpoint
Create an Endpoint
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/ \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data @- <<EOF
{
"username": "john_doe",
"password": "SecurePassword123!",
"alias": "John's Desktop Phone",
"application": 12345678
}
EOF{
"alias": "Acme Desktop Phone",
"endpoint_id": "193962768711692",
"username": "acme_sip_user_01"
}Documentation Index
Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt
Use this file to discover all available pages before exploring further.
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/
Authentication required:
X-Auth-ID- Your account Auth ID (e.g.,{auth_id})X-Auth-Token- Your account Auth TokenContent-Type: application/json
SIP URI: Your endpoint will be assigned a SIP URI in the format
sip:username@sip.vobiz.aiRequest Parameters
| Field | Type | Required | Description |
|---|---|---|---|
username | string | Yes | SIP username (unique per account). Only alphanumeric characters are accepted. |
password | string | Yes | SIP password. Minimum 8 characters recommended for security. |
alias | string | No | Friendly name for the endpoint. Accepts alphabets, numbers (0-9), hyphen (-), and underscore (_) only. |
application | integer | No | Application ID for call routing. If null, uses default application. |
allow_voice | boolean | No | Allow voice calls (default: true). |
allow_message | boolean | No | Allow messaging (default: true). |
allow_video | boolean | No | Allow video calls (default: false). |
allow_same_domain | boolean | No | Allow calls to same domain (default: true). |
allow_other_domains | boolean | No | Allow calls to other domains (default: false). |
allow_phones | boolean | No | Allow calls to phone numbers (default: true). |
allow_apps | boolean | No | Allow calls to apps (default: true). |
sub_account | string | No | Sub-account auth_id (if creating for sub-account). |
Response
On success, returns"created" in the message field along with the endpoint_id, sip_uri, and resource_uri.
{
"api_id": "550e8400-e29b-41d4-a716-446655440000",
"message": "created",
"endpoint_id": "87654321",
"sip_uri": "sip:john_doe@sip.vobiz.ai",
"resource_uri": "/v1/Account/{auth_id}/Endpoint/87654321/"
}
Examples
Basic Endpoint Creation
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"username": "sales_desk",
"password": "VerySecurePass123!",
"alias": "Sales Team Desk Phone",
"allow_voice": true
}'
Create with Application and Permissions
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"username": "john_doe",
"password": "SecurePassword123!",
"alias": "John'\''s Desktop Phone",
"application": 12345678,
"allow_voice": true,
"allow_message": true,
"allow_video": false,
"allow_same_domain": true,
"allow_other_domains": false,
"allow_phones": true,
"allow_apps": true
}'
Best Practices:
- Use strong passwords (minimum 8 characters, mix of letters/numbers/symbols)
- Use descriptive aliases to easily identify endpoints
- Store the
endpoint_idandsip_urisecurely for future operations - Only enable permissions your endpoints actually need
- Attach applications for automatic call routing
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Body
application/json
Was this page helpful?
⌘I
Create an Endpoint
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/ \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data @- <<EOF
{
"username": "john_doe",
"password": "SecurePassword123!",
"alias": "John's Desktop Phone",
"application": 12345678
}
EOF{
"alias": "Acme Desktop Phone",
"endpoint_id": "193962768711692",
"username": "acme_sip_user_01"
}