Skip to main content
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"
}
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/
Creates a new SIP endpoint for making and receiving calls through IP phones, softphones, or SIP clients. Each endpoint is assigned a unique SIP URI and endpoint ID.
Authentication required:
  • X-Auth-ID - Your account Auth ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
SIP URI: Your endpoint is assigned a SIP URI in the format sip:username@sip.vobiz.ai. After creation, point a softphone, desk phone, or WebRTC browser client at sip.vobiz.ai and register with the username/password to bring the device online. There is no separate token/JWT step - the SIP credentials are the auth.

​
Request Parameters

FieldTypeRequiredDescription
usernamestringYesSIP username, unique per account and immutable after creation. Only alphanumeric characters are accepted - hyphens, underscores, spaces, and other symbols may be rejected with a 400. A duplicate username returns a 409 conflict.
passwordstringYesSIP password. Minimum 8 characters recommended. Write-only - never returned in any response.
aliasstringYesFriendly name for the endpoint. Accepts alphabets, numbers (0-9), hyphen (-), and underscore (_) only.
applicationintegerRecommendedNumeric app_id for call routing. If omitted, the endpoint falls back to the account’s default_endpoint_app (if one is set); otherwise it has no call-handling application.
allow_voicebooleanNoAllow voice calls (default: true).
allow_messagebooleanNoAllow messaging (default: true).
allow_videobooleanNoAllow video calls (default: false).
allow_same_domainbooleanNoAllow calls to same domain (default: true).
allow_other_domainsbooleanNoAllow calls to other domains (default: false).
allow_phonesbooleanNoAllow calls to phone numbers (default: true).
allow_appsbooleanNoAllow calls to apps (default: true).
sub_accountstringNoSub-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/"
}
A 400 is returned for invalid field values (non-alphanumeric username, short password, missing required field); a 409 when the username is already taken on your account.

​
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_id and sip_uri securely for future operations
  • Only enable permissions your endpoints actually need
  • Attach applications for automatic call routing

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Body

application/json
​
username
string
required
​
password
string
required
​
alias
string
required
​
application
integer
required

Response

Success

​
alias
string
required
​
endpoint_id
string
required
​
username
string
required