Management APIReferencePhone Numbers

GetPhoneNumbers

View as Markdown

Gets the account phone numbers.

Allowed roles: Owner, Admin, Developer, Supervisor, Accountant, Support, Payer.

Example request: Get two attached 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](/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

phone_idlist of integersOptional
Particular phone ID to filter
phone_numberlist of stringsOptional

Phone number list separated by semicolons (;) that can be used instead of phone_id

activation_statuslist of stringsOptional

Phone number activation statuses to filter, separated by semicolons (;).

The possible values are: ACTIVE, ACTIVATING, DEACTIVATED, PROVISIONING, AWAITING_BUSINESS_PHONE_NUMBER_CONFIGURATION, LEGAL_OWNERSHIP_LIMIT_REACHED, GOSUSLUGI_DECLINED, SELF_BAN_ENABLED

application_idintegerOptional
Application ID
application_namestringOptional

Application name that can be used instead of application_id

is_bound_to_applicationbooleanOptional
Whether the phone number bound to an application
phone_templatestringOptional
Phone number start to filter
country_codelist of stringsOptional

Country code list separated by semicolons (;)

phone_category_namestringOptional

Phone category name. See the [GetPhoneNumberCategories] method

canceledbooleanOptional
Whether the subscription is cancelled to filter
deactivatedbooleanOptional
Whether the subscription is frozen to filter
auto_chargebooleanOptional

Whether the auto_charge flag is enabled

from_phone_next_renewalstringOptional

UTC ‘from’ date filter in the following format: YYYY-MM-DD

to_phone_next_renewalstringOptional

UTC ‘to’ date filter in the following format: YYYY-MM-DD

from_phone_purchase_datestringOptional

UTC ‘from’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

to_phone_purchase_datestringOptional

UTC ‘to’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

child_account_idlist of integersOptional

Child account ID list separated by semicolons (;). Use the ‘all’ value to select all child accounts

children_phones_onlybooleanOptionalDefaults to false
Whether to get the children phones only
verification_namestringOptional
Required account verification name to filter
verification_statuslist of stringsOptional

Account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED

from_unverified_hold_untilstringOptional

Unverified phone hold until the date (from …) in the following format: YYYY-MM-DD

to_unverified_hold_untilstringOptional

Unverified phone hold until the date (… to) in the following format: YYYY-MM-DD

can_be_usedbooleanOptional
Whether a not verified account can use the phone
order_bystringOptional
Following values are available: 'phone_number' (ascent order), 'phone_price' (ascent order), 'phone_country_code' (ascent order), 'deactivated' (deactivated first, active last), 'purchase_date' (descent order), 'phone_next_renewal' (ascent order), 'verification_status', 'unverified_hold_until' (ascent order), 'verification_name'
sandboxstringOptional

Flag allows you to display only the numbers of the sandbox, real numbers, or all numbers. The following values are possible: ‘all’, ‘true’, ‘false’

countintegerOptionalDefaults to 100
Maximum returning record count
offsetintegerOptionalDefaults to 0

First N records are skipped in the output

phone_region_namelist of stringsOptional

Region names list separated by semicolons (;)

rule_idlist of integersOptional

Rule ID list separated by semicolons (;)

rule_namelist of stringsOptional

Rule names list separated by semicolons (;). Can be used only if application_id or application_name is specified

is_bound_to_rulebooleanOptional
Whether the phone number is bound to some rule

Response

Successful response
resultlist of objects
Phone numbers info
total_countinteger
Total found phone count
countinteger
Returned phone count