User Call Settings - Read Receptionist Client Settings for a Person

Read Receptionist Client Settings for a Person

Retrieve a person's Receptionist Client settings.

To help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.

This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read.

GET/v1/people/{personId}/features/reception

URI Parameters

personId

stringrequired

Unique identifier for the person.

Query Parameters

orgId

string

ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Response Properties

receptionEnabled

boolean

Set to true to enable the Receptionist Client feature.

monitoredMembers

array[MonitoredMemberObject]

List of people, workspaces or virtual lines to monitor.

string

Unique identifier of the person, workspace or virtual line to be monitored.

lastName

string

Last name of the monitored person, workspace or virtual line.

firstName

string

First name of the monitored person, workspace or virtual line.

displayName

string

Display name of the monitored person, workspace or virtual line.

type

PeopleOrPlaceOrVirtualLineType

Indicates whether type is person, workspace or virtual line.

PEOPLE

string

Indicates a person or list of people.

PLACE

string

Indicates a workspace that is not assigned to a specific person such as for a shared device in a common area.

VIRTUAL_LINE

string

Indicates a virtual line or list of virtual lines.

string

Email address of the monitored person, workspace or virtual line.

numbers

array[MonitoredNumberObject]

List of phone numbers of the monitored person, workspace or virtual line.

external

string

External phone number of the monitored person, workspace or virtual line.

extension

string

Extension number of the monitored person, workspace or virtual line.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

primary

boolean

Indicates whether phone number is a primary number.

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/people//features/reception{?orgId}

Header

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

Query Parameters

orgId
string
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/reception?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "receptionEnabled": true,
    "monitoredMembers": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE",
            "lastName": "Little",
            "firstName": "Alice",
            "displayName": "Alice Little",
            "type": "PEOPLE",
            "email": "alice@example.com",
              "location": {
                     "name": "Paragville",
                     "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhjOWZkMjg1LTY1MDAtNDUxOC04NTZlLWViODM2YzY3NjFkOA"
              },
            "numbers": [
                {
                    "external": "+19845551088",
                    "extension": "1088",
                    "routingPrefix": "1234",
                    "esn": "12341088",
                    "primary": true
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE",
            "lastName": "Johnson",
            "firstName": "Bob",
            "displayName": "Bob Johnson",
            "type": "PEOPLE",
            "email": "bob@example.com",
            "numbers": [
                {
                    "external": "+198455501099",
                    "extension": "1099",
                    "routingPrefix": "1234",
                    "esn": "12341099",
                    "primary": true
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg",
            "lastName": "Alice",
            "firstName": "Smith",
            "displayName": "AliceSmith",
            "type": "VIRTUAL_LINE",
            "numbers": [
                {
                    "external": "+19075552859",
                    "extension":"8083",
                    "routingPrefix": "1234",
                    "esn": "12348083",
                    "primary": "true"
                }
            ]
        }
    ]
}