Documentation:HTCC:API:GWSReportTimeInFocus:8.5.2DRAFT

GWS Report Time In Focus

Important

This document has been prepared specifically for Apple for release with Web Services and Applications 8.5.202.79. The information contained herein is proprietary and confidential and cannot be disclosed or duplicated without the prior written consent of Genesys Telecommunications Laboratories, Inc. Copyright © 2020 Genesys Telecommunications Laboratories, Inc. All rights reserved.

Introduction

The ReportTimeInFocus request accepts MediaType in payload for 8.5.202.79 and later versions of Web Services and Applications. The property name is "mediaType". The valid value is any string which should be transferred as-is to Interaction Server. This property is optional.

POST /api/v2/me/interactions/{interactionId}

{
   "operationName": "ReportTimeInFocus",
   "timeInFocus": 7,
   "mediaType": "chat"
}

Overview

With this request, the agent will report the time spent working directly or indirectly on the interaction.

Request URL	/api/v2/me/interactions/{interactionId}
HTTP Method	POST
Required Features	api-multimedia

Parameters

Parameter	Value
operationName	ReportTimeInFocus
timeInFocus	Integer. The time that the agent spent working directly or indirectly on the interaction.
mediaType	String. Optional. Media type of the interaction being reported. May be provided to hint Interaction Server Proxy to deliver the event to one of the Interaction Server(s) that has the corresponding media configured.

The request involves sending a JSON body as well as adhering to the URL path listed above:

POST api/v2/me/00013aCVMEKU0013

Listed below is the possible valid JSON for request:

{
    "operationName": "ReportTimeInFocus",
    "timeInFocus": 7,
    "mediaType": "chat"
}

Response

The response consists of an HTTP response.

HTTP response

{
    "statusCode": 0,
}