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