1. References
  2. HTTP API
  3. Structure
  4. AttachedPhoneInfoType
Rate this page:

AttachedPhoneInfoType

The GetPhoneNumbers function result item.

Fields

phone_id

Copy URL
phone_id: 
number

The phone ID.

phone_number

Copy URL
phone_number: 
string

The phone number.

phone_price

Copy URL
phone_price: 
decimal

The phone monthly charge.

phone_country_code

Copy URL
phone_country_code: 
string

The phone country code (2 symbols).

phone_next_renewal

Copy URL
phone_next_renewal: 
date

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

phone_purchase_date

Copy URL
phone_purchase_date: 
timestamp

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

deactivated

Copy URL
deactivated: 
boolean

The flag of the frozen subscription.

canceled

Copy URL
canceled: 
boolean

The flag of the deleted subscription.

auto_charge

Copy URL
auto_charge: 
boolean

The auto_charge flag.

application_id

Copy URL
application_id: 
number

The id of the bound application.

application_name

Copy URL
application_name: 
string

The name of the bound application.

rule_id

Copy URL
rule_id: 
number

The id of the bound rule.

rule_name

Copy URL
rule_name: 
string

The name of the bound rule.

category_name

Copy URL
category_name: 
string

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

required_verification

Copy URL
required_verification: 
string

The required account verification name.

verification_status

Copy URL
verification_status: 
string

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

unverified_hold_until

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 will be detached on that day automatically!

can_be_used

Copy URL
can_be_used: 
boolean

Unverified account can use the phone.

is_sms_supported

Copy URL
is_sms_supported: 
boolean

If true, 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 using the SendSmsMessage Management API and received using the InboundSmsCallback property of the HTTP callback. See this article for HTTP callback details.

is_sms_enabled

Copy URL
is_sms_enabled: 
boolean

If true, SMS sending and receiving is enabled for this phone number via the ControlSms Management API.

incoming_sms_callback_url

Copy URL
incoming_sms_callback_url: 
string

If set, the callback of an inbound SMS will be sent to this url, otherwise, it will be sent to the general account URL.