Assign or Unassign Agents to Supervisor with Customer Experience Essentials
Assign or unassign agents to the supervisor for 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 administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Identifier of the supervisor to be updated.
Query Parameters
Assign or unassign agents to a supervisor in this organization.
Must be set to true to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to false.
Body Parameters
People, workspaces and virtual lines that are eligible to receive calls. 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.
ID of person, workspace or virtual line. WARNING: The id returned is always of type PEOPLE even if the agent is a workspace or virtual line. The type of the agent id will be corrected in a future release.
Enumeration that indicates whether an agent needs to be added (ADD) or deleted (DELETE) from a supervisor.
Assign an agent to a supervisor.
Remove an agent from a supervisor.
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
- Assign or unassign agents to a supervisor in this organization.
- Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.
Body
- People, workspaces and virtual lines that are eligible to receive calls. **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.
{
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY",
"action": "ADD"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYzIyMTRlNi0zYzdlLTRkZDAtOTc3Yy0zNzRlOWE2ZDk4MWM",
"action": "ADD"
}
]
}
{
"supervisorAgentStatus": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY",
"status": "DUPLICATE",
"message": "[Error 6612] Agent 9508978d-9bad-4faa-a9c4-09d85d8fdce6 is already assigned to the supervisor."
}
]
}