Package com.ringcentral.definitions

Class SipRegistrationDeviceInfo

java.lang.Object

com.ringcentral.definitions.SipRegistrationDeviceInfo

public class SipRegistrationDeviceInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Long	boxBillingId	Box billing identifier of a device.
String	computerName	Computer name (for devices of `SoftPhone` type only)
SipRegistrationDeviceEmergencyInfo	emergency
DeviceEmergencyServiceAddressResourceDefault	emergencyServiceAddress
DeviceExtensionInfo	extension
String	id	Internal identifier of a device
Boolean	inCompanyNet	Network location status.
String	lastLocationReportTime	Timestamp of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z Format: date-time
String	linePooling	Pooling type of device: - `Host` - device with 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 specific line (free, BLA, etc.) Enum: Host, Guest, None
DeviceModelInfo	model
String	name	Device name.
DevicePhoneLinesInfo[]	phoneLines	Phone lines information
String	serial	Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for Softphone and mobile applications
ShippingInfo	shipping
DeviceSiteInfo	site
String	sku	Device 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).
String	status	Enum: Online, Offline
String	type	Device type Enum: HardPhone, SoftPhone, OtherPhone, Paging, WebPhone, Room
String	uri	Canonical URI of the resource Format: uri
Boolean	useAsCommonPhone	Supported only for devices assigned to Limited extensions.

Constructor Summary

Constructors

Constructor	Description
SipRegistrationDeviceInfo()

Method Summary

Modifier and Type	Method	Description
SipRegistrationDeviceInfo	boxBillingId(Long boxBillingId)
SipRegistrationDeviceInfo	computerName(String computerName)
SipRegistrationDeviceInfo	emergency(SipRegistrationDeviceEmergencyInfo emergency)
SipRegistrationDeviceInfo	emergencyServiceAddress(DeviceEmergencyServiceAddressResourceDefault emergencyServiceAddress)
SipRegistrationDeviceInfo	extension(DeviceExtensionInfo extension)
SipRegistrationDeviceInfo	id(String id)
SipRegistrationDeviceInfo	inCompanyNet(Boolean inCompanyNet)
SipRegistrationDeviceInfo	lastLocationReportTime(String lastLocationReportTime)
SipRegistrationDeviceInfo	linePooling(String linePooling)
SipRegistrationDeviceInfo	model(DeviceModelInfo model)
SipRegistrationDeviceInfo	name(String name)
SipRegistrationDeviceInfo	phoneLines(DevicePhoneLinesInfo[] phoneLines)
SipRegistrationDeviceInfo	serial(String serial)
SipRegistrationDeviceInfo	shipping(ShippingInfo shipping)
SipRegistrationDeviceInfo	site(DeviceSiteInfo site)
SipRegistrationDeviceInfo	sku(String sku)
SipRegistrationDeviceInfo	status(String status)
SipRegistrationDeviceInfo	type(String type)
SipRegistrationDeviceInfo	uri(String uri)
SipRegistrationDeviceInfo	useAsCommonPhone(Boolean useAsCommonPhone)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uri

public String uri

Canonical URI of the resource Format: uri

id

public String id

Internal identifier of a device

type

public String type

Device type Enum: HardPhone, SoftPhone, OtherPhone, Paging, WebPhone, Room

sku

public String sku

Device 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'

status

public String status

Enum: Online, Offline

name

public String name

Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name

serial

public String serial

Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for Softphone and mobile applications

computerName

public String computerName

Computer name (for devices of `SoftPhone` type only)

model

public DeviceModelInfo model

extension

public DeviceExtensionInfo extension

emergencyServiceAddress

public DeviceEmergencyServiceAddressResourceDefault emergencyServiceAddress

emergency

public SipRegistrationDeviceEmergencyInfo emergency

shipping

public ShippingInfo shipping

phoneLines

public DevicePhoneLinesInfo[] phoneLines

Phone lines information

boxBillingId

public Long boxBillingId

Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified forT?HardPhone Format: int64

useAsCommonPhone

public Boolean useAsCommonPhone

Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone.

linePooling

public String linePooling

Pooling type of device: - `Host` - device with 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 specific line (free, BLA, etc.) Enum: Host, Guest, None

inCompanyNet

public Boolean inCompanyNet

Network 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

site

public DeviceSiteInfo site

lastLocationReportTime

public String lastLocationReportTime

Timestamp of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z Format: date-time

Constructor Details

SipRegistrationDeviceInfo

public SipRegistrationDeviceInfo()

Method Details

uri

public SipRegistrationDeviceInfo uri(String uri)

id

public SipRegistrationDeviceInfo id(String id)

type

public SipRegistrationDeviceInfo type(String type)

sku

public SipRegistrationDeviceInfo sku(String sku)

status

public SipRegistrationDeviceInfo status(String status)

name

public SipRegistrationDeviceInfo name(String name)

serial

public SipRegistrationDeviceInfo serial(String serial)

computerName

public SipRegistrationDeviceInfo computerName(String computerName)

model

public SipRegistrationDeviceInfo model(DeviceModelInfo model)

extension

public SipRegistrationDeviceInfo extension(DeviceExtensionInfo extension)

emergencyServiceAddress

public SipRegistrationDeviceInfo emergencyServiceAddress(DeviceEmergencyServiceAddressResourceDefault emergencyServiceAddress)

emergency

public SipRegistrationDeviceInfo emergency(SipRegistrationDeviceEmergencyInfo emergency)

shipping

public SipRegistrationDeviceInfo shipping(ShippingInfo shipping)

phoneLines

public SipRegistrationDeviceInfo phoneLines(DevicePhoneLinesInfo[] phoneLines)

boxBillingId

public SipRegistrationDeviceInfo boxBillingId(Long boxBillingId)

useAsCommonPhone

public SipRegistrationDeviceInfo useAsCommonPhone(Boolean useAsCommonPhone)

linePooling

public SipRegistrationDeviceInfo linePooling(String linePooling)

inCompanyNet

public SipRegistrationDeviceInfo inCompanyNet(Boolean inCompanyNet)

site

public SipRegistrationDeviceInfo site(DeviceSiteInfo site)

lastLocationReportTime

public SipRegistrationDeviceInfo lastLocationReportTime(String lastLocationReportTime)