Create a free voice number, attach an agent, and add it to the pool

One action on purpose. A number with no agent to answer callbacks cannot be enrolled, so creating and assigning separately would leave a number the pool refuses. Free numbers are capped per voice account; the account's own message is returned when it declines. Does not dial.

POST

https://api.channelautomation.com/api/voice-campaigns/number-pools/{poolId}/provision

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

poolId
string
required
format: uuid

Request body JSON required

area_code
string
required
3-digit US area code

pattern: ^[0-9]{3}$
assistant_id
string
required
The agent that answers callbacks on this number
name
optional
string
maxLength: 60
daily_cap
optional
integer
maximum: 100000 · minimum: 1 · default: 20
min_spacing_seconds
optional
integer
maximum: 86400 · minimum: 0 · default: 60

Returns

200

Number created

400

Invalid area code

401

403

Manager role or feature access required

404

Pool not found

502

The voice account declined

Create a free voice number, attach an agent, and add it to the pool

curl --request POST \
  --url 'https://api.channelautomation.com/api/voice-campaigns/number-pools/<poolId>/provision' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "area_code": "string",
  "assistant_id": "string",
  "name": "string",
  "daily_cap": 20,
  "min_spacing_seconds": 60
}
'

const url = 'https://api.channelautomation.com/api/voice-campaigns/number-pools/<poolId>/provision';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    area_code: 'string',
    assistant_id: 'string',
    name: 'string',
    daily_cap: 20,
    min_spacing_seconds: 60
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/voice-campaigns/number-pools/<poolId>/provision"

payload = {
    "area_code": "string",
    "assistant_id": "string",
    "name": "string",
    "daily_cap": 20,
    "min_spacing_seconds": 60
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)