Skip to main content

SipRegistrationDeviceInfo

Properties

NameTypeRequiredDescription
uristrCanonical URI of the resource
id_strInternal identifier of a device
type_SipRegistrationDeviceInfoTypeDevice type
skustrDevice identification number (SKU, Stock Keeping Unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC desk phones, DV for all other devices including soft phones); ID - device model ID; AT - add-on type ID; AC - add-on count (if any). For example 'HP-56-2-2'
statusSipRegistrationDeviceInfoStatus
namestrDevice name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name
serialstrSerial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for Softphone and mobile applications
computer_namestrComputer name (for devices of SoftPhone type only)
modelDeviceModelInfoHardPhone model information
extensionDeviceExtensionInfo
emergency_service_addressDeviceEmergencyServiceAddressResourceDefaultAddress for emergency cases. The same emergency address is assigned to all the numbers of one device
emergencySipRegistrationDeviceEmergencyInfoEmergency response location settings of a device
shippingShippingInfoShipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer
phone_linesList[DevicePhoneLinesInfo]Phone lines information
box_billing_idintBox billing identifier of a device. Applicable only for devices of HardPhone type.
use_as_common_phoneboolSupported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone.
line_poolingLinePoolingEnumPooling type of device: - Host - device with a standalone paid phone line which can be linked to soft phone client instance; - Guest - device with a linked phone line; - None - device without a phone line or with a specific line (free, BLA, etc.)
in_company_netboolNetwork location status. true if the device is located in the configured corporate network (On-Net); false for Off-Net location. Parameter is not returned if EmergencyAddressAutoUpdate feature is not enabled for the account/user, or if device network location is not determined
siteDeviceSiteInfoSite data
last_location_report_timestrTimestamp of receiving last location report in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z

SipRegistrationDeviceInfoType

Device type

Properties

NameTypeRequiredDescription
HARDPHONEstr"HardPhone"
SOFTPHONEstr"SoftPhone"
OTHERPHONEstr"OtherPhone"
PAGINGstr"Paging"
WEBPHONEstr"WebPhone"
ROOMstr"Room"

SipRegistrationDeviceInfoStatus

Properties

NameTypeRequiredDescription
ONLINEstr"Online"
OFFLINEstr"Offline"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →