Jump to: navigation, search

ReportStandardResponseUsage

This operation is part of the Standard Response API section of the Web Services API.

Overview

This request provides Standard Response data for UCS reporting. Every request associates Standard Response usage with specific interactions. For example, this helps administrators determine which Standard Responses are used most often.

Request

Request URL /api/v2/platform/contactserver/ReportStandardResponseUsage/{standardResponseId}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value Mandatory
interactionId Interaction identity Optional. One of the identity parameters must be specified.
chatId Interaction identity Optional. One of the identity parameters must be specified.
facebookId Interaction identity Optional. One of the identity parameters must be specified.
emailId Interaction identity Optional. One of the identity parameters must be specified.
facebookSessionId Interaction identity Optional. One of the identity parameters must be specified.
tweetId Interaction identity Optional. One of the identity parameters must be specified.
responseType List of Custom properties The default value is SystemAutoResponse. Possible values are SystemAutoResponse, SuggestedResponseChoosen, SuggestedResponsesIgnored, AdministratorResponse, and SuggestedResponseNotReceived.

Sample

POST http://.../api/v2/platform/contactserver/ReportStandardResponseUsage/00019aBD0HBH00AX
{
                    "chatId" : "0000PaB33P4V0H4B",
                    "responseType" : "SuggestedResponseChoosen",
}

Response

{
  "statusCode": 0,
  "response": "EventAddStdRespUsage",
  "data": {
      "referenceId": 4
  }
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on September 2, 2016, at 11:11.