Create a conference
POST/conferences
Creates a conference on demand from an existing call leg using a call_control_id and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.
Request
- application/json
Body
required
Unique identifier and token for controlling the call
Name of the conference
Possible values: [always
, never
, on_enter
, on_exit
]
Default value: never
Whether a beep sound should be played to existing participants when another participant joins and/or leaves the conference. Defaults to "never".
Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
Default value: true
Toggle background comfort noise.
Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".
Time length (minutes) after which the conference will end.
The URL to an audio file to be played to participants joining the conference. Takes effect only when "start_conference_on_create" is set to "false".
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".
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
Unique identifier of the conference
Name of the conference
ISO 8601 formatted date of when the conference was created
ISO 8601 formatted date of when the conference will expire
{
"data": {
"id": "string",
"name": "string",
"created_at": "string",
"expires_at": "string"
}
}
401: Unauthorized
422: Unprocessable entity. Can be caused by improper use of filters or nodes.