Device Call Settings - Search Members

Search Members

Search members that can be assigned to the device.

A device member can be either a person or a workspace. A admin can access the list of member details, modify member details and search for available members on a device.

This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/devices/{deviceId}/availableMembers

URI Parameters

deviceId

stringrequired

Unique identifier for the device.

Query Parameters

orgId

string

Retrieves the list of available members on the device in this organization.

start

number

Specifies the offset from the first result that you want to fetch.

Default: 0

max

number

Specifies the maximum number of records that you want to fetch.

Default: 2000

memberName

string

Search (Contains) numbers based on member name.

phoneNumber

string

Search (Contains) based on number.

locationId

stringrequired

Unique identifier for the location.

extension

string

Search (Contains) based on extension.

usageType

string

Search for members eligible to become the owner of the device, or share line on the device.

Possible values: DEVICE_OWNER, SHARED_LINE

order

string

Sort the list of available members on the device in ascending order by name, use either last name lname or first name fname. Default: last name in ascending order.

Response Properties

members

array[SearchMemberObject]

List of members available for the device.

string

Unique identifier for the member.

firstName

string

First name of a person or workspace.

lastName

string

Last name of a person or workspace.

phoneNumber

string

Phone Number of a person or workspace.

t38FaxCompressionEnabled

boolean

T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options.

lineType

LineType

Line type is used to differentiate Primary and SCA, at which endpoint it is assigned.

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.

allowCallDeclineEnabled

boolean

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.

memberType

MemberType

Indicates if member is of type PEOPLE or PLACE.

PEOPLE

string

Indicates the associated member is a person.

PLACE

string

Indicates the associated member is a workspace.

VIRTUAL_LINE

string

Indicates the associated member is a virtual line.

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/devices//availableMembers{?orgId,start,max,memberName,phoneNumber,locationId,extension,usageType,order}

Header

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

Query Parameters

orgId
string
Retrieves the list of available members on the device in this organization.
start
number
Specifies the offset from the first result that you want to fetch.
max
number
Specifies the maximum number of records that you want to fetch.
memberName
string
Search (Contains) numbers based on member name.
phoneNumber
string
Search (Contains) based on number.
locationId
stringRequired
Unique identifier for the location.
extension
string
Search (Contains) based on extension.
usageType
string
Search for members eligible to become the owner of the device, or share line on the device.
order
string
Sort the list of available members on the device in ascending order by name, use either last name `lname` or first name `fname`. Default: last name in ascending order.

https://webexapis.com/v1/telephony/config/devices/Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=/availableMembers?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&start=0&max=100&memberName=John&phoneNumber=9828282867&locationId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&extension=1234&usageType=%5Bobject%20Object%5D,%5Bobject%20Object%5D&order=lname

200 / OK

{
    "members": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
            "firstName": "John",
            "lastName": "Smith",
            "phoneNumber": "+12055552221",
            "t38FaxCompressionEnabled": false,
            "lineType": "SHARED_CALL_APPEARANCE",
            "allowCallDeclineEnabled": true,
            "memberType": "PEOPLE",
            "location": {
                "name": "MainOffice",
                "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw"
            }
        },
        {

            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
            "firstName": "Bob",
            "lastName": "Smith-ws",
            "phoneNumber": "+12055552221",
            "t38FaxCompressionEnabled": false,
            "lineType": "SHARED_CALL_APPEARANCE",
            "allowCallDeclineEnabled": true,
            "memberType": "PLACE",
            "location": {
                "name": "MainOffice",
                "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw"
            }
        }
    ]
}