(Created target blank page For Version: HTCC:8.5.2) |
(Update with the copy of version: 8.5.2DRAFT) |
||
Line 1: | Line 1: | ||
− | < | + | =RequestStats= |
+ | __NOTOC__ | ||
+ | This operation is part of the [[Workbins|Workbins API]] section of the [[Welcome|Web Services API]]. | ||
+ | ==Overview== | ||
+ | Agents can request statistics for a workbin. | ||
+ | {| | ||
+ | ! Request URL | ||
+ | | /api/v2/workbins/{id} | ||
+ | |- | ||
+ | ! HTTP Method | ||
+ | | POST | ||
+ | |- | ||
+ | ! Required Features | ||
+ | | api-multimedia | ||
+ | |} | ||
+ | |||
+ | ==Parameters== | ||
+ | {| | ||
+ | |- | ||
+ | !operationName | ||
+ | |RequestStats | ||
+ | |} | ||
+ | |||
+ | ==Sample== | ||
+ | The request involves sending a JSON body as well as adhering to the URL path listed above. | ||
+ | |||
+ | ===Request=== | ||
+ | <pre> | ||
+ | POST api/v2/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07 | ||
+ | { | ||
+ | "operationName": "RequestStats" | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | |||
+ | ===Response=== | ||
+ | The response consists of an HTTP response and a CometD response. | ||
+ | |||
+ | '''HTTP response''' | ||
+ | <pre> | ||
+ | { | ||
+ | "statusCode": 0, | ||
+ | "referenceId": 7 | ||
+ | } | ||
+ | |||
+ | </pre> | ||
+ | |||
+ | '''CometD Response''' | ||
+ | <pre> | ||
+ | |||
+ | { | ||
+ | "workbinStats":{ | ||
+ | "abc2ad1b26ea4e9b8dd907eabe1672e4":{ | ||
+ | "MaxMovedToQueueAt":"2017-09-12T18:05:40Z", | ||
+ | "MinMovedToQueueAt":"2017-09-12T18:05:40Z", | ||
+ | "NumberOfInteractions":1 | ||
+ | } | ||
+ | }, | ||
+ | "id":"6c715fa9-de16-4d23-b07c-cbcb1caf3e07", | ||
+ | "workbinType":"Agent", | ||
+ | "messageType": "WorkbinStatsMessage", | ||
+ | "referenceId": 7 | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | [[Category:V:HTCC:8.5.2]] |
Latest revision as of 18:07, November 30, 2017
RequestStats
This operation is part of the Workbins API section of the Web Services API.
Overview
Agents can request statistics for a workbin.
Request URL | /api/v2/workbins/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
operationName | RequestStats |
---|
Sample
The request involves sending a JSON body as well as adhering to the URL path listed above.
Request
POST api/v2/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07 { "operationName": "RequestStats" }
Response
The response consists of an HTTP response and a CometD response.
HTTP response
{ "statusCode": 0, "referenceId": 7 }
CometD Response
{ "workbinStats":{ "abc2ad1b26ea4e9b8dd907eabe1672e4":{ "MaxMovedToQueueAt":"2017-09-12T18:05:40Z", "MinMovedToQueueAt":"2017-09-12T18:05:40Z", "NumberOfInteractions":1 } }, "id":"6c715fa9-de16-4d23-b07c-cbcb1caf3e07", "workbinType":"Agent", "messageType": "WorkbinStatsMessage", "referenceId": 7 }
This page was last edited on November 30, 2017, at 18:07.
Comments or questions about this documentation? Contact us for support!