The startticket API is used to get detail for Ticket form fields.
UI Reference: The API is called when the ticket form is loaded.
URI: webapp-api-History?api=startticket
Access Rights Required: All agents
Name |
Type |
Description |
---|---|---|
interactionID |
String |
This parameter represents the id of interaction. |
topicID |
String |
This parameter represents the id of the topic. |
segmentID |
String |
This parameter represents the id of the segment. |
customerID |
String |
This parameter represents the id of the customer. |
pageAction |
String |
This parameter represents the action name which was performed. |
pageName |
String |
This parameter represents the page name. |
{ |
Name |
Type |
Description |
---|---|---|
errors |
Array |
An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error. |
errorsDetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
quotedBody |
String |
|
interactionProperties |
Array |
This returns all properties and their values if property value set in interaction. |
caseProperties |
Array |
This returns all case properties and their values if property value set in interaction. |
caseProperties[].name |
String |
This represents the name of the property. |
caseProperties[].properties |
Array |
Array of Property details.see property data structure. |
caseProperties[].logins |
Number |
This property has a list of objects with login details including name and type of property value. |
caseProperties[].canModifyLogins |
Boolean |
This property represents rights of modification in logins. |
attachments |
Array |
This has all the attachments which are added in interaction. |
addresses |
Array |
All email addresses of users. |
{ |