Telnyx · Schema

Create Conference Participant Request

CommunicationsCPaaSVoiceSMSIoTTelecommunicationsMessagingArtificial IntelligenceMCPVoice AIPhone NumbersInferenceNumber VerificationPhone VerificationOTP2FALookupVerifyNumber LookupCNAMIdentityFraud Prevention

Properties

Name Type Description
AmdStatusCallback string The URL the result of answering machine detection will be sent to.
AmdStatusCallbackMethod string HTTP request type used for `AmdStatusCallback`. Defaults to `POST`.
ApplicationSid string The SID of the TeXML application that will handle the new participant's call. Required unless joining an existing conference by its ConferenceSid.
Beep string Whether to play a notification beep to the conference when the participant enters and exits.
CallSidToCoach string The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
CallerId string To be used as the caller id name (SIP From Display Name) presented to the destination (`To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `
CancelPlaybackOnDetectMessageEnd boolean Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`.
CancelPlaybackOnMachineDetection boolean Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
Coaching boolean Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.
ConferenceRecord string Whether to record the conference the participant is joining. Defualts to `do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively
ConferenceRecordingStatusCallback string The URL the conference recording callbacks will be sent to.
ConferenceRecordingStatusCallbackEvent string The changes to the conference recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaul
ConferenceRecordingStatusCallbackMethod string HTTP request type used for `ConferenceRecordingStatusCallback`. Defaults to `POST`.
ConferenceRecordingTimeout integer The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to det
ConferenceStatusCallback string The URL the conference callbacks will be sent to.
ConferenceStatusCallbackEvent string The changes to the conference's state that should generate a call to `ConferenceStatusCallback`. Can be: `start`, `end`, `join` and `leave`. Separate multiple values with a space. By default no callba
ConferenceStatusCallbackMethod string HTTP request type used for `ConferenceStatusCallback`. Defaults to `POST`.
ConferenceTrim string Whether to trim any leading and trailing silence from the conference recording. Defaults to `trim-silence`.
CustomHeaders array Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.
EarlyMedia boolean Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to `false`.
EndConferenceOnExit boolean Whether to end the conference when the participant leaves. Defaults to `false`.
From string The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code.
Label string A unique label for the participant that will be added to the conference. The label can be used to reference the participant for updates via the TeXML REST API.
MachineDetection string Whether to detect if a human or an answering machine picked up the call. Use `Enable` if you would like to ne notified as soon as the called party is identified. Use `DetectMessageEnd`, if you would l
MachineDetectionSilenceTimeout integer If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used.
MachineDetectionSpeechEndThreshold integer Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used.
MachineDetectionSpeechThreshold integer Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used.
MachineDetectionTimeout integer How long answering machine detection should go on for before sending an `Unknown` result. Given in milliseconds.
MaxParticipants integer The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250.
Muted boolean Whether the participant should be muted.
PreferredCodecs string The list of comma-separated codecs to be offered on a call.
Record boolean Whether to record the entire participant's call leg. Defaults to `false`.
RecordingChannels string The number of channels in the final recording. Defaults to `mono`.
RecordingStatusCallback string The URL the recording callbacks will be sent to.
RecordingStatusCallbackEvent string The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `comp
RecordingStatusCallbackMethod string HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
RecordingTrack string The audio track to record for the call. The default is `both`.
SipAuthPassword string The password to use for SIP authentication.
SipAuthUsername string The username to use for SIP authentication.
StartConferenceOnEnter boolean Whether to start the conference when the participant enters. Defaults to `true`.
StatusCallback string URL destination for Telnyx to send status callback events to for the call.
StatusCallbackEvent string The changes to the call's state that should generate a call to `StatusCallback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value i
StatusCallbackMethod string HTTP request type used for `StatusCallback`.
TimeLimit integer The maximum duration of the call in seconds.
Timeout integer The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30.
To string The phone number of the called party. Phone numbers are formatted with a `+` and country code.
Trim string Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`.
WaitUrl string The URL to call for an audio file to play while the participant is waiting for the conference to start.
View JSON Schema on GitHub

JSON Schema

telnyx-dial-conference-participant-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-dial-conference-participant-request-schema.json",
  "title": "Create Conference Participant Request",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-texml-rest-commands-api-openapi.yml#/components/schemas/DialConferenceParticipantRequest",
  "properties": {
    "AmdStatusCallback": {
      "description": "The URL the result of answering machine detection will be sent to.",
      "type": "string"
    },
    "AmdStatusCallbackMethod": {
      "description": "HTTP request type used for `AmdStatusCallback`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "ApplicationSid": {
      "description": "The SID of the TeXML application that will handle the new participant's call. Required unless joining an existing conference by its ConferenceSid.",
      "type": "string"
    },
    "Beep": {
      "description": "Whether to play a notification beep to the conference when the participant enters and exits.",
      "enum": [
        "true",
        "false",
        "onEnter",
        "onExit"
      ],
      "type": "string"
    },
    "CallSidToCoach": {
      "description": "The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.",
      "type": "string"
    },
    "CallerId": {
      "description": "To be used as the caller id name (SIP From Display Name) presented to the destination (`To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If ommited, the display name will be the same as the number in the `From` field.",
      "type": "string"
    },
    "CancelPlaybackOnDetectMessageEnd": {
      "default": true,
      "description": "Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`.",
      "type": "boolean"
    },
    "CancelPlaybackOnMachineDetection": {
      "default": true,
      "description": "Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.",
      "type": "boolean"
    },
    "Coaching": {
      "description": "Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.",
      "type": "boolean"
    },
    "ConferenceRecord": {
      "description": "Whether to record the conference the participant is joining. Defualts to `do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively.",
      "enum": [
        "true",
        "false",
        "record-from-start",
        "do-not-record"
      ],
      "type": "string"
    },
    "ConferenceRecordingStatusCallback": {
      "description": "The URL the conference recording callbacks will be sent to.",
      "type": "string"
    },
    "ConferenceRecordingStatusCallbackEvent": {
      "description": "The changes to the conference recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. `failed` and `absent` are synonymous.",
      "type": "string"
    },
    "ConferenceRecordingStatusCallbackMethod": {
      "description": "HTTP request type used for `ConferenceRecordingStatusCallback`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "ConferenceRecordingTimeout": {
      "default": 0,
      "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)",
      "type": "integer"
    },
    "ConferenceStatusCallback": {
      "description": "The URL the conference callbacks will be sent to.",
      "type": "string"
    },
    "ConferenceStatusCallbackEvent": {
      "description": "The changes to the conference's state that should generate a call to `ConferenceStatusCallback`. Can be: `start`, `end`, `join` and `leave`. Separate multiple values with a space. By default no callbacks are sent.",
      "type": "string"
    },
    "ConferenceStatusCallbackMethod": {
      "description": "HTTP request type used for `ConferenceStatusCallback`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "ConferenceTrim": {
      "description": "Whether to trim any leading and trailing silence from the conference recording. Defaults to `trim-silence`.",
      "enum": [
        "trim-silence",
        "do-not-trim"
      ],
      "type": "string"
    },
    "CustomHeaders": {
      "description": "Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the custom header",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom header",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "EarlyMedia": {
      "default": false,
      "description": "Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to `false`.",
      "type": "boolean"
    },
    "EndConferenceOnExit": {
      "description": "Whether to end the conference when the participant leaves. Defaults to `false`.",
      "type": "boolean"
    },
    "From": {
      "description": "The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code.",
      "type": "string"
    },
    "Label": {
      "description": "A unique label for the participant that will be added to the conference. The label can be used to reference the participant for updates via the TeXML REST API.",
      "type": "string"
    },
    "MachineDetection": {
      "description": "Whether to detect if a human or an answering machine picked up the call. Use `Enable` if you would like to ne notified as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine.",
      "enum": [
        "Enable",
        "DetectMessageEnd"
      ],
      "type": "string"
    },
    "MachineDetectionSilenceTimeout": {
      "default": 3500,
      "description": "If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionSpeechEndThreshold": {
      "default": 800,
      "description": "Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionSpeechThreshold": {
      "default": 3500,
      "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionTimeout": {
      "description": "How long answering machine detection should go on for before sending an `Unknown` result. Given in milliseconds.",
      "type": "integer"
    },
    "MaxParticipants": {
      "description": "The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250.",
      "type": "integer"
    },
    "Muted": {
      "description": "Whether the participant should be muted.",
      "type": "boolean"
    },
    "PreferredCodecs": {
      "description": "The list of comma-separated codecs to be offered on a call.",
      "type": "string"
    },
    "Record": {
      "description": "Whether to record the entire participant's call leg. Defaults to `false`.",
      "type": "boolean"
    },
    "RecordingChannels": {
      "description": "The number of channels in the final recording. Defaults to `mono`.",
      "enum": [
        "mono",
        "dual"
      ],
      "type": "string"
    },
    "RecordingStatusCallback": {
      "description": "The URL the recording callbacks will be sent to.",
      "type": "string"
    },
    "RecordingStatusCallbackEvent": {
      "description": "The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.",
      "type": "string"
    },
    "RecordingStatusCallbackMethod": {
      "description": "HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "RecordingTrack": {
      "description": "The audio track to record for the call. The default is `both`.",
      "enum": [
        "inbound",
        "outbound",
        "both"
      ],
      "type": "string"
    },
    "SipAuthPassword": {
      "description": "The password to use for SIP authentication.",
      "type": "string"
    },
    "SipAuthUsername": {
      "description": "The username to use for SIP authentication.",
      "type": "string"
    },
    "StartConferenceOnEnter": {
      "description": "Whether to start the conference when the participant enters. Defaults to `true`.",
      "type": "boolean"
    },
    "StatusCallback": {
      "description": "URL destination for Telnyx to send status callback events to for the call.",
      "type": "string"
    },
    "StatusCallbackEvent": {
      "description": "The changes to the call's state that should generate a call to `StatusCallback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.",
      "type": "string"
    },
    "StatusCallbackMethod": {
      "description": "HTTP request type used for `StatusCallback`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "TimeLimit": {
      "description": "The maximum duration of the call in seconds.",
      "type": "integer"
    },
    "Timeout": {
      "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30.",
      "type": "integer",
      "x-stainless-param": "timeout_seconds"
    },
    "To": {
      "description": "The phone number of the called party. Phone numbers are formatted with a `+` and country code.",
      "type": "string"
    },
    "Trim": {
      "description": "Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`.",
      "enum": [
        "trim-silence",
        "do-not-trim"
      ],
      "type": "string"
    },
    "WaitUrl": {
      "description": "The URL to call for an audio file to play while the participant is waiting for the conference to start.",
      "type": "string"
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/telnyx-dial-conference-participant-request"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.