Skip to main content
POST
/
agents
/
{agentId}
/
conversations
Create Conversation
curl --request POST \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/conversations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "platformId": "<string>",
  "leadId": "<string>",
  "name": "<string>",
  "read": false,
  "endedAt": "2023-11-07T05:31:56Z",
  "browser": "<string>",
  "device": "<string>",
  "os": "<string>",
  "countryCode": "<string>",
  "ipAddress": "<string>",
  "record": false,
  "interacted": false,
  "channel": "<string>",
  "phone": "<string>",
  "phoneSecondary": "<string>",
  "instagramId": "<string>",
  "instagramUsername": "<string>",
  "cost": 123,
  "duration": 123,
  "url": "<string>",
  "endedReason": "<string>",
  "noAnswer": true,
  "status": "ai",
  "liveAgentName": "<string>",
  "liveAgentId": "<string>",
  "isLive": false,
  "note": "<string>",
  "topic": "<string>",
  "subtopic": "<string>",
  "summary": "<string>",
  "evaluation": {
    "isSuccess": true,
    "reason": "<string>"
  },
  "mistunderstoodQueries": [
    {
      "question": "<string>"
    }
  ],
  "customAnalysis": {},
  "metadata": {}
}'
{
  "message": "Conversation added successfully",
  "conversation": {
    "_id": "<string>",
    "agentId": "<string>",
    "platformId": "<string>",
    "leadId": "<string>",
    "campaignId": "<string>",
    "name": "<string>",
    "read": false,
    "endedAt": "2023-11-07T05:31:56Z",
    "browser": "<string>",
    "device": "<string>",
    "os": "<string>",
    "countryCode": "<string>",
    "ipAddress": "<string>",
    "record": false,
    "interacted": false,
    "channel": "<string>",
    "phone": "<string>",
    "phoneSecondary": "<string>",
    "instagramId": "<string>",
    "instagramUsername": "<string>",
    "cost": 123,
    "duration": 123,
    "url": "<string>",
    "endedReason": "<string>",
    "noAnswer": true,
    "status": "ai",
    "liveAgentName": "<string>",
    "liveAgentId": "<string>",
    "isLive": false,
    "note": "<string>",
    "topic": "<string>",
    "subtopic": "<string>",
    "summary": "<string>",
    "evaluation": {
      "isSuccess": true,
      "reason": "<string>"
    },
    "mistunderstoodQueries": [
      {
        "question": "<string>"
      }
    ],
    "customAnalysis": {},
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Headers

​
Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

​
agentId
string
required

The ID of the agent

Body

application/json
​
platformId
string

The conversation ID on the original platform

​
leadId
string

The lead associated with the conversation

​
name
string

The name of the user who created the conversation

​
read
boolean
default:false

Whether the conversation has been read

​
endedAt
string<date-time>

The date and time the conversation ended

​
browser
string

The browser used for the conversation

​
device
string

The device used for the conversation

​
os
string

The operating system used for the conversation

​
countryCode
string

The country code associated with the user's location (ISO 3166-1 alpha-2)

​
ipAddress
string

The IP address of the User

​
record
boolean
default:false

Whether to record the conversation

​
interacted
boolean
default:false

Whether the conversation has user interaction

​
channel
string

The channel where the conversation took place

​
phone
string

The phone number associated with the conversation (FROM number for Retell, CUSTOMER number for Vapi and ElevenLabs)

​
phoneSecondary
string

The TO phone number for retell, AGENT number for Vapi and ElevenLabs)

​
instagramId
string

The Instagram ID of the user for Instagram conversations

​
instagramUsername
string

The Instagram username of the user for Instagram conversations

​
cost
number

The cost of the conversation (voice ai calls)

​
duration
number

The duration of the conversation in minutes (voice ai calls)

​
url
string

The URL of the conversation (recording URL for voice ai)

​
endedReason
string

The reason the conversation ended (voice ai)

​
noAnswer
boolean

If the call was not answered (voice ai)

​
status
enum<string>
default:ai

The status of the conversation

Available options:
ai,
pending,
human
​
liveAgentName
string

Name of the live agent handling the conversation

​
liveAgentId
string

ID of the live agent that handled the conversation

​
isLive
boolean
default:false

Whether the conversation is live

​
note
string

A note about the conversation

​
topic
string

The topic associated with the conversation

​
subtopic
string

The subtopic associated with the conversation

​
summary
string

Summary of the conversation

​
evaluation
object
​
mistunderstoodQueries
object[]
​
customAnalysis
object

Custom analysis data being imported in from platforms (just voice agents for now)

​
metadata
object

Metadata associated with the conversation (e.g., custom fields from platforms)

Response

OK

​
message
string
Example:

"Conversation added successfully"

​
conversation
object
⌘I