AttachedPhoneInfo
Props
applicationId
applicationId: number
| undefined
The id of the bound application
applicationName
applicationName: string
| undefined
The name of the bound application
autoCharge
autoCharge: boolean
Whether to charge automatically
canBeUsed
canBeUsed: boolean
Whether a not verified account can use the phone
canceled
canceled: boolean
Whether the subscription is cancelled
categoryName
categoryName: string
The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)
deactivated
deactivated: boolean
Whether the subscription is frozen
emergencyCallsEnabled
emergencyCallsEnabled: boolean
Whether calls to emergency numbers are enabled
emergencyCallsToBeEnabled
emergencyCallsToBeEnabled: boolean
Whether you need to make a request to enable calls to emergency numbers
extendedApplicationName
extendedApplicationName: string
| undefined
Full application name, e.g. myapp.myaccount.n1.voximplant.com
incomingSmsCallbackUrl
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
isSmsEnabled: boolean
Whether SMS sending and receiving is enabled for this phone number via the Management API
isSmsSupported
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
modified: Date
UTC date of an event associated with the number in 24-h format: YYYY-MM-DD HH:mm:ss
phoneCountryCode
phoneCountryCode: string
The phone country code (2 symbols)
phoneId
phoneId: number
The phone ID
phoneNextRenewal
phoneNextRenewal: Date
The next renewal date in format: YYYY-MM-DD
phoneNumber
phoneNumber: string
The phone number
phonePrice
phonePrice: number
The phone monthly charge
phonePurchaseDate
phonePurchaseDate: Date
The purchase date in 24-h format: YYYY-MM-DD HH:mm:ss
phoneRegionName
phoneRegionName: string
| undefined
Phone region name
requiredVerification
requiredVerification: false
| undefined
| true
Whether the verification is required for the account
ruleId
ruleId: number
| undefined
The id of the bound rule
ruleName
ruleName: string
| undefined
The name of the bound rule
subscriptionId
subscriptionId: number
Phone number subscription ID
unverifiedHoldUntil
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
verificationStatus: string
| undefined
The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED