Get Device Members
Get the list of all the members of the device including primary and secondary users.
A device member can be either a person or a workspace. An admin can access the list of member details, modify member details and search for available members on a device.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Unique identifier for the device.
Query Parameters
Retrieves the list of all members of the device in this organization.
Response Properties
Model type of the device.
List of members that appear on the device.
Unique identifier for the member.
First name of a person or workspace.
Last name of a person or workspace.
Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update.
Extension of a person or workspace.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device.
Port number assigned to person or workspace.
T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options.
Line type is used to differentiate Primary and SCA, at which endpoint it is 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.
Number of lines that have been configured for the person on the device.
Registration Host IP address for the line port.
Registration Remote IP address for the line port.
Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination.
The preconfigured number for Hotline. Required only if hotlineEnabled is set to true.
Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint.
Device line label.
SIP username used in SIP signaling, for example, in registration.
Indicates if the member is of type PEOPLE or PLACE.
Indicates the associated member is a person.
Indicates the associated member is a workspace.
Indicates the associated member is a virtual line.
Location object having a unique identifier for the location and its name.
Location identifier associated with the members.
Location name associated with the member.
Maximum number of lines available for the device.
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
- Retrieves the list of all members of the device in this organization.
{
"model": "DMS Cisco 192",
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"firstName": "John",
"lastName": "Smith",
"phoneNumber": "2055552221",
"extension": "000",
"routingPrefix": "1234",
"esn": "1234000",
"primaryOwner": true,
"port": 1,
"t38FaxCompressionEnabled": false,
"lineType": "SHARED_CALL_APPEARANCE",
"lineWeight": 1,
"hostIP": "10.0.0.45",
"remoteIP": "192.102.12.84",
"hotlineEnabled": true,
"hotlineDestination": "+12055552222",
"allowCallDeclineEnabled": true,
"lineLabel": "share line label",
"linePort": "evypzco5ds@55552222.int10.bcld.webex.com",
"memberType": "PEOPLE",
"location": {
"name": "MainOffice",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw"
}
}
],
"maxLineCount": 2
}