Skip to main content
POST
Create an 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 registration: Your endpoint SIP URI follows sip:username@registrar.vobiz.ai. Configure registrar.vobiz.ai as the registrar or server in your softphone, desk phone, or custom WebRTC SIP client. Authenticate with the endpoint username and password.Your account Auth ID and Auth Token authenticate REST API requests and the hosted WebRTC Playground. They do not authenticate SIP endpoint registration. SIP endpoints do not require a separate token or JWT.

Request Parameters

Response

On success, returns "created" in the message field along with the endpoint_id, sip_uri, and resource_uri.
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

Create with Application and Permissions

cURL Request
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
app_id
string

ID of the application that handles calls from this endpoint. Application IDs are 17-digit strings; send them as JSON strings.

Pattern: ^[0-9]+$
application
integer
deprecated

Not read by the API. Application IDs exceed the range of a JSON integer, and the endpoint is created without an application. Send app_id instead.

Response

Success

alias
string
required
endpoint_id
string
required
username
string
required