curl 'https://app.reddy.io/api/v1/call-handoff/6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e' \
-H 'Authorization: Bearer your_api_key'
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": true,
"metadata": {
"customer_intent": "cancel_service",
"account_number": "A-10293",
"sentiment": "frustrated",
"summary": "Customer wants to cancel due to billing issues."
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:09:42Z",
"finalized_at": "2026-08-04T14:09:42Z"
}
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": false,
"metadata": {
"customer_intent": "cancel_service"
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:05:20Z",
"finalized_at": null
}
Call Handoff Endpoints
Get Call Handoff
Retrieves call-handoff metadata collected by Reddy during a voice call.
GET
/
api
/
v1
/
call-handoff
/
{handoff_id}
curl 'https://app.reddy.io/api/v1/call-handoff/6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e' \
-H 'Authorization: Bearer your_api_key'
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": true,
"metadata": {
"customer_intent": "cancel_service",
"account_number": "A-10293",
"sentiment": "frustrated",
"summary": "Customer wants to cancel due to billing issues."
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:09:42Z",
"finalized_at": "2026-08-04T14:09:42Z"
}
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": false,
"metadata": {
"customer_intent": "cancel_service"
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:05:20Z",
"finalized_at": null
}
Retrieves the metadata record identified by
The
handoff_id. Reddy creates this
record when a voice call starts and writes metadata to it incrementally while
the call is in progress. When the call wraps up, Reddy finalizes the record:
final flips to true, finalized_at is set, and the metadata becomes
immutable.
Always check the
final flag before consuming the metadata. While
final is false, the record is still being written: keys may be missing
entirely or carry intermediate values that will change. Only treat the
metadata as complete and authoritative once final is true. If you fetch
the record and final is still false, retry after a short delay (or wait
for your handoff trigger) instead of consuming the partial data.handoff_id is a UUID minted by Reddy for a single call handoff. Supply
it from whatever integration path your account is set up with; delivery of
the id alongside the transferred call itself is being rolled out separately,
so confirm with your Reddy contact how your systems will receive it.
curl 'https://app.reddy.io/api/v1/call-handoff/6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e' \
-H 'Authorization: Bearer your_api_key'
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": true,
"metadata": {
"customer_intent": "cancel_service",
"account_number": "A-10293",
"sentiment": "frustrated",
"summary": "Customer wants to cancel due to billing issues."
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:09:42Z",
"finalized_at": "2026-08-04T14:09:42Z"
}
{
"handoff_id": "6f1b24a0-8c2d-4a4e-9d64-2f6a1f0c3b7e",
"final": false,
"metadata": {
"customer_intent": "cancel_service"
},
"created_at": "2026-08-04T14:03:11Z",
"updated_at": "2026-08-04T14:05:20Z",
"finalized_at": null
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
OK
Unique identifier of the handoff record
True once the record is finalized and immutable. While false, the metadata is still being written and may be partial -- always check this flag before consuming the data.
Key/value metadata collected during the call. Only complete and safe to consume once 'final' is true.
When the handoff record was created
When the record was last updated
When the record was finalized, or null while still partial
Was this page helpful?