Hang up a Live session | OpenAI API (unofficial showcase)

1 parameter

session_idstringrequired

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

2 status codes

200Returns confirmation that the session hangup request was accepted.

404Returned when the session or call was not found or is unavailable for this operation.

errorobjectrequired

Error handling

A 404 is returned when the session or call cannot be found or is unavailable for this operation. The session_id path parameter must be the unchanged opaque identifier from the session creation response or incoming-call webhook.

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({ sessionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

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