Skip to navigation
Management APIReferencePhone Numbers

GetNewPhoneNumbers

View as Markdown

Gets the new phone numbers.

Allowed roles: Owner, Admin, Accountant.

Example request: Get the two new fixed Russian phone numbers at max.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

country_codestringRequired
The country code
phone_category_namestringRequired

The phone category name. See the [GetPhoneNumberCategories] function

country_statestringOptional
The country state. See the GetPhoneNumberCategories and GetPhoneNumberCountryStates functions
phone_region_idintegerRequired

The phone region ID. See the [GetPhoneNumberRegions] method

countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

phone_number_maskstringOptional
The phone number searching mask. Asterisk represents zero or more occurrences of any character

Response

Successful response
resultlist of objectsOptional
total_countintegerOptional
The total found phone count
countintegerOptional
The returned phone count