Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=SetInFocus=
 
=SetInFocus=
 +
__NOTOC__
 +
This operation is part of the [[Email|Email API]] section of the [[Welcome|Web Services API]].
 +
==Overview==
 +
Sets the focus parameter for an email interaction.
 +
 +
This is useful if agent is handling more than one interaction and will assist in correctly reporting time spent on each interaction.
 +
{|
 +
! Request URL
 +
| /api/v2/me/emails/{id}
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
 +
 +
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| SetInFocus
 +
|-
 +
| inFocus
 +
| Boolean parameter <tt>true</tt> or <tt>false</tt>
 +
|}
 +
 +
==Sample==
 +
===Request===
 +
<pre>
 +
POST api/v2/me/emails/0071023821aec011
 +
{
 +
  "operationName": "SetInFocus",
 +
  "inFocus": [true or false]
 +
}
 +
</pre>
 +
 +
===Response===
 +
<pre>
 +
{
 +
  "statusCode": 0
 +
}
 +
</pre>
 +
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 12:32, October 18, 2021

SetInFocus

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

Overview

Sets the focus parameter for an email interaction.

This is useful if agent is handling more than one interaction and will assist in correctly reporting time spent on each interaction.

Request URL /api/v2/me/emails/{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/emails/0071023821aec011
{
  "operationName": "SetInFocus",
  "inFocus": [true or false]
}

Response

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