Hosted Voice API

Outbound Calling

Manage outbound calling lists for call queues

POST/hostedvoice/outbound_calling/create

Add outbound calling entry

Parameters

accountintegerrequired

Call queue account number

numberstringrequired

E164 format

namestringrequired

Descriptive name

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/outbound_calling/create" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "account": 400,
  "number": "61299999999",
  "name": "Customer callback"
}'

Response200 Success

{
  "status": "success"
}

GET/hostedvoice/outbound_calling/list

List outbound calling entries

Parameters

accountintegerqueryrequired

Call queue account

pageintegerqueryoptional

Page number

sizeintegerqueryoptional

Max 50

Request

curl \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/outbound_calling/list?account={account}&page={page}&size={size}" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}"

Response200 Success

[
  {
    "id": 1,
    "number": "61299999999",
    "name": "Customer callback",
    "status": "pending"
  }
]

DELETE/hostedvoice/outbound_calling/delete

Remove outbound calling entry

Parameters

accountintegerrequired

Call queue account number

idintegerrequired

Entry ID

Request

curl \
  -X DELETE \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/outbound_calling/delete" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "account": 400,
  "id": 1
}'

Response200 Success

{
  "status": "success"
}

POST/hostedvoice/outbound_calling/reset

Reset number status

Parameters

accountstringrequired

Call queue account number

idstringrequired

Entry ID

Request

curl \
  -X POST \
  "https://n8n2.atomcomm.com/webhook/hostedvoice/hostedvoice/outbound_calling/reset" \
  -H "Authorization: {{access_token}}" \
  -H "Domain-Name: {{domain_name}}" \
  -H "service_id: {{service_id}}" \
  -H "Content-Type: application/json" \
  -d '{
  "account": "400",
  "id": "1"
}'

Response200 Success

{
  "status": "success"
}

Back to API Documentation