Rate this page:

AttachedPhoneInfo

Props

applicationId

Copy URL
applicationId: 

number

|

undefined

The id of the bound application

applicationName

Copy URL
applicationName: 

string

|

undefined

The name of the bound application

autoCharge

Copy URL
autoCharge: 

boolean

Whether to charge automatically

canBeUsed

Copy URL
canBeUsed: 

boolean

Whether a not verified account can use the phone

canceled

Copy URL
canceled: 

boolean

Whether the subscription is cancelled

categoryName

Copy URL
categoryName: 

string

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

deactivated

Copy URL
deactivated: 

boolean

Whether the subscription is frozen

emergencyCallsEnabled

Copy URL
emergencyCallsEnabled: 

boolean

Whether calls to emergency numbers are enabled

emergencyCallsToBeEnabled

Copy URL
emergencyCallsToBeEnabled: 

boolean

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

extendedApplicationName

Copy URL
extendedApplicationName: 

string

|

undefined

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

incomingSmsCallbackUrl

Copy URL
incomingSmsCallbackUrl: 

string

|

undefined

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

isSmsEnabled

Copy URL
isSmsEnabled: 

boolean

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

isSmsSupported

Copy URL
isSmsSupported: 

boolean

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

modified

Copy URL
modified: 

Date

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

phoneCountryCode

Copy URL
phoneCountryCode: 

string

The phone country code (2 symbols)

phoneId

Copy URL
phoneId: 

number

The phone ID

phoneNextRenewal

Copy URL
phoneNextRenewal: 

Date

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

phoneNumber

Copy URL
phoneNumber: 

string

The phone number

phonePrice

Copy URL
phonePrice: 

number

The phone monthly charge

phonePurchaseDate

Copy URL
phonePurchaseDate: 

Date

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

phoneRegionName

Copy URL
phoneRegionName: 

string

|

undefined

Phone region name

requiredVerification

Copy URL
requiredVerification: 

false

|

undefined

|

true

Whether the verification is required for the account

ruleId

Copy URL
ruleId: 

number

|

undefined

The id of the bound rule

ruleName

Copy URL
ruleName: 

string

|

undefined

The name of the bound rule

subscriptionId

Copy URL
subscriptionId: 

number

Phone number subscription ID

unverifiedHoldUntil

Copy URL
unverifiedHoldUntil: 

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!

verificationStatus

Copy URL
verificationStatus: 

string

|

undefined

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