API ReferenceNumbers

Claim the first available number matching criteria

Convenience wrapper that picks the first available number of the requested type + country and provisions it for the target agent in one call. Equivalent to GET /v1/numbers/available followed by POST /v1/numbers.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
agent_idstringRequired
typeenumRequired
Allowed values:
channelslist of enumsRequired
Allowed values:
country_codestringOptionalDefaults to NG

Response

Number claimed
number_idstringOptional
e164stringOptional
typeenumOptional
statusenumOptional
agent_idstringOptional
channelslist of enumsOptional
mnostringOptional
provisioned_atdatetimeOptional

Errors

409
Auto Provision Number Request Conflict Error