Update Conference

PATCH

https://api.pinnacle.sh/conferences/:id

PATCH

/conferences/:id

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.conferences.update("id", {});
}
main();

{
  "id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
  "label": "escalation-4412",
  "status": "waiting",
  "participant_count": 1,
  "max_participants": 1,
  "hold_audio_url": "string",
  "speaking_events": true,
  "metadata": {},
  "created_at": "2024-01-15T09:30:00Z",
  "started_at": "2024-01-15T09:30:00Z",
  "ended_at": "2024-01-15T09:30:00Z",
  "ended_reason": "empty",
  "participants": [
    {
      "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
      "conference_id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
      "label": "supervisor",
      "status": "dialing",
      "from": "+14155559876",
      "to": "+14155551234",
      "muted": true,
      "on_hold": true,
      "whisper_to": [
        "string"
      ],
      "end_conference_on_leave": true,
      "joined_at": "2024-01-15T09:30:00Z",
      "left_at": "2024-01-15T09:30:00Z",
      "left_reason": "hangup"
    }
  ]
}

Change the label, metadata, or hold audio. Only the fields you send change.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Request

This endpoint expects an object.

labelstring or nullOptional

hold_audio_urlstring or nullOptionalformat: "uri"

speaking_eventsbooleanOptional

metadatamap from strings to stringsOptional

Response

Updated conference.

idstring

labelstring or null

statusenum

waiting: Created, but nobody has joined yet.
active: At least one participant has joined.
ended: Over. Every participant’s call has been hung up.

Allowed values:

participant_countinteger

Participants currently joined.

max_participantsinteger2-50

hold_audio_urlstring or null

What participants on hold hear.

speaking_eventsboolean

Whether participant.speaking events are sent when the active speaker changes.

metadatamap from strings to strings

created_atstringformat: "date-time"

started_atstring or nullformat: "date-time"

ended_atstring or nullformat: "date-time"

ended_reasonenum or null

Why a conference ended. A conference never ends just because one person is left.

empty: The last participant left.
ended_by_api: Ended with DELETE /conferences/{id} or the conference.end command.
participant_ended_it: A participant added with end_conference_on_leave: true left.
time_limit: Reached the 4-hour limit.
expired_waiting: Nobody joined in time.
failed: The conference couldn’t be started.

participantslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error