User Call Settings - Search Shared-Line Appearance Members

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.

GET/v1/telephony/config/people/{personId}/applications/{applicationId}/availableMembers

URI Parameters

personId

stringrequired

A unique identifier for the person.

applicationId

stringrequired

A unique identifier for the application.

Body Parameters

max

number

Number of records per page.

start

number

Page number.

location

string

Location ID for the user.

name

string

Search for users with names that match the query.

number

string

Search for users with numbers that match the query.

order

string

Sort by first name (fname) or last name (lname).

extension

string

Search for users with extensions that match the query.

Response Properties

members

array[Available Shared Line Member Item]

string

A unique member identifier.

firstName

string

First name of member.

lastName

string

Last name of member.

phoneNumber

string

Phone number of member. Currently, E.164 format is not supported.

extension

string

Phone extension of member.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

lineType

LineType

Indicates if the line is acting as a primary line or a shared line for this device.

PRIMARY

string

Primary line for the member.

SHARED_CALL_APPEARANCE

string

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

Location object having a unique identifier for the location and its name.

string

Location identifier associated with the members.

name

string

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.

GET

/v1/telephony/config/people//applications//availableMembers

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

max
number
Number of records per page.
start
number
Page number.
location
string
Location ID for the user.
name
string
Search for users with names that match the query.
number
string
Search for users with numbers that match the query.
order
string
Sort by first name (`fname`) or last name (`lname`).
extension
string
Search for users with extensions that match the query.

https://webexapis.com/v1/telephony/config/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ/applications/2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA/availableMembers

{
  "max": null,
  "start": null,
  "location": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
  "name": "john",
  "number": "1234567890",
  "order": "fname",
  "extension": "1111"
}

200 / OK

{
  "members": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "1234567890",
      "extension": "0000",
      "routingPrefix": "1234",
      "esn": "12340000",
      "lineType": "SHARED_CALL_APPEARANCE",
      "location": {
        "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw",
        "name": "MainOffice"
      }
    }
  ]
}