Hang up call | OpenAI API (unofficial showcase)

1 parameter

call_idstringrequired

The identifier for the call. For SIP calls, use the value provided in the [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook. For WebRTC sessions, reuse the call ID returned in the `Location` header when creating the call with [`POST /v1/realtime/calls`](https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create).

2 status codes

200Call hangup initiated successfully.

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

errorobjectrequired

Error handling

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

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.hangup.create({ callId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "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