Set room playback volume

View as Markdown
Adjust room playback volume on a 0-200 scale: 100 = normal/unchanged (default), 0 = mute, values above 100 boost up to a maximum of 200. This is relative gain, not target loudness — 100 leaves the file as recorded (a quiet file at 100 stays quiet); there is no automatic loudness matching across files. **Triggered webhooks:** `command.room.playback.volume.accepted` (immediate)

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

room_idstringRequired

Room ID (format {prefix}-room-{uuid}). The UUID portion is lowercase hexadecimal — uppercase hex is rejected with 400.

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.
volumeintegerRequired0-200

Playback volume (0-200). 100 = normal/unchanged, 0 = mute, above 100 boosts up to 200.

Response

Room playback command accepted for asynchronous execution
operation_uuidstringformat: "uuid"
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
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error