Join a conference

POST

/conferences/{id}/actions/join

Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the call_control_id of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the max_participants parameter in conference creation request.

Expected Webhooks (see callback schema below):

conference.participant.joined

conference.participant.left

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/conferences//actions/join' \
--header 'Content-Type: application/json' \
--data-raw '{
    "beep_enabled": "always",
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
    "end_conference_on_exit": true,
    "hold": true,
    "hold_audio_url": "http://www.example.com/audio.wav",
    "mute": true,
    "start_conference_on_enter": true,
    "supervisor_role": "whisper",
    "whisper_call_control_ids": [
        "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
        "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
    ]
}'

Response Example

{
    "data": {
        "result": "ok"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful response upon making a conference command.

Body

🟠401Unauthorized

🟠422Parameter Error

Modified at 2025-06-16 19:14:41

Hold conference participants

Leave a conference