v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-285553225.5 KB
Call

Create a call

Create a new call with recording, transcript, agents, and customers

post/v1/call

Request body

recordingUrlstring uri required

URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.

stereoRecordingUrlstring uri

URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.

startedAtstring required

When the call started (ISO 8601 format)

interfaceType'PHONE' | 'WEB' required

Interface type of the call (PHONE or WEB)

callDirection'INBOUND' | 'OUTBOUND' required

Direction of the call (INBOUND or OUTBOUND)

endedStatus'PARTICIPANTS_DID_NOT_SPEAK' | 'AGENT_DID_NOT_ANSWER' | 'AGENT_DID_NOT_SPEAK' | 'AGENT_STOPPED_SPEAKING' | 'AGENT_ENDED_CALL' | 'AGENT_TRANSFERRED_CALL' | 'AGENT_BUSY' | 'AGENT_ERROR' | 'CUSTOMER_ENDED_CALL' | 'VOICE_MAIL_REACHED' | 'SILENCE_TIME_OUT' | 'PHONE_CALL_PROVIDER_CONNECTION_ERROR' | 'CUSTOMER_DID_NOT_ANSWER' | 'CUSTOMER_DID_NOT_SPEAK' | 'CUSTOMER_STOPPED_SPEAKING' | 'CUSTOMER_BUSY' | 'DIAL_ERROR' | 'MAX_DURATION_REACHED' | 'UNKNOWN'

High-level call end status, indicating how the call terminated

propertiesobject

Custom properties to include with the call. These can be used for filtering and will show in the call details page

Response

Call created successfully

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "660e8400-e29b-41d4-a716-446655440001",
    "callDirection": "INBOUND",
    "startedAt": "2024-01-15T10:00:00Z"
  }
}