Realtime

Refer call

Changed on

Transfer an active SIP call to a new destination using the SIP REFER verb.

post/realtime/calls/{call_id}/refer

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/realtime/calls/{call_id}/refer
  • Auth
    HTTP bearer

Path parameters

call_idstring required

The identifier for the call provided in the realtime.call.incoming webhook.

Request body

target_uristring required

URI that should appear in the SIP Refer-To header. Supports values like tel:+14155550123 or sip:agent@example.com.

Example request

{
  "target_uri": "tel:+14155550123"
}

Response

Call referred successfully.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status