Submit an Interaction
Declare a Chat Interaction
// // overview the first step in processing any interaction is to declare the interaction when the post post request successfully executes, an http status is returned to indicate the request was successful, along with a json response containing the interactionidentifier sample api response { "interactionidentifier" "6091d697 9a98 4953 9850 d3e9b82cd5ab" } it is important you store the interactionidentifier as it will serve as a required parameter for all other elevateai endpoints, enabling you to post post , get get , and/or delete 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 troubleshooting all interactions successfully declared will count towards your monthly request quota 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 https //docs elevateai com/tutorials/check the processing status of the interaction as well as track impacts to usage https //docs elevateai com/tutorials/elevateai dashboards#h1qyd and spend https //docs elevateai com/tutorials/elevateai dashboards#jysvi // // request parameters & code samples details on cx ai features supported by language can be found on the overview page https //docs elevateai com/#bgq4z // // 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 sample chat format { "participants" \[ { "participant id" "elevateai team", "name" "madison", "role" "agent" }, { "participant id" "elevateai evangelist", "name" "developer", "role" "customer" } ], "messages" \[ { "participant id" "elevateai team", "timestamp" "2022 07 04t14 25 15z", "content" "we hope this documentation is useful!" }, { "participant id" "elevateai evangelist", "timestamp" "2022 07 04t14 26 45z", "content" "it is, thank you!" } ] } schema element type description participants array of objects ordered list of details associated with each participant, will include 1+ objects participant/ participant id string unique identifier associated with participant participants/ name string name of participant participants/ role string or null will be agent or customer messages array of objects ordered list of details associated with each chat message, will include 1+ objects messages/ participant id string maps to a unique participant id within participants object messages/ timestamp string date/time that the chat message was sent, formatted according to iso 8601 (utc) https //en wikipedia org/wiki/iso 8601 messages/ content string chat message