Voice Platform APIRoom Members

Set room member volume

View as Markdown
Adjust how loud a single [room member](/api/room-members) is, addressed by the member's session UUID. Independent of the room playback volume (`POST /rooms/{room_id}/playback/volume`). Member volume uses a coarse 1-9 notch scale (5 = normal/unchanged, 1 = quietest, 9 = loudest) — a different scale from room playback (0-200). `1` is the quietest setting but is NOT silence; to silence a member use the mute command instead. `direction` selects which side of the member's audio to adjust: `out` = how loud this member hears the room; `in` = how loud this member is heard by the room; `both` = apply to both. **Triggered webhooks:** `room.member.volume_changed` `{volume, direction}` (immediate; exactly one event per command, including `direction: both`).

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>`. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session UUID (format {5-char-prefix}-{uuid}).

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]+$"<=128 characters
Optional client-generated key for a mutating endpoint. It identifies one method, route, query, content type, and exact raw body within the authenticated app. Reusing it for a different request returns 422. While its record exists, a retry replays the original accepted response when available. Keys are valid for 1 hour. Allowed characters: letters, digits, dot, hyphen, underscore; max 128 characters. See the Idempotency guide.

Request

This endpoint expects an object.
directionenumRequired

Which side to adjust. out = member hears room; in = member heard by room; both = both.

Allowed values:
volumeintegerRequired1-9

Member volume (1-9). 5 = normal/unchanged, 1 = quietest, 9 = loudest.

operation_uuidstringOptionalformat: "uuid"
Optional caller-supplied per-command correlation id, a bare lowercase RFC-4122 v4 UUID (no prefix). Echoed back as `operation_uuid` in the 202 ack. A later lifecycle webhook carries it only when the gateway can unambiguously associate that event with this command; the field is correlation, not proof of causation. When omitted, the gateway mints one. Not an idempotency key — request deduplication is the `Idempotency-Key` header. Invalid input (not a v4 UUID) is rejected with `400 invalid_request`.

Response

Member volume set
room_idstring
statusenum

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error