Hosted Voice API

Extension Management

Create, update, and manage extensions

GET/hostedvoice/ext/settings

Get extension details

Parameters

extensionintegerqueryrequired

Extension number

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/ext/settings?extension={extension}" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

{
  "extension": "100",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "cli": "61299999999",
  "license_type": "standard",
  "voicemail": true,
  "call_waiting": true
}

POST/hostedvoice/ext/create

Create an extension

Parameters

extensionintegerrequired

3-7 digits, unique

passwordstringrequired

Alphanumeric, min 7 chars

first_namestringrequired

First name

last_namestringrequired

Last name

emailstringrequired

Email address

vm_pinintegeroptional

Voicemail PIN · Default: 1234

license_typestringrequired

License type

basicmailboxstandardplus

send_emailbooleanoptional

Send welcome email

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/ext/create" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "extension": 101,
  "password": "abc1234",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@example.com",
  "vm_pin": 1234,
  "license_type": "standard"
}'

Response200 Success

{
  "status": "success",
  "extension": "101"
}

POST/hostedvoice/ext/update

Update extension settings

Parameters

extensionintegerrequired

Extension number

first_namestringoptional

First name

last_namestringoptional

Last name

emailstringoptional

Email address

call_waitingbooleanoptional

Enable call waiting

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/ext/update" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "extension": 101,
  "first_name": "Jane",
  "call_waiting": true
}'

Response200 Success

{
  "status": "success"
}

POST/hostedvoice/ext/license

Update extension license

Parameters

extensionintegerrequired

Extension number

change_licensestringrequired

New license type

basicmailboxstandardplus

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/ext/license" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "extension": 101,
  "change_license": "plus"
}'

Response200 Success

{
  "status": "success"
}

POST/hostedvoice/ext/update_cli

Update extension caller ID

Parameters

actionstringrequired

Action type

update_cliupdate_sms_cli

did_idintegerrequired

DID ID

extensionintegerrequired

Extension number

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/ext/update_cli" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "update_cli",
  "did_id": 1,
  "extension": 101
}'

Response200 Success

{
  "status": "success"
}

DELETE/hostedvoice/user/remove

Delete a user or extension

Parameters

userstringrequired

Extension or group number

idintegerrequired

User/group ID (not number)

actionstringrequired

Action to perform

Request

curl \
  -X DELETE \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/user/remove" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "user": "101",
  "id": 5,
  "action": "delete_user"
}'

Response200 Success

{
  "status": "success"
}

Back to API Documentation