Retrieve Monitoring Settings for a Workspace
Retrieves Monitoring settings for a Workspace.
Allow workspaces to monitor the line status of specified agents, workspaces, or call park extensions. The line status indicates if a monitored agent or a workspace is on a call, or if a call has been parked on the monitored call park extension.
This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:workspaces_read or a user auth token with spark:workspaces_read scope can be used to read workspace settings.
URI Parameters
Unique identifier for the workspace.
Query Parameters
ID of the organization within which the workspace 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
Call park notification enabled or disabled.
Monitored element items.
Monitored Call Park extension.
ID of call park extension.
Name of call park extension.
Extension of call park extension.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Name of location for call park extension.
ID of location for call park extension.
Monitored member for this workspace.
ID of person or workspace.
First name of person or workspace.
Last name of person or workspace.
Display name of person or workspace.
Type of the person or workspace.
Object is a user.
Object is a workspace.
Email of the person or workspace.
List of phone numbers of the person or workspace.
Phone number of person or workspace. Either phoneNumber or extension is mandatory.
Extension of person or workspace. Either phoneNumber or extension is mandatory.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Flag to indicate primary phone.
Flag to indicate toll free number.
Name of location for call park.
ID of the location for call park.
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
- ID of the organization within which the workspace 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.
{
"callParkNotificationEnabled": false,
"monitoredElements": [
{
"member": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NzQzNTI1Yi02ZjgxLTQ0NTktYTYxNC0yN2E0ZDIyZTZhYzI",
"lastName": "Hughes",
"firstName": "Jack",
"displayName": "Jack Hughes",
"type": "PEOPLE",
"email": "jhughes@example.com",
"numbers": [
{
"extension": "587",
"routingPrefix": "1234",
"esn": "1234587",
"primary": true
}
],
"location": "Richardson",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M2MDliOGE1LTAxNmQtNDAwNy1hN2E0LTJhMThiZmZjY2FmNg"
}
},
{
"callparkextension": {
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vOGI2NzlmMzktMTdmMC00ODY3LTk4MmYtYmEwMWJmYmE3YjQw",
"name": "patch postman test",
"extension": "4594",
"routingPrefix": "1234",
"esn": "1234587",
"location": "Banglore",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA"
}
}
]
}