Reject call | OpenAI API (unofficial showcase)

1 parameter · 1 body field

call_idstringrequired

The identifier for the call provided in the [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook.

Provide an optional SIP status code. When omitted the API responds with 603 Decline.

status_codeintegeroptional

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

4 status codes

200Call rejected successfully.

404The session or call was not found or is unavailable for this operation.

errorobjectrequired

409The session or call can no longer accept this operation.

errorobjectrequired

500An internal error occurred. The response body is plain text.

Error handling

A 404 is returned: The session or call was not found or is unavailable for this operation. A 409 is returned: The session or call can no longer accept this operation. A 500 is returned: An internal error occurred. The response body is plain text.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.reject.create({
  callId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  statusCode: 20,
});

{
  "error": {
    "code": "123456",
    "message": "This is an example message.",
    "param": "example_value",
    "type": "standard",
    "misalignment": {
      "review_target": "example_value",
      "error_type": "example_value",
      "detailed_explanation": "example_value",
      "steer": {
        "message": "This is an example message."
      }
    }
  }
}

Request

Response

Errors