Skip to main content
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 Token
  • Content-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.
Member IDs are available only from the conference callbacks. Every operation on this page needs a ConferenceMemberID, and the only place one appears is the ConferenceEnter / ConferenceExit callback delivered to your callbackUrl.The read endpoints do not currently return live member details: GET /Conference/ answers 200 {"conferences": []} while rooms are live, and GET /Conference/{name}/ answers 200 {"error":"failed"} with members present.Capture and store ConferenceMemberID on enter. Member IDs are scoped to a conference session and may be reused after a participant leaves and rejoins.

​
Status codes and response shape

These operations do not return 200. The actual codes: Two things to code against:
  • member_id is always an array, even for a single member. Targeting all echoes back the literal string all rather than expanding to the member list.
  • Repeating an applied control is not an error. Muting an already-muted member answers 202 again, so a 2xx does not prove a state change occurred.
There is no room-wide Play or Speak. POST /Conference/{room}/Play/ and POST /Conference/{room}/Speak/ do not exist - only the per-member routes below. To address a whole room, pass all as the member_id or fan out per member.The error shape distinguishes the two cases: a missing route returns {"message":"Not Found"} from the gateway, while a live route with a bad room returns {"error":"conference not found"}.

​
Control Operations

​
Audio & Text Operations

Audio injected onto a member’s own call leg by a bidirectional <Stream> playAudio event never passes through the conference mixer, so deaf cannot suppress it. See Play Audio.