Supported API trigger parameters

This is a comprehensive list of the supported parameters that are passed when the API trigger call is made to your server.

There are two components of a parameter entry.

Field: The internal name of the parameter as used by the Chats service.
Parameter: The parameter name used in the URL when a call is made to your server.

Chat messages are passed in two ways.

As JSON array of JSON objects with the given Chat Message fields in the ChatTranscript field.
Individually with the given Chat Message fields if the Condition is Chat message is added.

Standard Chat fields

Standard Chat fields are predefined parameters supported by the Chats service.

Identifiers	`ChatID` `VisitID` `VisitorID` `ChatWindowDefID` `ChatAPISettingsID` `ChatButtonDefID` `WebsiteDefID` `FolderID` `AccountID` `InvitationTemplateVariantID`
Types	`ChatType` `Embedded` `PageType` `Secured` `AutoTranslate` `OperatorLanguageCode` `ChatStatusType` `EndedReasonType` `Priority`
Pre-chat	`LanguageCode` `VisitEmailAddress` `VisitPhone` `InitialQuestion` `LastName` `ChatName`
Post-chat	`SurveyResponsiveness` `SurveyProfessionalism` `SurveyKnowledge` `SurveyOverall` `SurveyNps` `SurveyComments` `ScheduleHistoryToEmailAddress`
Unavailable	`UnavailableEmailSubject` `UnavailableEmailBody`
Visit Details	`VisitRef` `VisitInfo` `IP` `ReverseIP` `CountryCode` `City` `RegionCode`
Chat Details	`VisitorMessageCount` `OperatorMessageCount` `UnrespondedMessageCount` `ACDReassignCount` `TotalReassignCount` `MaxQueuePosition` `ResponseMessageCount` `TotalResponseTime` `LastMessagePersonType` `LastVisitorMessageSent`
Agent Wrapup	`UserCategoryID` `UserStatusID` `CustomField1ID` `CustomField2ID`
Dates	`DueDate` `WindowClosed` `Flagged` `Created` `Answered` `LastAssignedAnswered` `Started` `Ended` `Closed` `Updated`
Assignment	`DepartmentID` `LastAssignedByOperatorID` `OperatorID` `EndedBy` `BlockedBy` `FlaggedBy`
External	`RelatedToItemType` `RelatedToItemID` `ExternalCrmType` `ExternalCrmItemID` `ExternalCrmListID` `ActiveAssistDisabled` `ActiveAssistStatus`
URLs	`ChatUrl` `CustomUrl`

Custom Field in Pre-Chat or Post-Chat are custom fields, as defined in the Pre-Chat and Post-Chat form configurations.

Custom Field in Operator Wrap-Up are custom fields, as defined in the Agent Wrap-Up configuration.

CustomFields

Returns a JSON object of custom field name/value mappings.

OperatorCustomFields

Returns a JSON object of the agent custom field name/value mapping for the chat.

<name>

Returns the custom field value of <name>.

ChatTranscript

Returns a JSON array of JSON objects of chat messages. Included fields are the enabled ChatMessage. parameters.

ReloadChatUrl

Returns the URL to lead the chat from. Only applicable for agent trigger types.

Chat URLs

Returns a signed URL with the given API credentials which can be used to manipulate the given chat. The URL call is valid for 24 hours.

LoginOperatorID

Returns the agent ID associated with the agent viewing the page. Only applicable for agent trigger types.

CannedMessageID

ChatMessageID

Created

Hidden

LanguageCode

Name

OriginalMessageID

PersonID

PersonType

Text