Search Shared-Line Appearance Members
Get members available for shared-line assignment to a Webex Calling Apps Desktop device.
This API requires a full or user administrator or location administrator auth token with the spark-admin:people_read
scope.
URI Parameters
A unique identifier for the person.
A unique identifier for the application.
Body Parameters
Number of records per page.
Page number.
Location ID for the user.
Search for users with names that match the query.
Search for users with numbers that match the query.
Sort by first name (fname
) or last name (lname
).
Search for users with extensions that match the query.
Response Properties
A unique member identifier.
First name of member.
Last name of member.
Phone number of member. Currently, E.164 format is not supported.
Phone extension of member.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
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.
Location object having a unique identifier for the location and its name.
Location identifier associated with the members.
Location name associated with the member.
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
Body
- maxnumberNumber of records per page.
- startnumberPage number.
- locationstringLocation ID for the user.
- namestringSearch for users with names that match the query.
- numberstringSearch for users with numbers that match the query.
- orderstringSort by first name (`fname`) or last name (`lname`).
- extensionstringSearch for users with extensions that match the query.
{ "max": null, "start": null, "location": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "name": "john", "number": "1234567890", "order": "fname", "extension": "1111" }
{ "members": [ { "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE", "firstName": "John", "lastName": "Doe", "phoneNumber": "1234567890", "extension": "0000", "routingPrefix": "1234", "esn": "12340000", "lineType": "SHARED_CALL_APPEARANCE", "location": { "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw", "name": "MainOffice" } } ] }