{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Agent Wellbeing API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Agent Wellbeing",
"type": "folder"
},
"items": [
{
"info": {
"name": "Subscribe for realtime burnout events",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/agentburnout/subscribe",
"headers": [
{
"name": "X-ORGANIZATION-ID",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint provides real-time burnout events that are generated for agents belonging to the organization. It gives us a WebSocket URL to which we can connect to receive the real-time burnout events."
},
{
"info": {
"name": "Record the realtime burnout events",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/agentburnout/action",
"headers": [
{
"name": "X-ORGANIZATION-ID",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The endpoint need to be invoked by Partners and Third-Party that will subscribe to the Agent Burnout system, in order to take certain action based on the agent burnout index calculated."
},
{
"info": {
"name": "Get specific Agent Burnout resource by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/agent-burnout/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Agent Burnout resource."
}
]
},
"docs": "Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead."
},
{
"info": {
"name": "Update specific Agent Burnout resource by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/agent-burnout/:id",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "id",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2",
"type": "path",
"description": "Resource ID of the Agent Burnout resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead."
},
{
"info": {
"name": "List Agent Burnout resource(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/agent-burnout",
"params": [
{
"name": "orgid",
"value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"type": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
},
{
"name": "filter",
"value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
"type": "query",
"description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
},
{
"name": "attributes",
"value": "id",
"type": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported."
},
{
"name": "page",
"value": "0",
"type": "query",
"description": "Defines the number of displayed page. The page number starts from 0."
},
{
"name": "pageSize",
"value": "100",
"type": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
}
]
},
"docs": "Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource. Deprecated. Use GET /v2/ai-feature/agent-burnout instead."
}
]
}
],
"bundled": true
}