Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
= SetInFocus=
 +
__NOTOC__
 +
This operation is part of the [[OpenMediaAPI|Open Media API]] section of the [[Welcome|Genesys Web Services REST 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.2]]

Revision as of 19:44, October 23, 2015

SetInFocus

This operation is part of the Open Media API section of the Genesys Web Services REST 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
}
Comments or questions about this documentation? Contact us for support!