Introduction
A queue could be created by any organization member using Meedio dashboard or Public API. Once you create a queue, it will be open for members and clients to join.
When you create a queue via Public API you will be provided with the redirect URL where the two parties should meet. Clients join a live queue, while specialists accept those client from queue and have a meeting, after which the meeting is moved on to the next client.
Endpoints
POST /v3/rooms/queue
GET /v3/rooms/queue/:id
POST /v3/rooms/queue/:id
DELETE v3/rooms/queue/:id
Queue object
JSON
{
"id": "63da43d5928cb848430b8da5",
"name": "example-name",
"slug": "example-slug",
"isActive": false,
"organizationId": "cb386a76-448d-47b0-a19a-607c5ae68f93",
"closingMessage": "example-closing-message",
"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 queue was created |
name |
string | queue name |
slug |
string | slug name |
isActive |
boolean | queue status |
organizationId |
string | version 4 UUID of the organization that the queue belongs to |
closingMessage |
string | message displayed when the queue is not active |
members |
array | an array of members (doctors or specialists) that belong to the queue |
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 |