Modeller¶

Alle API-responser bruger snake_case JSON (som i OpenAPI-kontrakten). Timestamps er typisk ISO 8601 datetime-strenge. UUID'er returneres som strenge.

Model-oversigt¶

Model	Beskrivelse	Endpoints
live-conference	Aktiv konference med deltagere	GET `/apikey/status/v1/conference/...`
live-participant	Deltager i live konference	Indlejret i live-conference
live-media-stream	Mediestrøm (kvalitet, codecs)	Indlejret i live-participant
historic-conference	Afsluttet konference med mødekontekst	GET `/apikey/history/v1/conference/...`
additional_info_type	Nøgle/værdi-par	Indlejret i historic-conference
basicError / detailedError	Fejlrespons	400, 401, 403, 404, 501

Felt-konventioner¶

Type	Format	Eksempel
string	UTF-8 tekst	`"meet.alice"`
uuid	UUID-streng	`"8583f400-7886-48c9-874b-5fefc2ac097e"`
datetime	ISO 8601	`"2020-05-21T17:32:28.556929"`
integer	Heltal	`579`
boolean	`true` / `false`	`"is_locked": false`

Live-status timestamps (start_time, connect_time m.fl.) kan være uden timezone-offset — behand dem som server-lokale tidspunkter medmindre andet er dokumenteret for miljøet.

live-conference¶

Aktiv konference returneret af live-status endpoints.

Felter¶

Felt	Type	Beskrivelse
`id`	string	Konference-ID
`group_id`	integer	VDX gruppe-ID
`group_name`	string	Gruppenavn
`organisation_name`	string	Organisationsnavn
`name`	string	Konferencenavn / URI
`start_time`	string	Starttidspunkt
`is_locked`	boolean	Konference låst
`is_started`	boolean	Konference startet
`is_encrypted`	boolean	Kryptering aktiv
`service_type`	string	Konferencetype (fx `conference`)
`participant_count`	integer	Antal deltagere
`overall_quality`	string	Samlet kvalitetsvurdering
`overall_quality_percent`	number	Kvalitet i procent
`overall_quality_count`	integer[]	Kvalitetsfordeling
`aliases`	string[]	Aliases for konferencen
`participants_data`	array	Array af live-participant

JSON-eksempel¶

{
  "id": "abc123",
  "group_id": 12345,
  "group_name": "Eksempel Kommune",
  "organisation_name": "Eksempel Kommune",
  "name": "123456@video.domain",
  "start_time": "2026-06-28T10:00:00",
  "is_locked": false,
  "is_started": true,
  "is_encrypted": true,
  "service_type": "conference",
  "participant_count": 2,
  "overall_quality": "good",
  "overall_quality_percent": 95.5,
  "aliases": ["123456@video.domain"],
  "participants_data": []
}

live-participant¶

Deltager i en aktiv konference. Indlejret i participants_data på live-conference.

Felter (udvalgte)¶

Felt	Type	Beskrivelse
`id`	string	Deltager-ID
`display_name`	string	Vist navn
`participant_alias`	string	Deltager-alias
`call_direction`	string	Opkaldets retning
`call_quality`	string	Opkaldskvalitet
`connect_time`	string	Tilslutningstidspunkt
`is_muted`	boolean	Mikrofon slået fra
`is_presenting`	boolean	Præsenterer indhold
`protocol`	string	Protokol (fx SIP, WebRTC)
`vendor`	string	Klient/leverandør
`role`	string	Rolle i konferencen
`bandwidth`	integer	Båndbredde
`media_streams`	array	Array af live-media-stream

live-media-stream¶

Mediestrøm for en deltager — bruges til kvalitetsmonitorering.

Felter (udvalgte)¶

Felt	Type	Beskrivelse
`id`	string	Strøm-ID
`type`	string	Strømtype (fx video, audio)
`rx_codec` / `tx_codec`	string	Modtaget/sendt codec
`rx_bitrate`	integer	Modtaget bitrate
`rx_fps` / `tx_fps`	number	Frames per sekund
`rx_jitter` / `tx_jitter`	number	Jitter
`rx_packets_lost`	number	Tabte pakker (modtaget)
`rx_resolution`	string	Opløsning
`start_time`	string	Strøm starttidspunkt

historic-conference¶

Afsluttet konference returneret af historik-endpoints. Indeholder både Pexip-konferencedata og VDX mødekontekst.

Felter (udvalgte)¶

Felt	Type	Beskrivelse
`conferenceId`	uuid	Konference-ID (Pexip)
`group_id`	integer	VDX gruppe-ID
`group_name`	string	Gruppenavn
`name`	string	Konferencenavn
`start_time`	datetime	Konferencestart (påkrævet)
`end_time`	datetime	Konferenceslut
`duration`	integer	Varighed i sekunder
`participant_count`	integer	Antal deltagere
`service_type`	string	Konferencetype
`overall_quality`	string	Samlet kvalitet
`overall_quality_percent`	number	Kvalitet i procent
`local_alias`	string	Lokal alias
`remote_alias`	string	Fjern alias
`meetingid`	uuid	VDX møde-UUID
`meeting_start_time`	datetime	VDX møde start
`meeting_end_time`	datetime	VDX møde slut
`meeting_uri_with_domain`	string	Møde-URI med domæne
`meeting_created_by_name`	string	Oprettet af
`meeting_organized_by_name`	string	Arrangeret af
`meeting_project_code`	string	Projektreference
`meeting_external_id`	string	Eksternt ID fra booking-system
`additional_info`	array	additional_info_type

JSON-eksempel¶

{
  "conferenceId": "8583f400-7886-48c9-874b-5fefc2ac097e",
  "group_id": 12345,
  "group_name": "Eksempel Kommune",
  "name": "123456@video.domain",
  "start_time": "2026-06-28T10:00:00",
  "end_time": "2026-06-28T10:30:00",
  "duration": 1800,
  "participant_count": 3,
  "service_type": "conference",
  "overall_quality": "good",
  "overall_quality_percent": 92.0,
  "meetingid": "46b46a1e-a4d3-4387-87ee-a67dcaa222cb",
  "meeting_uri_with_domain": "123456@video.domain",
  "meeting_created_by_name": "laege@eksempel.dk",
  "meeting_organized_by_name": "laege@eksempel.dk",
  "meeting_project_code": "PROJ001",
  "additional_info": []
}

additional_info_type¶

Nøgle/værdi-par knyttet til historisk konference.

Felt	Type	Beskrivelse
`key`	string	Nøgle
`value`	string	Værdi

basicError¶

Standard fejlrespons.

Felt	Type	Beskrivelse
`timestamp`	datetime	Fejltidspunkt
`status`	integer	HTTP-statuskode
`error`	string	Fejlbesked
`path`	string	Request path

detailedError¶

Udvidet fejlrespons (arver basicError).

Felt	Type	Beskrivelse
`detailed_error`	string	Detaljeret fejlbeskrivelse
`detailed_error_code`	string	Fejlkode (`10`, `20`)

Se også¶

Ændringshistorik¶

Dato	Ændring
2026-06-27	Første model-reference for VDX Pexip History Service