Skip to navigation

Create a number pool

Put numbers in it in the app (Phone numbers), or with PATCH /v1/phone-numbers/{id} from a session. A key limited to some experts cannot manage pools.

Sessions: admins.

Needs the calls:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional<=80 characters
strategyenumOptional

local_presence: a number in the callee’s area code first, then their state.

Allowed values:
dailyCapPerNumberintegerOptional1-1000
Calls per number per day. Default 80.
callbackRoutingobjectOptional

Where a call back to a pool number rings, in order: the rep’s browser, their mobile, an expert, voicemail.

Response

OK
idstring
A UUID.
namestring
strategyenum
Allowed values:
dailyCapPerNumberinteger
callbackRoutingobject

Where a call back to a pool number rings, in order: the rep’s browser, their mobile, an expert, voicemail.

numberslist of objects
createdAtdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error