GetPhoneNumberCategories | Voximplant Voice AI

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

{
  "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.

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_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 objects

1	{
2	"result": [
3	{
4	"country_code": "RU",
5	"phone_prefix": "7",
6	"can_list_phone_numbers": true,
7	"phone_categories": [
8	{
9	"phone_category_name": "GEOGRAPHIC",
10	"country_has_states": false
11	},
12	{
13	"phone_category_name": "MOBILE",
14	"country_has_states": false
15	}
16	]
17	},
18	{
19	"country_code": "US",
20	"phone_prefix": "1",
21	"can_list_phone_numbers": false,
22	"phone_categories": [
23	{
24	"phone_category_name": "GEOGRAPHIC",
25	"country_has_states": true
26	},
27	{
28	"phone_category_name": "TOLLFREE",
29	"country_has_states": false
30	}
31	]
32	}
33	]
34	}