Create a Supervisor with Customer Experience Essentials
Create a new supervisor. The supervisor must be created with at least one agent.
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 or location administrator auth token with a scope of spark-admin:telephony_config_write.
Query Parameters
The organization ID where the supervisor needs to be created.
Creates a Customer Experience Essentials queue supervisor, when true. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.
Body Parameters
A unique identifier for the supervisor.
People, workspaces and virtual lines that are eligible to receive calls.
Identifier of the person, workspace or virtual line.
Response Properties
Array of supervisor agents status.
ID of person, workspace or virtual line. WARNING: The id returned is in UUID format, since we don't have agentType from OCI response. This will be converting to Hydra type in future release.
status of the agent.
Detailed message for the status.
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
Query Parameters
- The organization ID where the supervisor needs to be created.
- Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.
Body
- A unique identifier for the supervisor.
- People, workspaces and virtual lines that are eligible to receive calls.
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTFlNWQ5NS0zODQyLTRmOGItOGZjNy00NGY5YjA0N2MyZTc",
"agents":
[
{
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzE3NzczMWRiLWE1YzEtNGI2MC05ZTMwLTNhM2MxMGFiM2IxMQ"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9hM2NjOTVhNC0zNzBjLTQyZmQtYWYzOS00MDE0MmE1YjMzMWU"
}
]
}
{
"supervisorAgentStatus": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY",
"status": "NOT_AVAILABLE",
"message": "[Error 6612] Agent 9508978d-9bad-4faa-a9c4-09d85d8fdce6 is not available."
}
]
}