Sign in

v1

latestOpenAPI 3.1.02026-07-135055368.9 KB
Conversations

Create a New Conversation

Create a New Conversation

post/v1/conversations

Request body

sourcestring required

Source from where the conversation originated. This can be device id, phone number, etc.

sourceType'BROWSER' | 'TWILIO' | 'PLIVO' required
agentIdstring required

AI agent which handled the conversation

transcriptSummarystring nullable

Summary of the conversation

transcriptRecordingUrlstring nullable

URL to the recording of the conversation

timestampStartstring date-time required

Start time of the conversation

timestampEndstring date-time nullable

End time of the conversation

Example request

{
  "source": "device12345",
  "agentId": "aia.1719914136.zl2fxvXB",
  "transcriptSummary": "The conversation was about resolving billing issues.",
  "transcriptRecordingUrl": "http://example.com/recording",
  "adminComments": [
    {
      "comment": "good",
      "rating": 5
    }
  ]
}

Response

Conversation created successfully

idstring
orgIdstring
prospectIdstring nullable
sourcestring
sourceTypestring
aiAgentIdstring
transcriptSummarystring nullable
transcriptRecordingUrlstring nullable
timestampStartstring date-time
timestampEndstring date-time nullable
statusstring required
createdBystring
createdAtstring date-time
updatedBystring
updatedAtstring date-time