(Created Fix blank page For Version: HTCC:8.5.2DRAFT) |
|||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <!-- | + | =SetInFocus= |
+ | __NOTOC__ | ||
+ | This operation is part of the [[Chat|Chat API]] section of the [[Welcome|Web Services API]]. | ||
+ | ==Overview== | ||
+ | This request sets the <tt>SetInFocus</tt> parameter for a chat interaction. | ||
+ | |||
+ | This parameter is useful when an agent is handling more than one interaction and aids in the proper reporting of time spent on each interaction. | ||
+ | {| | ||
+ | ! Request URL | ||
+ | | /api/v2/me/chats/{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/chats/0071023821aec011 | ||
+ | { | ||
+ | "operationName": "SetInFocus", | ||
+ | "inFocus": [true or false] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | '''Response''' | ||
+ | <pre> | ||
+ | { | ||
+ | "statusCode": 0 | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | [[Category:V:HTCC:8.5.2DRAFT]] |
Latest revision as of 16:27, September 28, 2021
SetInFocus
This operation is part of the Chat API section of the Web Services API.
Overview
This request sets the SetInFocus parameter for a chat interaction.
This parameter is useful when an agent is handling more than one interaction and aids in the proper reporting of time spent on each interaction.
Request URL | /api/v2/me/chats/{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/chats/0071023821aec011 { "operationName": "SetInFocus", "inFocus": [true or false] }
Response
{ "statusCode": 0 }
This page was last edited on September 28, 2021, at 16:27.
Comments or questions about this documentation? Contact us for support!