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