<TransferCallTool>

<TransferCallTool>

A ready tool that puts the caller through to a number and tells the model what happened (Human handoff).

import { TransferCallTool } from "curb";

function TransferCallTool(props: TransferCallToolProps): ReactNode;

Props

PropTypeDefaultWhat it does
tostringThe number in international format, like +493012345678
namestringtransfer_callThe tool’s name
descriptionstringsays what it doesWhen the model should call it
ringTimeoutSecondsnumber30How long it rings, 10 to 60 seconds
onEndeddecision or functionthe agent takes the call backWhat happens when the person hangs up and the caller stays (When the person hangs up)

Example

<TransferCallTool to="+493012345678" description="The caller asks for a person." ringTimeoutSeconds={20} />

Version history

VersionChanges
v1.15.0onEnded added
v1.9.0<TransferCallTool> introduced