Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Endpoint

Create an Endpoint

Create a new SIP endpoint for making and receiving calls.

This API allows you to 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.

Authentication Required:

  • • Bearer Token: Include in Authorization header
  • • X-Auth-ID Header: Your account ID (e.g., {Auth_ID})

SIP URI: Your endpoint will be assigned a SIP URI in the formatsip:username@sip.vobiz.ai

HTTP Request

POSThttps://api.vobiz.ai/api/v1/Account/{authID}/Endpoint/

Request Parameters

Request Parameters

NameTypeDescription
usernameRequired
stringSIP username (unique per account). Only alphanumeric characters are accepted.
passwordRequired
stringSIP password. Minimum 8 characters recommended for security.
alias
stringFriendly name for the endpoint. Accepts alphabets, numbers (0-9), hyphen (-), and underscore (_) only.
application
integerApplication ID for call routing. If null, uses default application.
allow_voice
booleanAllow voice calls (default: true).
allow_message
booleanAllow messaging (default: true).
allow_video
booleanAllow video calls (default: false).
allow_same_domain
booleanAllow calls to same domain (default: true).
allow_other_domains
booleanAllow calls to other domains (default: false).
allow_phones
booleanAllow calls to phone numbers (default: true).
allow_apps
booleanAllow calls to apps (default: true).
sub_account
stringSub-account auth_id (if creating for sub-account).

Response

If successful, returns "created" in the message field along with the endpoint_id, sip_uri, and resource_uri.

Response - 201 Created
{
  "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/"
}
Error Response - 400 Bad Request
{
  "error": "invalid request parameters",
  "details": {
    "username": "This username already exists",
    "password": "Password must be at least 8 characters"
  }
}

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
The Endpoint Object
Delete an Endpoint