Data Models

The MaxConf API uses Pydantic models for request/response validation. Two primary response shapes exist depending on whether constrained_attributes is true or false.

ConstrainedConference

The default response model when constrained_attributes=true. Returns only the fields necessary for a consumer to connect a citizen to a video session.

{
  "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": ""
    }
  ]
}

Field reference

Field	Type	Description
`id`	integer	Pexip internal conference ID
`name`	string	VMR name (Base64-encoded, used as the room alias)
`service_type`	string	Always `"conference"` for VMRs
`allow_guests`	boolean	Whether guest access is enabled (always `true`)
`pin`	string	Host PIN - excluded from POST `/room/create` responses
`guest_pin`	string	Guest PIN for citizen access
`tag`	string	Service tag URL linking the room to the IAS session
`aliases`	array	List of Alias objects for this conference

Conference

The full Pexip conference object returned when constrained_attributes=false. Contains all configurable properties of a Virtual Meeting Room as defined in the Pexip Management API.

Key fields

Field	Type	Description
`id`	integer	Pexip internal conference ID
`name`	string	VMR name
`service_type`	string	Conference type (`conference`, `lecture`, etc.)
`allow_guests`	boolean	Guest access enabled
`pin`	string	Host PIN
`guest_pin`	string	Guest PIN
`tag`	string	Service tag URL
`aliases`	array	List of Alias objects
`automatic_participants`	array	Auto-dial participants (SIP endpoints)
`call_type`	string	Call type (audio/video)
`creation_time`	datetime	When the VMR was created
`crypto_mode`	string	Media encryption mode
`description`	string	Human-readable description
`guest_view`	string	Guest layout mode
`host_view`	string	Host layout mode
`max_callrate_in`	integer	Maximum inbound call rate (kbps)
`max_callrate_out`	integer	Maximum outbound call rate (kbps)
`mute_all_guests`	boolean	Auto-mute guests on join
`participant_limit`	integer	Maximum simultaneous participants
`resource_uri`	string	Pexip Management API resource URI

All fields are optional (nullable) in the response since they depend on the VMR’s configuration.

Alias

Represents a dial alias for a conference room.

Field	Type	Description
`id`	integer	Alias ID
`alias`	string	The dialable alias (same as VMR `name` for MaxConf rooms)
`conference`	string	Resource URI of the parent conference
`creation_time`	datetime	When the alias was created
`description`	string	Optional description

Health status

Returned by GET /public/health:

{
  "status": "alive",
  "timestamp": "2024-03-05T14:31:06.145782"
}

Field	Type	Description
`status`	string	Service status (always `"alive"` if reachable)
`timestamp`	string	ISO 8601 timestamp of the response

Relationship to OpenAPI spec

These models are defined in Python using Pydantic and automatically generate the OpenAPI schema served at /docs (locally) and published as /openapi-spec.json. The OpenAPI spec is the canonical machine-readable reference; this page provides human-readable context and explains the design decisions behind the model constraints.