Declare a Chat Interaction
The first step in processing any interaction is to declare the interaction.
When the POST request successfully executes, an HTTP status is returned to indicate the request was successful, along with a JSON response containing the interactionIdentifier.
It is important you store the interactionIdentifier as it will serve as a required parameter for all other ElevateAI endpoints, enabling you to POST, GET, and/or DELETE information associated with this interaction.
If an error occurs when requesting to declare the interaction, a standard HTTP response code is retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in troubleshooting.
All interactions successfully declared will count towards your monthly request quota, irrespective of file upload status or processing outcome.
Only interactions successfully processed are eligible for billing. Once declared, you are able to confirm the processing status of the interaction as well as track impacts to usage and spend.
// Request Parameters & Code Samples
Details on CX AI features supported by language can be found on the overview page.
// Formatting a Chat for Processing
Chat files will be formatted according to the schema below, and included as a body parameter when declaring a chat interaction for processing.
Sample Chat File Format
array of objects
Ordered list of details associated with each participant, will include 1+ objects
Unique identifier associated with participant
Name of participant
string or null
Will be agent or customer
array of objects
Ordered list of details associated with each chat message, will include 1+ objects
Maps to a unique participant_id within participants object
Date/time that the chat message was sent, formatted according to ISO 8601 (UTC)