Purpose
The history API is used to fetch a contact's interactions in a customer portal.
UI Reference: The API is called when the My Inbox is viewed.
URI: webapp-api-findanswer?api=history
Access Rights Required:
Request
Request Parameters
Name |
Type |
Description |
|---|---|---|
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
Request Payload Example
{ "_pageAction": "null" } |
Response
Response Parameters
Name |
Type |
Description |
|---|---|---|
history |
Array |
An array of strings. This provides basic information about the interaction. |
history[].id |
String |
This returns the id of interaction. |
history[].subject |
String |
This returns the subject of interaction. |
history[].subjectBare |
String |
|
history[].topicID |
String |
This has the value of topic id in which article belongs to . |
history[].topicName |
String |
This has the value of topic name in which article belongs to . |
history[].segmentName |
String |
|
history[].type |
String |
|
history[].fromAddress |
String |
|
history[].agentName |
String |
This is the full name of the agent if the message is assigned to any agent. |
history[].assignedToID |
String |
This is the id of the agent if the message is assigned to any agent. |
history[].headerFrom |
String |
|
history[].resolvedByName |
String |
|
history[].tags |
Array |
An array of strings. Tags are used to label interactions for special handling in the user interface. |
history[].status |
String |
|
history[].date |
String |
This returns the date of interaction. |
history[].attachments |
Array |
An array of attachments which are included with the interaction. |
history[].properties |
Array |
See property values |
Response Example
{ "history": [ { "id": "45647", "subject": "Re: [ref#: 45642-45647] best LG television", "subjectBare": "best LG television", "topicID": "40", "topicName": "Televisions", "segmentName": "e-shop", "type": "Agent Response", "fromAddress": "poojalalwani.199@gmail.com", "agentName": "e-shop Administrator", "assignedToID": "", "headerFrom": "\"Customer Service\" <demo-cc@1to1service.com>", "resolvedByName": "e-shop Administrator", "tags": [], "status": "Sent", "date": "2022-01-28T23:46:39.6000000Z", "attachments": [], "properties": [] } ] }
|
