Skip to main content
Get a number

Authorizations

Authorization
string
header
required

Every request sends Authorization: Bearer <token>. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key ft_<id>_<secret>. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute.

Path Parameters

id
string<uuid>
required

Response

The number.

destination_type
enum<string>
required

Where the number's calls go: extension (a phone), queue, flow (an IVR), process, conference (a room), external (forwarded to another number), client_trunk (a client's own PBX; only where that module is on) or recorder.

Available options:
extension,
queue,
external,
flow,
process,
recorder,
conference,
client_trunk
e164
string
required

The number, in E.164 form with the plus.

Example:

"+61300000001"

enabled
boolean
required

Whether the number is in service. A disabled number's calls are refused.

id
string<uuid>
required

The number's id.

organisation_id
string<uuid>
required

The organisation the number belongs to. May be left out by a caller with exactly one organisation.

destination_id
string<uuid> | null

The id of the extension, queue, IVR flow, process, room or client trunk the number goes to. Must belong to the number's organisation. Not used for external.

destination_value
string | null

For external: the number to forward to, normalised to E.164. For extension: the extension number, as an alternative to destination_id.

monthly_rental
string

Exact decimal amount as a string. Never a JSON number: rates are fractions of a cent and binary floating point cannot represent them exactly.

Example:

"12.5000"

team_id
string<uuid> | null

The team the number belongs to, if any; a team supervisor sees only their teams' numbers.

trunk_id
string<uuid>

The trunk this number arrives on, when it is pinned to one.