Get List of Handsets for a DECT Network ID
List all the handsets associated with a DECT Network ID.
A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.
This API requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Location containing the DECT network.
Search handset details in the specified DECT network ID.
Query Parameters
Organization containing the DECT network.
Search handset details in the specified DECT base station ID.
ID of the member of the handset. Members can be of type PEOPLE, PLACE, or VIRTUAL_LINE.
Response Properties
Number of handsets associated.
Total number of lines assigned.
Array of DECTHandsetItem objects, each representing a handset with its associated details and lines.
Unique identifier of the handset.
Index of the handset.
Default display name for the handset.
Custom display name on the handset.
Access code is used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected.
Flags the handset as a primary line if true.
Array of lines associated to the handset up to a maximum of 2.
ID of the member on line1 of the handset. Members can be PEOPLE or PLACE.
Line members's first name.
Line members's last name.
Line members primary number.
Line members extension.
Last registration timestamp.
Registration host IP address for the line port.
Registration remote IP address for the line port.
Location object including a unique identifier for the location and its name.
Location identifier associated with the member.
Location name associated with the member.
Indicates member type.
Indicates the associated member is a person.
Indicates the associated member is a workspace.
Indicates the associated member is a virtual profile.
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
- Organization containing the DECT network.
- Search handset details in the specified DECT base station ID.
- ID of the member of the handset. Members can be of type PEOPLE, PLACE, or VIRTUAL_LINE.
{
"numberOfHandsetsAssigned":1,
"numberOfLinesAssigned":1,
"handsets": [
{
"id": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz",
"index": "1",
"defaultDisplayName": "Demo_Handset",
"customDisplayName": "Demo_Handset",
"accessCode": "4788",
"primaryEnabled": "",
"lines": [
{
"memberId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"firstName": "John",
"lastName": "Smith",
"external": "+14088571272",
"extension": "3459",
"routingPrefix": "17636",
"esn": "176363459",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"name": "MainOffice"
},
"memberType": "PEOPLE"
}
]
}
]
}