Transfer a phone call

The runtime emits a call-forward trace with a phone or SIP destination. Your telephony integration must perform the transfer through its call provider. The runtime ends its turn after emitting this instruction; emitting it does not confirm the provider transferred the call.

A Socket.IO connection alone cannot transfer a phone call. A browser microphone session has no phone call to transfer.

call-forward trace

Signals that the call is being forwarded. The payload always carries the destination in address and its kind in addressType; a phone forward may also carry an extension and a callerIDPassthrough flag. See the call forward step for configuration.

“Required” above means required in every payload shape. A field can be required for a particular state or event even when it is not required in every shape; the schema below defines those conditions.

call-forward payload schema

Look up nested fields, conditional requirements and constraints.

This is the OpenAPI payload schema, not an example response. Referenced definitions are included under components.schemas.

OpenAPI payload schema

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.