Jump to: navigation, search
(Created page with "=ReportStandardResponseUsage FacebookSession= __NOTOC__ This operation is part of the Facebook Private Messaging API section of the [[Welcome|Genesys Web Servic...")
 
Line 5: Line 5:
 
==Overview==
 
==Overview==
  
−
The purpose of this operation is to provide Standard Response data for UCS reporting. Every request associates Standard Response usage with specific Interaction. This helps administrators determine which Standard Responses are used most often, and so on.
+
The purpose of this operation is to provide Standard Response data for Universal Contact Server (UCS) reporting. Every request associates Standard Response usage with a specific interaction. This helps administrators determine which Standard Responses are used most often, and so on.
−
 
 
−
==Request==
 
−
 
 
−
===Request===
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 23: Line 19:
 
|}
 
|}
  
 +
==Parameters==
 +
{| class="wikitable" border="1"
 +
|-
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| ReportResponseTemplateUsage
 +
|-
 +
| responseTemplateId
 +
| The location of the standardResponse.
 +
|-
 +
| responseType
 +
| The way the response template was used. Possible values are: SystemAutoResponse, SuggestedResponseChoosen, AdministratorResponse, SuggestedResponsesIgnored, SuggestedResponseNotReceived. This is an optional parameter. If this is not provided in the request, the default value is SystemAutoResponse.
 +
|}
 +
 +
 +
==Sample==
 +
===Request===
 
<source lang="text">
 
<source lang="text">
 
POST api/v2/me/facebooksession/063JOIJjoIFJEW
 
POST api/v2/me/facebooksession/063JOIJjoIFJEW
 
</source>
 
</source>
  
−
If the Agent does not have a numeric value for '''employeeId''' this operation will not associate the agent in this usage entry.
+
If the Agent does not have a numeric value for '''employeeId''' this operation will not associate the agent with this usage entry.
  
−
You cannot report usage on Response Templates that are no longer valid (i.e. expired, not started yet, or not approved)
+
You cannot report usage on Response Templates that are no longer valid (they have expired, not started yet, or not been approved)
  
 
  {
 
  {
−
   “operationName”:"ReportResponseTemplateUsage”,
+
   "operationName":"ReportResponseTemplateUsage",
−
   “responseTemplateId”:”9a379217-8c06-4fae-b33b-36c94a54b58c",
+
   "responseTemplateId":"9a379217-8c06-4fae-b33b-36c94a54b58c",
 
   "usageType":"SystemAutoResponse"
 
   "usageType":"SystemAutoResponse"
 
  }
 
  }
  
−
;operationName
+
===Response===
−
:A fixed value denoting the desired API operation. In this case, it is 'ReportResponseTemplateUsage'.
 
−
;responseTemplateId
 
−
:The location of the standardResponse.
 
−
;responseType
 
−
:The way the response template was used. Possible values are: SystemAutoResponse, SuggestedResponseChoosen, AdministratorResponse, SuggestedResponsesIgnored, SuggestedResponseNotReceived. This is an optional parameter. If this is not provided in the request, the default value will be SystemAutoResponse.
 
−
 
 
−
==Response==
 
−
 
 
 
There is no response to process.
 
There is no response to process.
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 20:07, September 29, 2015

ReportStandardResponseUsage FacebookSession

This operation is part of the Facebook Private Messaging API section of the Genesys Web Services REST API.

Overview

The purpose of this operation is to provide Standard Response data for Universal Contact Server (UCS) reporting. Every request associates Standard Response usage with a specific interaction. This helps administrators determine which Standard Responses are used most often, and so on.

Request URL /api/v2/me/facebooksession/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName ReportResponseTemplateUsage
responseTemplateId The location of the standardResponse.
responseType The way the response template was used. Possible values are: SystemAutoResponse, SuggestedResponseChoosen, AdministratorResponse, SuggestedResponsesIgnored, SuggestedResponseNotReceived. This is an optional parameter. If this is not provided in the request, the default value is SystemAutoResponse.


Sample

Request

POST api/v2/me/facebooksession/063JOIJjoIFJEW

If the Agent does not have a numeric value for employeeId this operation will not associate the agent with this usage entry.

You cannot report usage on Response Templates that are no longer valid (they have expired, not started yet, or not been approved) 

{
  "operationName":"ReportResponseTemplateUsage",
  "responseTemplateId":"9a379217-8c06-4fae-b33b-36c94a54b58c",
  "usageType":"SystemAutoResponse"
}

Response

There is no response to process.

Comments or questions about this documentation? Contact us for support!