Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
Line 3: Line 3:
 
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]].
 
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]].
 
==Overview==
 
==Overview==
−
Sets the current user to the <tt>NotReady</tt> state with a workmode of <tt>AfterCallWork</tt>.  
+
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.
−
 
 
−
<tt>AfterCallWork</tt> is a system defined agent state operation and is always available for use.
 
 
{|
 
{|
 
! Request URL
 
! Request URL
−
| /api/v2/me/calls/{id}
+
| /api/v2/me/calls/''{id}''
 
|-
 
|-
−
! HTTP Method
+
! HTTP method
 
| POST
 
| POST
 
|-
 
|-
−
! Required Features
+
! Required features
 
| api-voice
 
| api-voice
 
|}
 
|}
Line 27: Line 25:
  
 
==Sample==
 
==Sample==
−
 
 
===Request===
 
===Request===
−
<pre>
+
<source lang="text">
 
POST api/v2/me/channels/voice
 
POST api/v2/me/channels/voice
 
{
 
{
 
   "operationName": "AfterCallWork"
 
   "operationName": "AfterCallWork"
 
}
 
}
−
</pre>
+
</source>
−
===Response===
+
===HTTP response===
−
<pre>
+
<source lang="text">
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
−
</pre>
+
</source>
−
===Notification===
+
===CometD notification===
−
<pre>
+
<source lang="text">
 
{
 
{
 
   "data": {
 
   "data": {
Line 70: Line 67:
 
   "channel": "/v2/me/devices"
 
   "channel": "/v2/me/devices"
 
}
 
}
−
</pre>
+
</source>
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 18:22, March 25, 2016

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/calls/{id}
HTTP method POST
Required features api-voice

Parameters

Parameter Value
operationName AfterCallWork

Sample

Request

POST api/v2/me/channels/voice
{
  "operationName": "AfterCallWork"
}

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"
}
Comments or questions about this documentation? Contact us for support!