GetPhoneNumberRegions

POST

https://api.voximplant.com/platform_api/GetPhoneNumberRegions

POST

/platform_api/GetPhoneNumberRegions

curl -X POST "https://api.voximplant.com/platform_api/GetPhoneNumberRegions?country_code=country_code&phone_category_name=phone_category_name" \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "phone_region_id": 1,
      "phone_region_name": "Moscow",
      "phone_region_code": "499",
      "phone_count": 1123,
      "verification_status": "REQUIRED",
      "required_verification": "RU",
      "phone_period": "0-1-0 0:0:0",
      "multiple_numbers_price": [
        {
          "count": 10,
          "price": 0.4,
          "installation_price": 10
        }
      ],
      "phone_price": 0.45,
      "phone_installation_price": 10.2
    },
    {
      "phone_region_id": 3,
      "phone_region_name": "Novosibirsk",
      "phone_region_code": "383",
      "phone_count": 95,
      "phone_period": "0-1-0 0:0:0",
      "multiple_numbers_price": [],
      "phone_price": 0.5,
      "phone_installation_price": 2
    }
  ]
}

Get the country regions of the phone numbers. The response also contains the info about multiple numbers subscription for the child accounts.

Allowed roles: Owner, Admin, Accountant, Payer.

Example request: Get the Russian regions of the phone numbers.

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] method

country_statestringOptional

The country state code (example: AL, CA... )

omit_emptybooleanOptionalDefaults to true

Whether not to show all the regions (with and without phone numbers in stock)

phone_region_idintegerOptional

The phone region ID to filter

phone_region_namestringOptional

The phone region name to filter

phone_region_codestringOptional

The region phone prefix to filter

localestringOptional

The 2-letter locale code. Supported values are EN, RU

Response

Successful response

resultlist of objectsOptional