Introduction
A board could be created by any organization member using Meedio dashboard or Public API. Once you create a board, it will be open for members and clients to join.
When you create a board via Public API you will be provided with the redirect URL where the two parties should meet. If board is created with waiting list, clients will not be able to join meeting right away. Board member then will be able to decide if he wants to accept client or no. If board is created with disabled waiting list, all clients that are joining the board will be connected to video conversation immediately.
Endpoints
POST /v3/rooms/board
GET /v3/rooms/board/:id
POST /v3/rooms/board/:id
DELETE v3/rooms/board/:id
Board object
JSON
{
"id": "63da43d5928cb848430b8da5",
"name": "example-name",
"slug": "example-slug",
"isActive": false,
"organizationId": "cb386a76-448d-47b0-a19a-607c5ae68f93",
"closingMessage": "example-closing-message",
"hasWaitingList": true,
"members": [
{
"userId": "00d247fb-5d4d-4c73-a5a0-20b3f895ca72",
"fullName": "example-full-name",
"isActive": false,
"isAutoAccepting": false,
"joinedCallAt": null
}
]
}
Key | Type | Description |
---|---|---|
id |
string | MongoDB ObjectID generated once the board was created |
name |
string | board name |
slug |
string | slug name |
isActive |
boolean | board status |
organizationId |
string | version 4 UUID of the organization that the board belongs to |
closingMessage |
string | message displayed as board description |
hasWaitingList |
boolean | waiting list status (enabled/disabled) |
members |
array | an array of members (doctors or specialists) that belong to the board |
Member object
Key | Type | Description |
---|---|---|
userId |
string | version 4 UUID of the member |
fullName |
string | full name of the member |
isActive |
boolean | member status |
isAutoAccepting |
boolean | a status that defines if the member is automatically accepting clients to a call |
joinedCallAt |
Date | timestamp of the moment that a member joins a call |