The History API is used to get the details of an interaction, create new interactions, set properties within interactions, and to delete existing interactions. History is displayed in multiple places within the iService user interface. The full history for every contact can be found in the Contact - History page, but details for interactions are also shown in most of the message queue pages.

 

 

 

 

Endpoints

The endpoints within the History form include the following:

 

 

Getting history details

details - to get all the  history detail for interaction.

 

Creating new interactions

Within the iService user interface, new interactions are created in two steps. The first step is to load the options for the interaction into the form, such as a list of topics and properties associated with the topics. Once the form is loaded, the user inputs the values (topic, subject, body, etc.) and creates the interaction. The history endpoints are used to obtain the details needed to load the iService form. The custinfo API is used to create the interaction.  

 

startagentemail - to get details for the Agent Email from fields.

startnote - to get details for the Note form fields .

startticket - to get details for the Ticket form fields.

startforwardemail - to get detail for the Forward a Copy form fields.

 

Setting interaction properties for an interaction

 

propertyset -  to used to set property values in interaction.

 

Deleting interactions

 

delete - to delete an Interaction.