Vorbal API Documentation

Return the canonical room resource.

Authentication

AuthorizationBearer

Application auth. Send Authorization: Bearer <app_uuid>:<api_key> using any active key in the app’s collection. See Authentication for details.

Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>` using any active key in the app's collection. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

room_idstringRequired

Case-sensitive room identifier.

Response

Room status

created_atdatetime

member_countinteger

Current number of members in the room.

playback_operation_uuidstring

playback_statusenum

playback_urlslist of strings

playback_volumeinteger0-200Defaults to 0

Current room playback volume (0-200). A newly created room reports 0 until a room playback volume command sets an explicit value.

room_idstring

voice_activity_eventsboolean

Whether member voice activity webhooks are enabled for this room.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"member_count": 1,
4	"playback_operation_uuid": "string",
5	"playback_status": "stopped",
6	"playback_urls": [
7	"string"
8	],
9	"playback_volume": 0,
10	"room_id": "string",
11	"voice_activity_events": true
12	}