Live

Transfer a SIP call to another destination. Supply a nonblank target_uri for the SIP Refer-To header.

post/live/sessions/{session_id}/refer

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/live/sessions/{session_id}/refer
  • Auth
    HTTP bearer

Path parameters

session_idstring required

Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix.

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

Session refer request accepted.

Changes

    • info

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

    • info

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

    • info

      endpoint added