Rate this page:

GetPhoneNumbersRequest

Props

applicationId

Copy URL
applicationId: 

number

|

undefined

The application ID

applicationName

Copy URL
applicationName: 

string

|

undefined

The application name that can be used instead of application_id

autoCharge

Copy URL
autoCharge: 

false

|

undefined

|

true

Whether the auto_charge flag is enabled

canBeUsed

Copy URL
canBeUsed: 

false

|

undefined

|

true

Whether a not verified account can use the phone

canceled

Copy URL
canceled: 

false

|

undefined

|

true

Whether the subscription is cancelled to filter

childAccountId

Copy URL
childAccountId: 

any

|

number

|

number[]

The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts

childrenPhonesOnly

Copy URL
childrenPhonesOnly: 

false

|

undefined

|

true

Whether to get the children phones only

count

Copy URL
count: 

number

|

undefined

The max returning record count

countryCode

Copy URL
countryCode: 

string

|

string[]

The country code list separated by semicolons (;)

deactivated

Copy URL
deactivated: 

false

|

undefined

|

true

Whether the subscription is frozen to filter

fromPhoneNextRenewal

Copy URL
fromPhoneNextRenewal: 

Date

The UTC 'from' date filter in format: YYYY-MM-DD

fromPhonePurchaseDate

Copy URL
fromPhonePurchaseDate: 

Date

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

fromUnverifiedHoldUntil

Copy URL
fromUnverifiedHoldUntil: 

Date

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

isBoundToApplication

Copy URL
isBoundToApplication: 

false

|

undefined

|

true

Whether the phone number bound to an application

isBoundToRule

Copy URL
isBoundToRule: 

false

|

undefined

|

true

Whether the phone number is bound to some rule

offset

Copy URL
offset: 

number

|

undefined

The first N records are skipped in the output

orderBy

Copy URL
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

Copy URL
phoneCategoryName: 

string

|

undefined

The phone category name. See the method

phoneId

Copy URL
phoneId: 

any

|

number

|

number[]

The particular phone ID to filter

phoneNumber

Copy URL
phoneNumber: 

string

|

string[]

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

phoneRegionName

Copy URL
phoneRegionName: 

string

|

string[]

The region names list separated by semicolons (;)

phoneTemplate

Copy URL
phoneTemplate: 

string

|

undefined

The phone number start to filter

ruleId

Copy URL
ruleId: 

any

|

number

|

number[]

The rule ID list separated by semicolons (;)

ruleName

Copy URL
ruleName: 

string

|

string[]

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

sandbox

Copy URL
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

Copy URL
smsSupported: 

false

|

undefined

|

true

toPhoneNextRenewal

Copy URL
toPhoneNextRenewal: 

Date

The UTC 'to' date filter in format: YYYY-MM-DD

toPhonePurchaseDate

Copy URL
toPhonePurchaseDate: 

Date

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

toUnverifiedHoldUntil

Copy URL
toUnverifiedHoldUntil: 

Date

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

verificationName

Copy URL
verificationName: 

string

|

undefined

The required account verification name to filter

verificationStatus

Copy URL
verificationStatus: 

string

|

string[]

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