Skip to main content
POST
/
call
/
webhook

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Call happened

​
customerId
string

ID of the customer

​
toPhoneNumber
string

Phone number that was called (E.164 format)

Example:

"+14155551234"

​
transcript
string

Transcript of the call

​
recordingUrl
string

S3 presigned URL for the call recording. Note: This URL expires after 1 hour.

​
timestamp
string<date-time>

Timestamp when the call occurred (ISO 8601 format)

​
flags
string[]

Array of post-processing flags indicating call outcomes and events. Common flags include: NO_ANSWER, VOICEMAIL, CONNECT, LIVE_CONNECT, VOICEMAIL_CONNECT, AUTO_SYSTEM_CONNECT, MESSAGE_LEFT, RPC (Right Party Contact), THIRD_PARTY_CONTACT, WRONG_NUMBER, CUSTOMER_HANGUP, DNC (Do Not Call), COMPLAINT, THREAT_OR_ABUSE, DECEASED, INCARCERATED, MILITARY, BANKRUPTCY, HARDSHIP_REQUEST, DEBT_DISPUTE, ATTORNEY_REP, FRAUD_CLAIM, ACCESSIBILITY_ISSUE, CALLBACK_REQUEST, TRANSFER_FAILED, VOICEMAIL_FULL, VOICEMAIL_NOT_SET_UP, CIP_PASSED, CIP_FAILED, CIP_PARTIAL, CIP_REFUSED, SUCCESSFUL_TRANSFER, FALLBACK_TRANSFER, and others

Example:
[
  "CONNECT",
  "LIVE_CONNECT",
  "RPC",
  "MESSAGE_LEFT"
]
​
summarization
string

AI-generated summary of the call conversation and outcomes

Response

200

Return a 200 status to indicate that the data was received successfully