Skip to main content
POST
Transcribe a call

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Minimum string length: 1

Response

Success

id
string
required
Minimum string length: 1
projectId
string
required
Minimum string length: 1
entityId
string
required

The deal the call is attached to, or the contact when it has no deal.

Minimum string length: 1
entityType
enum<string>
required
Available options:
DEAL,
CONTACT
provider
enum<string>
required
Available options:
API4COM
externalId
string
required

The call id on the telephony provider.

Minimum string length: 1
direction
enum<string>
required
Available options:
OUTBOUND,
INBOUND
from
object
required
to
object
required
startedAt
string<date-time>
required
endedAt
string<date-time>
required
durationInSeconds
integer
required

Talk time, from the answer to the hang up.

outcome
enum<string>
required
Available options:
ANSWERED,
NO_ANSWER,
BUSY,
VOICEMAIL,
FAILED
recording
object
required
transcription
object | null
required

Null while there is no stored recording.

analysis
object | null
required

The AI summary, written after each transcription; null before the first one.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
answeredAt
string<date-time>