Features: Call Queue - GET Supervisor Detail with Customer Experience Essentials

GET Supervisor Detail with Customer Experience Essentials

Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

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

GET/v1/telephony/config/supervisors/{supervisorId}

URI Parameters

supervisorId

stringrequired

List the agents assigned to this supervisor.

Query Parameters

orgId

string

List the agents assigned to a supervisor in this organization.

max

number

Limit the number of objects returned to this maximum count.

start

number

Start at the zero-based offset in the list of matching objects.

name

string

Only return the agents that match the given name.

phoneNumber

string

Only return agents that match the given phone number, extension, or ESN.

order

string

Sort results alphabetically by supervisor name, in ascending or descending order.

hasCxEssentials

boolean

Must be set to true, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to false.

Response Properties

string

unique identifier of the supervisor

agents

array[ListSupervisorAgentObject]

Array of agents assigned to a specific supervisor.

string

ID of person, workspace or virtual line.

lastName

string

Last name of the agent.

firstName

string

First name of the agent.

extension

string

Primary phone extension of the agent.

esn

string

Routing prefix + extension of a agent.

phoneNumber

string

Primary phone number of the agent.

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/supervisors/{?orgId,max,start,name,phoneNumber,order,hasCxEssentials}

Header

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

Query Parameters

orgId
string
List the agents assigned to a supervisor in this organization.
max
number
Limit the number of objects returned to this maximum count.
start
number
Start at the zero-based offset in the list of matching objects.
name
string
Only return the agents that match the given name.
phoneNumber
string
Only return agents that match the given phone number, extension, or ESN.
order
string
Sort results alphabetically by supervisor name, in ascending or descending order.
hasCxEssentials
boolean
Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.

https://webexapis.com/v1/telephony/config/supervisors/Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=5&start=0&name=John&phoneNumber=+19845550186&order=firstName%5ClastName%5CfirstName-desc%5ClastName-desc&hasCxEssentials=true

200 / OK

{
    "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JlNTgxNi01YTIyLTQ5MzgtOWNmMy0wODIwODhiNDkxOGU",
    "agents": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNzViMGE4Mi1jNzM5LTRlMDktYWQ5NC0zNTc2YTBlMjYwZDA",
            "lastName": ".",
            "firstName": "Barn61",
            "extension": "1060",
            "esn": "1060"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY",
            "lastName": "user",
            "firstName": "test",
            "extension": "892827",
            "esn": "892827"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iZjE5YWQzMC00NzAyLTQ3NWMtOTg0Ni1lM2M0M2Y1NGFlYzk",
            "lastName": ".",
            "firstName": "Test9",
            "routingPrefix": "34543",
            "phoneNumber": "+19729989982"
        }
    ]
}