v1

latestSwagger 2.02026-08-06114161439.7 KB

number

Reserve a number for to a client private available numbers

Reserves phone numbers from carrier inventory into your private pool. Reserved numbers become exclusively available to your organization and can be provisioned to call flows. Use after searching carrier inventory to secure desired numbers.

post/number/reserve

Request body

number_idinteger

The unique identifier for the phone number record

numberinteger required

The full actual phone number

sourceinteger required

Indicator that identifies which source where the number is located

Response

Reservation confirmation with status for each requested number

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).