Rate this page:

GetPhoneNumbersRequest

Props

applicationId

Copy URL

The application ID

applicationName

Copy URL

The application name that can be used instead of application_id

autoCharge

Copy URL

Whether the auto_charge flag is enabled

canBeUsed

Copy URL

Whether a not verified account can use the phone

canceled

Copy URL

Whether the subscription is cancelled to filter

childAccountId

Copy URL

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

childrenPhonesOnly

Copy URL

Whether to get the children phones only

count

Copy URL

The max returning record count

countryCode

Copy URL

The country code list separated by semicolons (;)

deactivated

Copy URL

Whether the subscription is frozen to filter

fromPhoneNextRenewal

Copy URL

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

fromPhonePurchaseDate

Copy URL

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

fromUnverifiedHoldUntil

Copy URL

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

isBoundToApplication

Copy URL

Whether the phone number bound to an application

isBoundToRule

Copy URL

Whether the phone number is bound to some rule

offset

Copy URL

The first N records are skipped in the output

orderBy

Copy URL

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

The phone category name. See the method

phoneId

Copy URL

The particular phone ID to filter

phoneNumber

Copy URL

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

phoneRegionName

Copy URL

The region names list separated by semicolons (;)

phoneTemplate

Copy URL

The phone number start to filter

ruleId

Copy URL

The rule ID list separated by semicolons (;)

ruleName

Copy URL

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

sandbox

Copy URL

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

toPhoneNextRenewal

Copy URL

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

toPhonePurchaseDate

Copy URL

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

toUnverifiedHoldUntil

Copy URL

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

verificationName

Copy URL

The required account verification name to filter

verificationStatus

Copy URL

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