Video conferencing

Meeting rooms and their recordings.

GET/meeting-roomsList meeting rooms
POST/meeting-roomsCreate a meeting room
PATCH/meeting-rooms/{room_id}Change a meeting room
DELETE/meeting-rooms/{room_id}Delete a meeting room
POST/meeting-rooms/{room_id}/startStart a meeting
GET/meeting-rooms/{room_id}/recordingsList recordings
DELETE/meeting-rooms/{room_id}/recordings/{record_id}Delete a recording
GET/meeting-plansVideo conference plans

List meeting rooms

GET/meeting-rooms

Needs the permission meeting:read

Response 200

`available`required	boolean
`reachable`	boolean	default true
`rooms`required	object[]
`id`required	string (uuid)
`name`required	string
`lobby`required	boolean
`guest_url`required	string
`usable`	boolean	default true
`running`	boolean	default false
`participants`	integer	default 0
`recording`	boolean	default false
`created_at`required	string (date-time)
`room_limit`required	integer
`participant_limit`required	integer
`can_manage`required	boolean

curl "https://portal.nimag.net/api/v1/meeting-rooms" \
  -H "Authorization: Bearer nck_…"

{
  "available": true,
  "reachable": true,
  "rooms": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "lobby": true,
      "guest_url": "string",
      "usable": true,
      "running": false,
      "participants": 0,
      "recording": false,
      "created_at": "2026-01-31T12:00:00Z"
    }
  ],
  "room_limit": 0,
  "participant_limit": 0,
  "can_manage": true
}

Create a meeting room

POST/meeting-rooms

Needs the permission meeting:manage

Body (JSON)

namerequired string up to 200 characters

Response 201

`id`required	string (uuid)
`name`required	string
`lobby`required	boolean
`guest_url`required	string
`usable`	boolean	default true
`running`	boolean	default false
`participants`	integer	default 0
`recording`	boolean	default false
`created_at`required	string (date-time)

curl -X POST "https://portal.nimag.net/api/v1/meeting-rooms" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "lobby": true,
  "guest_url": "string",
  "usable": true,
  "running": false,
  "participants": 0,
  "recording": false,
  "created_at": "2026-01-31T12:00:00Z"
}

Change a meeting room

PATCH/meeting-rooms/{room_id}

Needs the permission meeting:manage

Path

room_idrequired string (uuid)

Body (JSON)

`name`	string \| null	up to 200 characters
`lobby`	boolean \| null
`new_link`	boolean	default false

Response 200

`id`required	string (uuid)
`name`required	string
`lobby`required	boolean
`guest_url`required	string
`usable`	boolean	default true
`running`	boolean	default false
`participants`	integer	default 0
`recording`	boolean	default false
`created_at`required	string (date-time)

curl -X PATCH "https://portal.nimag.net/api/v1/meeting-rooms/{room_id}" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "lobby": true,
    "new_link": false
  }'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "lobby": true,
  "guest_url": "string",
  "usable": true,
  "running": false,
  "participants": 0,
  "recording": false,
  "created_at": "2026-01-31T12:00:00Z"
}

Delete a meeting room

DELETE/meeting-rooms/{room_id}

Needs the permission meeting:manage

Path

room_idrequired string (uuid)

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/meeting-rooms/{room_id}" \
  -H "Authorization: Bearer nck_…"

Start a meeting

POST/meeting-rooms/{room_id}/start

Needs the permission meeting:read

Opens the room, and gives the link to join it.

Path

room_idrequired string (uuid)

Response 200

urlrequired string

curl -X POST "https://portal.nimag.net/api/v1/meeting-rooms/{room_id}/start" \
  -H "Authorization: Bearer nck_…"

{
  "url": "string"
}

List recordings

GET/meeting-rooms/{room_id}/recordings

Needs the permission meeting:read

Path

room_idrequired string (uuid)

Response 200

`id`required	string
`started_at`required	string (date-time) \| null
`ended_at`required	string (date-time) \| null
`participants`required	integer
`url`required	string \| null
`size_mb`required	number \| null

curl "https://portal.nimag.net/api/v1/meeting-rooms/{room_id}/recordings" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "started_at": "2026-01-31T12:00:00Z",
    "ended_at": "2026-01-31T12:00:00Z",
    "participants": 0,
    "url": "string",
    "size_mb": 0
  }
]

Delete a recording

DELETE/meeting-rooms/{room_id}/recordings/{record_id}

Needs the permission meeting:manage

Path

`room_id`required	string (uuid)
`record_id`required	string

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/meeting-rooms/{room_id}/recordings/{record_id}" \
  -H "Authorization: Bearer nck_…"

Video conference plans

GET/meeting-plans

Any key

Response 200

`name`required	string
`participants`required	integer
`extras`required	string[]
`extras_en`	string[]	default []
`prices`	object[]	default []
`months`required	integer
`amount`required	number
`currency`required	string

curl "https://portal.nimag.net/api/v1/meeting-plans" \
  -H "Authorization: Bearer nck_…"

[
  {
    "name": "string",
    "participants": 0,
    "extras": [
      "string"
    ],
    "extras_en": [],
    "prices": []
  }
]