Report what happened to a call you placed yourself

Closes the audit loop on a verdict. opt_out revokes consents and suppresses the number for 90 days; complaint suppresses it permanently.

Requires the write scope. A key with less gets 403 insufficient_scope.

Authorization

AuthorizationBearer <token>

Authorization: Bearer tone_live_… or tone_test_…. The prefix IS the environment: a test key reaches only the sandbox, and no request field bridges the two.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

callReference?string

Your own identifier for the call, echoed back on reads so you can reconcile against your CDR.

Lengthlength <= 200

checkId?string

The checks[].id from the verdict this call acted on, if you pre-flighted it. Ties the outcome to that verdict's audit rows.

Match^\d+$

durationSeconds?integer

How long the call lasted, in whole seconds.

Range0 <= value <= 9007199254740991

e164*string

The number that was called. Repeated even when checkId is present, so an outcome for a call you never pre-flighted still lands on the right number's evidence.

Match^\+91\d{10,11}$

notes?string

Free text kept with the record and returned in the evidence pack.

Lengthlength <= 1000

occurredAt?string

When the call happened. Defaults to now — send it explicitly when reporting in batches after the fact.

outcome*string

What happened. 🔴 opt_out and complaint are not just labels: they suppress the number through the same code path a mid-call opt-out uses — opt_out applies the 90-day re-consent lockout, complaint suppresses permanently. Both revoke every consent on record for that number in the same transaction. Open set — handle an unrecognised value rather than throwing. Today: connected, no_answer, busy, failed, opt_out, complaint, wrong_number.

Value in

"connected"
"no_answer"
"busy"
"failed"
"opt_out"
"complaint"
"wrong_number"

Response Body

`application/json`

curl -X POST "https://example.com/v1/compliance/call-outcomes" \  -H "Content-Type: application/json" \  -d '{    "callReference": "acme-crm-4417",    "checkId": "8814",    "durationSeconds": 45,    "e164": "+919876543210",    "notes": "Customer asked to be called after 6pm.",    "occurredAt": "2026-08-25T09:14:22Z",    "outcome": "connected"  }'

{  "data": {    "consentsRevoked": 0,    "e164": "+919876543210",    "id": "8814",    "outcome": "connected",    "suppressed": true  }}

Was this page helpful?

Report what happened to a call you placed yourself

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`