Hosted Voice API

Groups

Hunt groups, auto attendants, and call queues

GET/hostedvoice/service_flags

Get service flags

No parameters required.

Request

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

Response200 Success

[
  {
    "flag": "Office Hours"
  },
  {
    "flag": "After Office Hours"
  }
]

GET/hostedvoice/icp

Get input code prompts

No parameters required.

Request

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

Response200 Success

[
  {
    "id": 1,
    "name": "Main IVR"
  }
]

GET/hostedvoice/hunt_group

Get hunt groups

No parameters required.

Request

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

Response200 Success

[
  {
    "account": "200",
    "display_name": "Sales",
    "agents": [
      "100",
      "101",
      "102"
    ],
    "call_count": 5
  }
]

GET/hostedvoice/attendants

Get auto attendants

No parameters required.

Request

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

Response200 Success

[
  {
    "account": "300",
    "display_name": "Main Menu"
  }
]

GET/hostedvoice/call_queue

Get call queues

No parameters required.

Request

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

Response200 Success

[
  {
    "account": "400",
    "display_name": "Support Queue",
    "active_agents": 3,
    "all_agents": 5
  }
]

Back to API Documentation