Get List of Devices assigned for a Virtual Line
Retrieve Device details assigned for a virtual line.
Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.
Retrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a virtual line with the matching ID.
Query Parameters
Retrieve virtual line settings from this organization.
Response Properties
List of devices assigned to a virtual line.
Unique identifier for a device.
Comma separated array of tags used to describe device.
Identifier for device model.
MAC address of device.
Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device.
Indicates if the line is acting as a primary line or a shared line for this device.
Primary line for the member.
Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.
Owner of the device.
Unique identifier of a person or a workspace.
Enumeration that indicates if the member is of type PEOPLE or PLACE.
Indicates the associated member is a person.
Indicates the associated member is a workspace.
First name of device owner.
Last name of device owner.
Activation state of a device.
Indicates a device is activating.
Indicates a device is activated.
Indicates a device is deactivated.
Location details of virtual line.
ID of location associated with virtual line.
Name of location associated with virtual line.
Indicates to which line a device can be assigned.
Primary line for the member.
Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.
Maximum number of devices a virtual line can be assigned to.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Retrieve virtual line settings from this organization.
{
"devices": [
{
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=",
"description": [
],
"model": "DMS Cisco 6871",
"mac": "123451234502",
"primaryOwner": false,
"owner": {
"id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"lastName": "Christian",
"firstName": "Smith",
"type": "PEOPLE"
},
"activationState": "ACTIVATED",
"type": "PRIMARY",
"location": {
"name": "Main Location Test",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx"
}
}
],
"availableEndpointType": "SHARED_CALL_APPEARANCE",
"maxDeviceCount": 35
}