Skip to navigation
Management APIReferenceRegulation Address

GetRegions

View as Markdown

Gets available regions in a country.

Allowed roles: Owner, Admin, Accountant.

Example request: Get regions with city AACHEN.

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 according to the ISO 3166-1 alpha-2

phone_category_namestringRequired

The phone category name. See the [GetPhoneNumberCategories] method

city_namestringOptional
The pattern of city's name
countintegerOptional
The returned regions count
offsetintegerOptional

The first N records are skipped in the output

Response

Successful response
resultlist of objectsOptional
countintegerOptional