Conference

Update conference details

Changed on

Update the details of a specific conference.

put/conferences/{id}

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/conferences/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the conference

Request body

namestring

Name of the conference. Omit to leave unchanged.

detailstring

Detail of the conference. Omit to leave unchanged.

dataobject

Custom data associated with the conference. Omit to leave unchanged; send an explicit empty object ({}) to clear all custom data.

timeoutinteger

Auto-termination timeout in seconds. 0 disables auto-termination and is a real, settable value distinct from omission. Omit to leave unchanged.

pre_flow_idstring

Flow to run before participants join. Omit to leave unchanged.

post_flow_idstring

Flow to run after the conference ends. Omit to leave unchanged.

Response

idstring uuid

Unique identifier for the conference.

customer_idstring uuid

Unique identifier of the associated customer. Returned from the GET /customers response.

type'' | 'conference' | 'connect' | 'queue'

Types of conferences.

status'starting' | 'progressing' | 'terminating' | 'terminated'

Status of the conference.

namestring

Name of the conference.

detailstring

Detailed information about the conference.

dataobject

Custom key-value data associated with the conference.

timeoutinteger

Timeout for the conference in seconds.

pre_flow_idstring uuid

The unique identifier of the flow to execute before the conference starts. Returned from the POST /flows or GET /flows response.

post_flow_idstring uuid

The unique identifier of the flow to execute after the conference ends. Returned from the POST /flows or GET /flows response.

conferencecall_idsstring[]

List of associated conference call IDs. Each ID is returned from the GET /conferencecalls response.

recording_idstring uuid

ID of the main recording associated with the conference. Returned from the GET /recordings response.

recording_idsstring[]

List of associated recording IDs. Each ID is returned from the GET /recordings response.

transcribe_idstring uuid

ID of the main transcription associated with the conference. Returned from the GET /transcribes response.

transcribe_idsstring[]

List of associated transcription IDs. Each ID is returned from the GET /transcribes response.

direct_hashstring

The direct hash for direct access via SIP URI sip:<direct_hash>@sip.voipbin.net (the "direct." prefix is already included in the value, e.g. "direct.a1b2c3d4e5f6"). Returned from the resource's direct_hash field.

tm_endstring date-time

Timestamp when the conference ended.

tm_createstring date-time

Timestamp when the conference was created.

tm_updatestring date-time

Timestamp when the conference was last updated.

tm_deletestring date-time

Timestamp when the conference was deleted.

Example response

{
  "id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "conference",
  "status": "progressing",
  "name": "Team Standup",
  "detail": "Daily team standup meeting",
  "timeout": 3600,
  "pre_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "post_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "conferencecall_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  "recording_ids": [
    "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
  ],
  "transcribe_id": "9c0d1e2f-3a4b-5678-1234-567890abcdef",
  "transcribe_ids": [
    "9c0d1e2f-3a4b-5678-1234-567890abcdef"
  ],
  "direct_hash": "direct.a1b2c3d4e5f6",
  "tm_end": "2026-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes

  • ec25eda5db14Revision changes
    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional