Skip to content
Ring2All Documentation

Create SIP Extension

View as Markdown
POST
/pbx/extensions
curl --request POST \
  --url https://pbx.ring2all.com/api/v1/pbx/extensions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "extension": "1002", "password": "SuperSipPassw0rd!#9", "display_name": "Support Agent 02", "voicemail_enabled": true, "call_recording": "always" }'

Provisions a new extension with Sofia SIP profile credentials and mailbox options.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
extension
required
string
Example
1002
password
required
string format: password
Example
SuperSipPassw0rd!#9
display_name
required
string
Example
Support Agent 02
voicemail_enabled
boolean
default: true
call_recording
string
default: always
Allowed values: always never on_demand

Responses

Section titled “ Responses ”

201

Section titled “201”

Extension created successfully

Media typeapplication/json
object
id
integer
extension
string
display_name
string
voicemail_enabled
boolean
status
string
Allowed values: registered unregistered
user_agent
string
Example
{
  "id": 101,
  "extension": "1001",
  "display_name": "Operations Desk",
  "voicemail_enabled": true,
  "status": "registered",
  "user_agent": "Grandstream GRP2614 1.0.7.23"
}