Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx Conference Commands API

Conference command operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx Conference Commands API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conference Commands. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 21 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

23 operations 21 paths 39 schemas 4 GET1 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx Conference Commands API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 23

Across 21 paths, the API surfaces 23 operations — 4 GET, 1 PATCH, 18 POST. Each is listed below with its method, path, parameters, and response codes.

Conference Commands 23

Conference command operations

GET
/conferences
List conferences
ListConferences 3 params → 200401422
POST
/conferences
Create conference
CreateConference body → 200401422
GET
/conferences/{conference_id}/participants
List conference participants
ListConferenceParticipants 4 params → 200401404422
GET
/conferences/{id}
Retrieve a conference
RetrieveConference 2 params → 200404
POST
/conferences/{id}/actions/end
End a conference
EndConference 1 param body → 200401404422
POST
/conferences/{id}/actions/gather_using_audio
Gather DTMF using audio prompt in a conference
ConferenceGatherUsingAudio 1 param body → 200401404422
POST
/conferences/{id}/actions/hold
Hold conference participants
HoldConferenceParticipants 1 param body → 200401404422
POST
/conferences/{id}/actions/join
Join a conference
JoinConference 1 param body → 200401422
POST
/conferences/{id}/actions/leave
Leave a conference
LeaveConference 1 param body → 200401422
POST
/conferences/{id}/actions/mute
Mute conference participants
MuteConferenceParticipants 1 param body → 200401404422
POST
/conferences/{id}/actions/play
Play audio to conference participants
PlayConferenceAudio 1 param body → 200401404422
POST
/conferences/{id}/actions/record_pause
Conference recording pause
PauseConferenceRecording 1 param body → 200401404422
POST
/conferences/{id}/actions/record_resume
Conference recording resume
ResumeConferenceRecording 1 param body → 200401404422
POST
/conferences/{id}/actions/record_start
Conference recording start
StartConferenceRecording 1 param body → 200401404422
POST
/conferences/{id}/actions/record_stop
Conference recording stop
StopConferenceRecording 1 param body → 200401404422
POST
/conferences/{id}/actions/send_dtmf
Send DTMF to conference participants
ConferenceSendDTMF 1 param body → 200401404422
POST
/conferences/{id}/actions/speak
Speak text to conference participants
SpeakTextToConference 1 param body → 200401404422
POST
/conferences/{id}/actions/stop
Stop audio being played on the conference
StopConferenceAudio 1 param body → 200401404422
POST
/conferences/{id}/actions/unhold
Unhold conference participants
UnholdConferenceParticipants 1 param body → 200401404422
POST
/conferences/{id}/actions/unmute
Unmute conference participants
UnmuteConferenceParticipants 1 param body → 200401404422
POST
/conferences/{id}/actions/update
Update conference participant
UpdateConference 1 param body → 200401422
GET
/conferences/{id}/participants/{participant_id}
Retrieve a conference participant
RetrieveConferenceParticipant 2 params → 200401404422
PATCH
/conferences/{id}/participants/{participant_id}
Update a conference participant
UpdateConferenceParticipant 2 params body → 200401404422

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ConferenceGatherUsingAudioRequest (16 properties), JoinConferenceRequest (14 properties), Participant (13 properties), ConferenceParticipant (13 properties). Each schema is shown below with its type and property counts.

JoinConferenceRequest
object
14 properties 1 required
UpdateConferenceParticipantRequest
object
3 properties
ResumeConferenceRecordingRequest
object
3 properties
LeaveConferenceRequest
object
4 properties 1 required
UpdateConferenceRequest
object
5 properties 2 required
ConferenceStopRequest
object
2 properties
ConferencePlayRequest
object
5 properties
AzureVoiceSettings
object
6 properties 1 required
InworldVoiceSettings
object
1 property 1 required
ConferenceHoldRequest
object
4 properties
Conference
object
11 properties 5 required
ElevenLabsVoiceSettings
object
2 properties 1 required
AWSVoiceSettings
object
1 property 1 required
MinimaxVoiceSettings
object
5 properties 1 required
ConferenceSendDTMFRequest
object
4 properties 1 required
Loopcount
PauseConferenceRecordingRequest
object
3 properties
call-control_Errors
object
1 property
ConferenceMuteRequest
object
2 properties
EndConferenceRequest
object
1 property
ConferenceGatherUsingAudioRequest
object
16 properties 1 required
ResembleVoiceSettings
object
4 properties 1 required
Participant
object
13 properties 13 required
ConferenceRegion
string
Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).
call-control_Error
object
5 properties 2 required
ConferenceCommandResult
object
1 property 1 required
CreateConferenceRequest
object
12 properties 2 required
TelnyxVoiceSettings
object
2 properties 1 required
StopRecordingConferenceRequest
object
4 properties
ConferenceSpeakRequest
object
8 properties 2 required
ConferenceParticipantResource
object
1 property
PaginationMeta
object
4 properties
ResembleSampleRate
string
Audio sample rate in Hz.
ConferenceUnmuteRequest
object
2 properties
StartConferenceRecordingRequest
object
7 properties 1 required
RimeVoiceSettings
object
2 properties 1 required
ConferenceUnholdRequest
object
2 properties 1 required
XAIVoiceSettings
object
2 properties 1 required
ConferenceParticipant
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-conference-commands-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#Conference Commands
← Back to T APIs
API Details
ID
telnyx:telnyx-conference-commands-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network