(Update with the copy of version: 8.5.2DRAFT) |
|||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
=After Call Work= | =After Call Work= | ||
__NOTOC__ | __NOTOC__ | ||
| + | This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]]. | ||
==Overview== | ==Overview== | ||
| − | + | Sets the current user to the NotReady state with a workmode of AfterCallWork. AfterCallWork is a [[SettingsSystem#Agent_states_settings|system-defined agent state]] operation and is always available for use. | |
{| | {| | ||
! Request URL | ! Request URL | ||
| − | | /api/v2/me/ | + | | /api/v2/me/channels/voice |
|- | |- | ||
| − | ! HTTP | + | ! HTTP method |
| POST | | POST | ||
|- | |- | ||
| − | ! Required | + | ! Required features |
| api-voice | | api-voice | ||
|} | |} | ||
| Line 21: | Line 22: | ||
| operationName | | operationName | ||
| AfterCallWork | | AfterCallWork | ||
| + | |- | ||
| + | | wrapUpTime | ||
| + | | This parameter is passed to T-Server in extensions to change/cancel agent wrap-up time. | ||
| + | |- | ||
|} | |} | ||
==Sample== | ==Sample== | ||
| − | |||
===Request=== | ===Request=== | ||
| − | < | + | <source lang="text"> |
POST api/v2/me/channels/voice | POST api/v2/me/channels/voice | ||
{ | { | ||
| − | "operationName": "AfterCallWork" | + | "operationName": "AfterCallWork" , |
| + | "wrapUpTime": "0" | ||
| + | |||
} | } | ||
| − | </ | + | </source> |
| − | === | + | |
| − | < | + | ===HTTP response=== |
| + | <source lang="text"> | ||
{ | { | ||
"statusCode": 0 | "statusCode": 0 | ||
} | } | ||
| − | </ | + | </source> |
| − | === | + | ===CometD notification=== |
| − | < | + | <source lang="text"> |
{ | { | ||
"data": { | "data": { | ||
| Line 67: | Line 74: | ||
"channel": "/v2/me/devices" | "channel": "/v2/me/devices" | ||
} | } | ||
| − | </ | + | </source> |
[[Category:V:HTCC:8.5.2]] | [[Category:V:HTCC:8.5.2]] | ||
Latest revision as of 17:15, July 14, 2017
After Call Work
This operation is part of the Voice API section of the Web Services API.
Overview
Sets the current user to the NotReady state with a workmode of AfterCallWork. AfterCallWork is a system-defined agent state operation and is always available for use.
| Request URL | /api/v2/me/channels/voice |
|---|---|
| HTTP method | POST |
| Required features | api-voice |
Parameters
| Parameter | Value |
|---|---|
| operationName | AfterCallWork |
| wrapUpTime | This parameter is passed to T-Server in extensions to change/cancel agent wrap-up time. |
Sample
Request
POST api/v2/me/channels/voice
{
"operationName": "AfterCallWork" ,
"wrapUpTime": "0"
}HTTP response
{
"statusCode": 0
}CometD notification
{
"data": {
"messageType": "DeviceStateChangeMessage",
"devices": [
{
"id": "74152ed8-858f-4a33-9e96-36213a678d30",
"deviceState": "Active",
"userState": {
"id": "D3663509-3D82-4DD3-A82E-2EA8EFA02AEF",
"displayName": "AfterCallWork",
"state": "NotReady",
"workMode": "AfterCallWork"
},
"phoneNumber": "5000",
"e164Number": "5000",
"telephonyNetwork": "Private",
"doNotDisturb": "Off",
"voiceEnvironmentUri": "http://127.0.0.1:8080/api/v2/voice-environments/370ef5e6-9e3c-4d91-9588-7f4dfe67e011",
"capabilities": [
"ForwardCallsOn",
"DoNotDisturbOn"
]
}
]
},
"channel": "/v2/me/devices"
} This page was last edited on July 14, 2017, at 17:15.
Comments or questions about this documentation? Contact us for support!