API Reference

Create an AIReceptionistConversation

post
https://api.vcita.biz/v3/online_presence/ai_receptionist_conversations

Creates an AIReceptionistConversations. Available for Staff tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255

Chat session identifier associated with this persisted conversation.

string
required
length ≤ 255

Business UID for this conversation. Must match the authenticated business context.

transcript

Structured transcript JSON (ChatTranscriptDocument) when closing a session; optional JSON string encoding for compatibility.

string | null

Optional summary of the conversation.

string | null

Visitor full name captured during the chat.

string | null

Visitor email captured during the chat.

string | null

Visitor phone captured during the chat.

string | null

Page URL where the chat was started.

date-time
required

Conversation start timestamp in ISO 8601 format.

date-time
required

Conversation end timestamp in ISO 8601 format.

string | null

Optional related matter/case UID.

string | null

Optional CRM client UID linked to this conversation.

integer | null
≥ 0

Number of visitor-visible messages in the conversation.

string | null

Lead intent extracted or assigned for this conversation (e.g., "General inquiry").

lead_information
object | null

Lead key/value data captured from the conversation.

string | null

Application that delivered the inbound traffic for this conversation.

string | null

Channel identifier used for attribution in AI Receptionist reporting.

string | null
enum

Lifecycle owner for the conversation.

Allowed:
string | null

Internal voicecalls call UID used to correlate voice callbacks.

string | null

External provider conversation UUID, usually the Vonage conversation UUID.

voice_metadata
object | null

Voice-specific metadata for AI Receptionist calls, including caller/callee numbers and recording details when available.

Responses

Updated about 4 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago