GetPhoneNumberCategories

POST

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

POST

/platform_api/GetPhoneNumberCategories

curl -X POST https://api.voximplant.com/platform_api/GetPhoneNumberCategories \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "country_code": "RU",
      "phone_prefix": "7",
      "can_list_phone_numbers": true,
      "phone_categories": [
        {
          "phone_category_name": "GEOGRAPHIC",
          "country_has_states": false
        },
        {
          "phone_category_name": "MOBILE",
          "country_has_states": false
        }
      ]
    },
    {
      "country_code": "US",
      "phone_prefix": "1",
      "can_list_phone_numbers": false,
      "phone_categories": [
        {
          "phone_category_name": "GEOGRAPHIC",
          "country_has_states": true
        },
        {
          "phone_category_name": "TOLLFREE",
          "country_has_states": false
        }
      ]
    }
  ]
}

Gets the phone number categories.

Allowed roles: Owner, Admin, Accountant, Payer.

Example request: Get the all phone number categories.

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_codelist of stringsOptional

Country code list separated by semicolons (;)

sandboxstringOptional

Flag allows you to display phone number categories only of the sandbox, real or all .The following values are possible: 'all', 'true', 'false'

localestringOptional

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

Response

Successful response

resultlist of objectsOptional