Reject call | OpenAI API (unofficial showcase)

1 parameter · 1 body field

session_idstringrequired

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

status_codeintegerrequired

SIP rejection status sent to the caller. This field is required.

5 status codes

200Session reject request accepted.

400Invalid request body or headers.

errorobjectrequired

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 400 is returned: Invalid request body or headers. 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({
  sessionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  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