Line 1: | Line 1: | ||
=SetInFocus= | =SetInFocus= | ||
+ | __NOTOC__ | ||
+ | ==Overview== | ||
+ | This request will set focus parameter for the e-mail 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]] |
Revision as of 12:44, April 15, 2014
SetInFocus
Overview
This request will set focus parameter for the e-mail 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 }
Comments or questions about this documentation? Contact us for support!