Sign in
Rooms

Add or move a leg to a room

Add a leg to a room (auto-creates room if it doesn't exist). If the leg is already in a different room, it is atomically moved to the target room. A ringing inbound SIP leg is automatically answered before being added — in this case the response status is adding and the actual room join happens asynchronously, observable via leg.joined_room. Auto-answer failures surface as leg.command_failed with command="add_to_room". Only the leg's primary audio stream joins by default; streams additionally mixes named secondary streams of the same leg into this room. A stream currently mixed elsewhere is moved here.

post/rooms/{id}/legs

Request body

leg_idstring required

ID of the leg to add

muteboolean

If set, apply this mute state to the leg atomically before it joins the mixer (no race where un-muted audio enters the mix). Omit to leave current state untouched (useful when moving between rooms).

deafboolean

If set, apply this deaf state to the leg atomically before it joins the mixer. Omit to leave current state untouched.

accept_dtmfboolean

If set, control whether this leg receives DTMF digits broadcast from other legs in the same room. Omit to leave current state untouched (default for new legs is true).

rolestring

If set, apply this routing role to the leg atomically before it joins the mixer. The room's routing matrix (see PUT /v1/rooms/{id}/routing) decides which other legs this leg hears and is heard by based on roles. Pass "" to clear the role (full mesh). Omit to leave the current role untouched.

Response

Leg added or moved

instance_idstring

Instance identifier

statusstring required

Changes

Changed in 5 of the 67 revisions of this API.45

  • 9b0a18aea1e21See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 98f1f6130e2c1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • b84db4b78d2c1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 14c046f7ad732See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • d09c97c6ca8c4See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog