Sign in
provider
comms

Ai Call

Initiate an AI Collections call.

post/comms/call/ai

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

assistantType'BILLER' | 'CALL_REMINDER' | 'CALL_FOLLOW_UP' | 'CALL_LAB_TECHNICIAN' required
reasonForCallstring required
patientIdstring required
eventIdstring nullable
provider'retell' | 'livekit'

Response

Successful Response

idstring required
chatIdstring required
direction'INBOUND' | 'OUTBOUND' required
status'CREATED' | 'ONGOING' | 'TRANSFERRED' | 'DISCONNECTED' | 'FAILED' | 'FINISHED' | 'VOICEMAIL' required
completedDatestring date-time nullable
retellCallIdstring nullable
disconnectionReasonstring nullable
pathToAudiostring nullable
summarystring nullable
contextobject nullable
createdDatestring date-time nullable
invoiceIdstring nullable
type'MANUAL' | 'AI'
locationIdstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.