sipgate AI Flow icon

sipgate AI Flow

Control sipgate AI Flow calls with various actions

Transfer Call

AI-generated

Summary

Transfer an ongoing sipgate AI Flow call to another phone number, specifying the caller ID details and optional ring timeout before giving up.

Inputs

  • Session ID (required) — The session ID of the AI Flow event that identifies the current call session.
  • Target Phone Number (required) — The phone number to transfer the call to, preferably in E.164 format.
  • Caller ID Name (required) — The name to display as the caller ID during the transferred call.
  • Caller ID Number (required) — The phone number to display as the caller ID, preferably in E.164 format.
  • Ring Timeout (Seconds) — Optional duration (5–120 seconds) to ring the target phone number before giving up. A value of 0 uses the AI Flow default.

Output shape

no body — success/failure only

The operation returns an action object describing the transfer request with no direct output data. Errors are raised if required inputs are missing or out of bounds.

Links

Discussion