ALalianza
Account Device Line

Retrieve device provisioning data

Use to retrieve a device's provisioning data by device.id. Device.id actually identifies an Account Device Line, while the data returned by this call is best thought of as being one level higher, a list of related lines which will include the line searched by. (if present)

This is the canonical way to request the SIP credentials of a device line, but it requires extra work on your part; you will have to dig down into the lines array and search it by line.lineNumber == device.lineNumber.

get/v2/partition/{partitionId}/deviceprovisioning/account/{accountId}/device/{deviceId}

Request

Path parameters

accountIdstring required

ID of account, reference to <a href="#/~schema/Account">account.id</a>

deviceIdstring required

DeviceId, reference to <a href="#/~schema/DeviceX">device.id</a>

partitionIdstring required

ID of partition, reference to <a href="#/~schema/Account">account.partitionId</a>

Response

Successful operation

macAddressstring
deviceTypestring

Reference to <a href="#/~schema/DeviceX">device.deviceTypeId</a> -> <a href="#/~schema/DeviceTypeX">deviceType.id</a> -> <a href="#/~schema/DeviceTypeX">deviceType.name</a>. For possible values, query <a href="#/~operation/Reference%20Resources/getDeviceTypes">getDevicetypes</a>.

lineCountinteger
dialPlanstring

This is a dial plan string which instructs a phone when to consider dialing "complete"; in other words, when the phone should send the digits to the switch. For example, it usually instructs a device to immediately send 911, and can also help the phone determine that an extension is being dialed, so it should send after the extension length has been reached. These rules are encoded in a language of sorts and are only really understood by the phone itself.

hasFaxEnabledLineboolean

Changes

No recorded changes to this operation across all 1 revision of this API.