GetNewPhoneNumbers | Voximplant Voice AI

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

{
  "result": [
    {
      "phone_id": 10,
      "phone_number": "74957893798",
      "phone_price": 0.45,
      "phone_installation_price": 10.2,
      "phone_country_code": "RU",
      "phone_period": "0-1-0 0:0:0",
      "phone_category_name": "GEOGRAPHIC"
    },
    {
      "phone_id": 12,
      "phone_number": "78332606030",
      "phone_price": 0.5,
      "phone_installation_price": 11.3,
      "phone_country_code": "RU",
      "phone_period": "0-1-0 0:0:0",
      "phone_category_name": "GEOGRAPHIC"
    }
  ],
  "total_count": 400,
  "count": 2
}

Gets the new phone numbers.

Allowed roles: Owner, Admin, Accountant.

Example request: Get the two new fixed Russian phone numbers at max.

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

phone_category_namestringRequired

The phone category name. See the [GetPhoneNumberCategories] function

country_statestringOptional

The country state. See the GetPhoneNumberCategories and GetPhoneNumberCountryStates functions

phone_region_idintegerRequired

The phone region ID. See the [GetPhoneNumberRegions] method

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

phone_number_maskstringOptional

The phone number searching mask. Asterisk represents zero or more occurrences of any character

Response

Successful response

resultlist of objects

total_countinteger

The total found phone count

countinteger

The returned phone count