Rate this page:

AttachedPhoneInfoType

The GetPhoneNumbers function result.

Fields

application_id

Optional
Copy URL
application_id: 

number

The id of the bound application

application_name

Optional
Copy URL
application_name: 

string

The name of the bound application

auto_charge

Copy URL
auto_charge: 

boolean

Whether to charge automatically

can_be_used

Copy URL
can_be_used: 

boolean

Whether a not verified account can use the phone

canceled

Copy URL
canceled: 

boolean

Whether the subscription is cancelled

category_name

Copy URL
category_name: 

string

The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)

deactivated

Copy URL
deactivated: 

boolean

Whether the subscription is frozen

emergency_calls_enabled

Copy URL
emergency_calls_enabled: 

boolean

Whether calls to emergency numbers are enabled

emergency_calls_to_be_enabled

Copy URL
emergency_calls_to_be_enabled: 

boolean

Whether you need to make a request to enable calls to emergency numbers

extended_application_name

Optional
Copy URL
extended_application_name: 

string

Full application name, e.g. myapp.myaccount.n1.voximplant.com

incoming_sms_callback_url

Optional
Copy URL
incoming_sms_callback_url: 

string

If set, the callback of an incoming SMS is sent to this url, otherwise, it is sent to the general account URL

is_sms_enabled

Copy URL
is_sms_enabled: 

boolean

Whether SMS sending and receiving is enabled for this phone number via the ControlSms Management API

is_sms_supported

Copy URL
is_sms_supported: 

boolean

Whether SMS is supported for this phone number. SMS needs to be explicitly enabled via the ControlSms Management API before sending or receiving SMS. If SMS is supported and enabled, SMS can be sent from this phone number via the SendSmsMessage Management API and received via the InboundSmsCallback property of the HTTP callback. See this article for HTTP callback details

modified

Copy URL
modified: 

timestamp

UTC date of an event associated with the number in 24-h format: YYYY-MM-DD HH:mm:ss

phone_country_code

Copy URL
phone_country_code: 

string

The phone country code (2 symbols)

phone_id

Copy URL
phone_id: 

number

The phone ID

phone_next_renewal

Copy URL
phone_next_renewal: 

date

The next renewal date in format: YYYY-MM-DD

phone_number

Copy URL
phone_number: 

string

The phone number

phone_price

Copy URL
phone_price: 

decimal

The phone monthly charge

phone_purchase_date

Copy URL
phone_purchase_date: 

timestamp

The purchase date in 24-h format: YYYY-MM-DD HH:mm:ss

phone_region_name

Optional
Copy URL
phone_region_name: 

string

Phone region name

required_verification

Optional
Copy URL
required_verification: 

boolean

Whether the verification is required for the account

rule_id

Optional
Copy URL
rule_id: 

number

The id of the bound rule

rule_name

Optional
Copy URL
rule_name: 

string

The name of the bound rule

subscription_id

Copy URL
subscription_id: 

number

Phone number subscription ID

unverified_hold_until

Optional
Copy URL
unverified_hold_until: 

date

Unverified phone hold until the date in format: YYYY-MM-DD (if the account verification is required). The number is detached on that day automatically!

verification_status

Optional
Copy URL
verification_status: 

string

The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED