Conference

Query conference room's status

Query conference room's status by it's unique ID.

get/conference_rooms/{id}/status

Request

Base URL
https://HOSTNAME:8887/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/conference_rooms/:id/status/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the conference room.

status'ONLINE' | 'OFFLINE' | 'ON_CALL'

The conference room status. Can be either:

lockedboolean

Whether the conference room was locked.

mutedboolean

Whether the conference room was muted.

recordingboolean

Whether the conference room is recording.

No recorded changes to this operation across all 1 revision of this API.