Realtime

Reject call

Changed on

Decline an incoming SIP call by returning a SIP status code to the caller.

post/realtime/calls/{call_id}/reject

Request

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

Path parameters

call_idstring required

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

Request body

status_codeinteger

SIP response code to send back to the caller. Defaults to 603 (Decline) when omitted.

Example request

{
  "status_code": 486
}

Response

Call rejected successfully.

Changes

  • e2f8d8cbc41fRevision changes
    • info

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

    • 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

    • info

      added the non-success response with the status