Create Conference Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-create-conference-request-schema.json",
  "title": "Create Conference Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-conference-commands-api-openapi.yml#/components/schemas/CreateConferenceRequest",
  "properties": {
    "beep_enabled": {
      "default": "never",
      "description": "Whether a beep sound should be played when participants join and/or leave the conference.",
      "enum": [
        "always",
        "never",
        "on_enter",
        "on_exit"
      ],
      "type": "string"
    },
    "call_control_id": {
      "description": "Unique identifier and token for controlling the call",
      "type": "string"
    },
    "client_state": {
      "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference.",
      "type": "string"
    },
    "comfort_noise": {
      "default": true,
      "description": "Toggle background comfort noise.",
      "type": "boolean"
    },
    "command_id": {
      "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.",
      "type": "string"
    },
    "duration_minutes": {
      "description": "Time length (minutes) after which the conference will end.",
      "type": "integer"
    },
    "hold_audio_url": {
      "description": "The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\".",
      "type": "string"
    },
    "hold_media_name": {
      "description": "The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\".",
      "type": "string"
    },
    "max_participants": {
      "description": "The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250",
      "type": "integer"
    },
    "name": {
      "description": "Name of the conference",
      "type": "string"
    },
    "region": {
      "description": "Sets the region where the conference data will be hosted. Defaults to the region defined in user's data locality settings (Europe or US).",
      "enum": [
        "Australia",
        "Europe",
        "Middle East",
        "US"
      ],
      "type": "string"
    },
    "start_conference_on_create": {
      "description": "Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to \"true\".",
      "type": "boolean"
    }
  },
  "required": [
    "call_control_id",
    "name"
  ],
  "type": "object"
}