Skip to navigation
API ReferenceTransfers

Get a transfer offer

A ringing offer to one of your app destinations: the same body as the transfer.offer webhook. Only offers to app destinations of this account are visible. Requires an API key with the transfer_offers:read scope.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

offerIdstringRequiredformat: "uuid"
Offer ID

Response

The offer
acceptUntilstring

Accept before this time (it can be earlier than expiresAt: joining the call takes a few seconds)

callIdstringformat: "uuid"
Call being transferred
callerobject
Who is calling.
expiresAtstring
The offer stops ringing at this time
flowNamestring
Name of the flow that handled the call
modestring

cold (the caller is connected at once) or warm (the agent briefs you first)

offerIdstringformat: "uuid"
Offer to accept or decline
testboolean

true for test deliveries, which cannot be accepted

typestring

Event type, always transfer.offer

caseobject or nullOptional
The handoff case the agent collected before transferring.
deliveryIdstring or nullOptionalformat: "uuid"

Unique id of this webhook delivery, also sent in the Talkif-Delivery-Id header (webhook only; absent from GET /api/v1/transfers/offers/{offerId})

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error