Jump to: navigation, search
(Created target blank page For Version: HTCC:8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
 
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
=SetInFocus=
 +
__NOTOC__
 +
This operation is part of the [[SMSAPI|SMS Session API]] section of the [[Welcome|Web Services API]].
 +
==Overview==
 +
This request sets the focus parameter for an 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/smssessions/{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/smssessions/0071023821aec011
 +
{
 +
  "operationName": "SetInFocus",
 +
  "inFocus": [true or false]
 +
}
 +
</pre>
 +
 
 +
'''Response'''
 +
<pre>
 +
{
 +
  "statusCode": 0
 +
}
 +
</pre>
 +
 
 +
[[Category:V:HTCC:8.5.2]]

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

SetInFocus

This operation is part of the SMS Session API section of the Web Services API.

Overview

This request sets the focus parameter for an 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/smssessions/{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/smssessions/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!