GetRegions | Voximplant Voice AI

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.

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](/api-reference/management-api/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 objects

countinteger

$	curl -X POST "https://api.voximplant.com/platform_api/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&offset=0" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"result": [
3	{
4	"phone_region_id": 101,
5	"phone_region_name": "AACHEN",
6	"phone_region_code": "0241",
7	"is_need_regulation_address": true,
8	"regulation_address_type": "LOCAL"
9	}
10	],
11	"count": 1
12	}