Standard Response Library

This API allows you to browse through the Standard Response Library and to add a Standard Response to an interaction. This API will be asynchronous; responses come via cometD notifications.

Operation Name	HTTP Operation	Description	Permissions
GetStandardResponseCategory	POST	Returns information about a particular category, and at most one level down of sub-categories.	Agent
GetStandardResponse	POST	Returns content of the actual Standard Response.	Agent
LinkStandardReponseToInteraction	POST	Subsitutes meta-data in the Standard Response with interaction details.	Agent

GetStandardResponseCategory

URI

TBD

Input

{
"operationName":"GetStandardResponseCategory",
"categoryId":category-identification-information
}

Output

Success

{
"statusCode": 0
}

Failure

{
"statusCode": an integer value above 0,
"statusMessage":details
}

For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.

Notification

Draft

{
"categoryName":category-name,
"categoryId":category-id,
"subCategories": [
   "subCategory : {
       "categoryName":category-name,  
       "categoryId":category-id,
   },
   "subCategory : {
       "categoryName":category-name,  
       "categoryId":category-id,
   }
],
"standardResponses": [
  "standardResponse": {
      "standardResponseName":name,
      "standardResponseId":id
  },
  "standardResponse": {
      "standardResponseName":name,
      "standardResponseId":id
  }
]
}

GetStandardResponse

URI

TBD

Input

{
"operationName":"GetStandardResponse",
"standardResponseId":standard-response-identification-information
}

Output

Success

{
"statusCode": 0
}

Failure

{
"statusCode": an integer value above 0,
"statusMessage":details
}

For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.

Notification

Draft

{
"standardResponseId":id,
"standardResponseName":name,
"content":....
....
}

LinkStandardResponseToInteraction

URI

/me/interactions/{id}

Input

{
"operationName":"LinkStandardResponseToInteraction",
"standardResponseId":standard-response-identification-information
}

Output

Success

{
"statusCode": 0
}

Failure

{
"statusCode": an integer value above 0,
"statusMessage":details
}

For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.

Notification

TBD