GetPhoneNumbersRequest
Props
activationStatus: string
| string[]
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
applicationId: number
Application ID
applicationName: string
Application name that can be used instead of application_id
autoCharge: boolean
Whether the auto_charge flag is enabled
canBeUsed: boolean
Whether a not verified account can use the phone
canceled: boolean
Whether the subscription is cancelled to filter
childAccountId: number
| number[]
| any
Child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts
childrenPhonesOnly: boolean
Whether to get the children phones only
count: number
Maximum returning record count
countryCode: string
| string[]
Country code list separated by semicolons (;)
deactivated: boolean
Whether the subscription is frozen to filter
fromPhoneNextRenewal: Date
UTC 'from' date filter in the following format: YYYY-MM-DD
fromPhonePurchaseDate: Date
UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
fromUnverifiedHoldUntil: Date
Unverified phone hold until the date (from …) in the following format: YYYY-MM-DD
isBoundToApplication: boolean
Whether the phone number bound to an application
isBoundToRule: boolean
Whether the phone number is bound to some rule
offset: number
First N records are skipped in the output
orderBy: string
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'
phoneCategoryName: string
Phone category name. See the method
phoneId: number
| number[]
| any
Particular phone ID to filter
phoneNumber: string
| string[]
Phone number list separated by semicolons (;) that can be used instead of phone_id
phoneRegionName: string
| string[]
Region names list separated by semicolons (;)
phoneTemplate: string
Phone number start to filter
ruleId: number
| number[]
| any
Rule ID list separated by semicolons (;)
ruleName: string
| string[]
Rule names list separated by semicolons (;). Can be used only if application_id or application_name is specified
sandbox: string
Flag allows you to display only the numbers of the sandbox, real numbers, or all numbers. The following values are possible: 'all', 'true', 'false'
smsSupported: boolean
toPhoneNextRenewal: Date
UTC 'to' date filter in the following format: YYYY-MM-DD
toPhonePurchaseDate: Date
UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
toUnverifiedHoldUntil: Date
Unverified phone hold until the date (… to) in the following format: YYYY-MM-DD
verificationName: string
Required account verification name to filter
verificationStatus: string
| string[]
Account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED