This resource lets you perform actions on members of a conference. You can control audio states (mute/deaf), remove participants (kick/hang up), and play audio or text to specific members.
Authentication required:
X-Auth-ID - Your account ID (e.g., {auth_id})X-Auth-Token - Your account Auth TokenContent-Type: application/json
Member Targeting
Most member operations support flexible targeting allowing you to act on individual members, multiple members, or all members at once:
Single Member - member_id
Target a specific member by their member_id (e.g., “17”). Only that member is affected.
Multiple Members - comma-separated list
Target multiple specific members by providing a comma-separated list of member IDs.
All Members - "all"
Use the string “all” to target every member in the conference simultaneously.
Note: Member IDs can be retrieved from the conference details when you call the Retrieve a Conference endpoint. Each member has a unique ID within that conference.
Control Operations
| Method | Operation | Description |
|---|
| DELETE | Hang Up a Member | Immediately disconnect a member from the conference. The call is terminated completely. |
| POST | Kick a Member | Disconnect a member but allow XML flow continuation. Member can hear next XML elements after disconnection. |
| POST | Mute a Member | Mute a member’s audio so other participants cannot hear them. Member can still hear the conference. |
| DELETE | Unmute a Member | Unmute a previously muted member allowing them to be heard by other participants again. |
| POST | Deaf a Member | Prevent a member from hearing conference audio. They can still speak but won’t hear others. |
| DELETE | Undeaf a Member | Restore hearing for a deafened member allowing them to hear conference audio again. |
Audio & Text Operations
| Method | Operation | Description |
|---|
| POST | Play Audio to a Member | Play audio files to specific conference members. Useful for announcements or hold music. |
| DELETE | Stop Audio to a Member | Stop ongoing audio playback for specific members. |
| POST | Speak Text to a Member | Convert text to speech and play it to specific conference members using TTS engine. |
| DELETE | Stop Speaking to a Member | Stop ongoing text-to-speech playback for specific members. |
