(Created page with "= SetInFocus= Category:V:HTCC:8.5.2DRAFT") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
= SetInFocus= | = SetInFocus= | ||
| + | __NOTOC__ | ||
| + | This operation is part of the [[OpenMediaAPI|Open Media API]] section of the [[Welcome|Web Services API]]. | ||
| + | |||
| + | ==Overview == | ||
| + | This request sets the focus parameter for the interaction. This parameter is useful when an agent handles more than one interaction because it helps to accurately report the amount of time the agent spent on each interaction. | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! scope="row"| Request URL | ||
| + | | /api/v2/me/openmedia/''{mediaType}''/''{id}'' | ||
| + | |- | ||
| + | ! scope="row"| HTTP Method | ||
| + | | POST | ||
| + | |- | ||
| + | ! scope="row" | Required Features | ||
| + | | api-multimedia | ||
| + | |} | ||
| + | |||
| + | ==Parameters== | ||
| + | {| | ||
| + | |- | ||
| + | ! Parameter | ||
| + | ! Value | ||
| + | |- | ||
| + | |operationName | ||
| + | |SetInFocus | ||
| + | |- | ||
| + | |inFocus | ||
| + | |Boolean parameter. Set to true if the interaction is in focus; otherwise, set to false. | ||
| + | |} | ||
| + | |||
| + | ==Sample== | ||
| + | ===Request=== | ||
| + | <source lang="text"> | ||
| + | POST api/v2/me/openmedia/promotion/0071023821aec011 | ||
| + | { | ||
| + | "operationName": "SetInFocus", | ||
| + | "inFocus": [true or false] | ||
| + | } | ||
| + | </source> | ||
| + | |||
| + | ===Response=== | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "statusCode": 0 | ||
| + | } | ||
| + | </source> | ||
| + | |||
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] | ||
Latest revision as of 16:28, September 28, 2021
SetInFocus
This operation is part of the Open Media API section of the Web Services API.
Overview
This request sets the focus parameter for the interaction. This parameter is useful when an agent handles more than one interaction because it helps to accurately report the amount of time the agent spent on each interaction.
| Request URL | /api/v2/me/openmedia/{mediaType}/{id} |
|---|---|
| HTTP Method | POST |
| Required Features | api-multimedia |
Parameters
| Parameter | Value |
|---|---|
| operationName | SetInFocus |
| inFocus | Boolean parameter. Set to true if the interaction is in focus; otherwise, set to false. |
Sample
Request
POST api/v2/me/openmedia/promotion/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!