Endpoints
The MaxConf API exposes two groups of endpoints:
- Room Operations - authenticated via OAuth2.0 Bearer token (private, consumed by IDIM/BCSC)
- Public - alternative auth (Genesys token or HTTP Basic), consumed by the Agent App widget and Pexip event hooks
Room Operations (Private)
Section titled “Room Operations (Private)”These endpoints require an OAuth2.0 Bearer token in the Authorization header. See Authentication for how to obtain a token.
Create a Virtual Meeting Room
Section titled “Create a Virtual Meeting Room”Response - 200 Success
Section titled “Response - 200 Success”{ "id": 90, "name": "MTIzNDU2LDc2NTQzMg", "service_type": "conference", "allow_guests": true, "guest_pin": "1231", "tag": "https://id.gov.bc.ca/idcheck/protected/video/MTIzNDU2LDc2NTQzMg", "aliases": [ { "id": 85, "alias": "MTIzNDU2LDc2NTQzMg", "conference": "/api/admin/configuration/v1/conference/90/", "creation_time": "2024-03-05T14:31:06.145782", "description": "" } ]}Get Room Details
Section titled “Get Room Details”Response - 200 Success
Section titled “Response - 200 Success”Returns a ConstrainedConference or full Conference object depending on constrained_attributes.
Update a Virtual Meeting Room
Section titled “Update a Virtual Meeting Room”Response - 202 Accepted
Section titled “Response - 202 Accepted”No response body. The room has been updated on the Pexip management node.
Delete a Virtual Meeting Room
Section titled “Delete a Virtual Meeting Room”Response - 204 No Content
Section titled “Response - 204 No Content”The VMR has been deleted from the Pexip management node.
List All Virtual Meeting Rooms
Section titled “List All Virtual Meeting Rooms”Response - 200 Success
Section titled “Response - 200 Success”Returns an array of ConstrainedConference or Conference objects.
Bulk Create Virtual Meeting Rooms
Section titled “Bulk Create Virtual Meeting Rooms”Response - 202 Accepted
Section titled “Response - 202 Accepted”Rooms are created asynchronously in the background.
Bulk Delete Virtual Meeting Rooms
Section titled “Bulk Delete Virtual Meeting Rooms”Response - 204 No Content
Section titled “Response - 204 No Content”All matching rooms deleted and queue cleared.
Public Endpoints
Section titled “Public Endpoints”These endpoints use alternative authentication and are consumed by the Genesys Cloud Agent App widget and Pexip event hooks.
Get Room (Public)
Section titled “Get Room (Public)”Authentication: The x-auth-token is validated against the Genesys Cloud API (api.cac1.pure.cloud/api/v2/users/me). The token must belong to a user in an authorized SBC division.
Response - 200 Success
Section titled “Response - 200 Success”Same response shape as the private GET /room/{room_name}.
Event Sink
Section titled “Event Sink”Sample event payload
Section titled “Sample event payload”{ "event": "conference_ended", "data": { "name": "MTIzNDU2LDc2NTQzMg", "conference": "MTIzNDU2LDc2NTQzMg" }}Response - 204 No Content
Section titled “Response - 204 No Content”Event acknowledged and processed.
Health Check
Section titled “Health Check”Response - 200 Success
Section titled “Response - 200 Success”{ "status": "alive", "timestamp": "2024-03-05T14:31:06.145782"}Background processes
Section titled “Background processes”The Function App also runs two timer-triggered functions (not HTTP-callable):
| Timer | Schedule | Purpose |
|---|---|---|
| Garbage Collection | Every 10 minutes | Processes the room-deletion-queue - deletes VMRs whose queue messages are >10 minutes old |
| Log Metrics | Every 5 minutes | Collects queue depth, VMR count, Pexip alarms, and writes to Log Analytics |