Hosted Voice API

Resources

List extensions, users, licenses, and DIDs

GET/hostedvoice/extensions

List all extensions

No parameters required.

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/extensions" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

[
  {
    "extension": "100",
    "display_name": "John Doe",
    "voicemail": true,
    "registered": true,
    "numbers": [
      "61299999999"
    ],
    "cli": "61299999999",
    "license_type": "standard"
  }
]

GET/hostedvoice/users

List all users (extensions and groups)

No parameters required.

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/users" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

[
  {
    "id": 1,
    "extension": "100",
    "display_name": "John Doe",
    "type": "extensions",
    "cli": [
      "61299999999"
    ]
  }
]

GET/hostedvoice/license/available

Get available license count

No parameters required.

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/license/available" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

{
  "Standard": 5,
  "Basic": 3,
  "Mailbox": 2,
  "Plus": 1
}

GET/hostedvoice/did

Get DID numbers in inventory

No parameters required.

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/did" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

[
  {
    "id": 1,
    "did": "61299999999",
    "type": "geographical"
  }
]

Back to API Documentation