Jump to: navigation, search
(Auto-creation of topic Documentation:HTCC:API:WorkitemSetInFocus:8.5.2DRAFT via TOC Documentation:HTCC:APITOC8.5.2DRAFT)
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
= WorkitemSetInFocus=
+
= Workitem SetInFocus=
 +
__NOTOC__
 +
This operation is part of the [[WorkitemAPI|Workitem API]] section of the [[Welcome|Web Services API]].
 +
==Overview==
 +
This request will set the focus parameter for the interaction. This is useful if an agent is handling more than one interaction and will aid in the proper reporting of time spent on each interaction.
 +
 
 +
{|
 +
! Request URL
 +
| /api/v2/me/workitems/{id}
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
 +
 
 +
==Parameters==
 +
 
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| SetInFocus
 +
|-
 +
| inFocus
 +
| Boolean parameter '''true''' or '''false'''
 +
|}
 +
 
 +
==Sample==
 +
 
 +
===Request===
 +
<pre>
 +
POST api/v2/me/workitems/0071023821aec011
 +
{
 +
  "operationName": "SetInFocus",
 +
  "inFocus": [true or false]
 +
}
 +
</pre>
 +
 
 +
===Response===
 +
<pre>
 +
{
 +
  "statusCode": 0,
 +
}
 +
</pre>
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 16:28, September 28, 2021

Workitem SetInFocus

This operation is part of the Workitem API section of the Web Services API.

Overview

This request will set the focus parameter for the interaction. This is useful if an agent is handling more than one interaction and will aid in the proper reporting of time spent on each interaction.

Request URL /api/v2/me/workitems/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName SetInFocus
inFocus Boolean parameter true or false

Sample

Request

POST api/v2/me/workitems/0071023821aec011
{
  "operationName": "SetInFocus",
  "inFocus": [true or false]
}

Response

{
  "statusCode": 0,
}
This page was last edited on September 28, 2021, at 16:28.
Comments or questions about this documentation? Contact us for support!