Room Details API
This API lets you retrieve the room details using either the room ID or the title of the room.
Using RoomId
https://api.huddle01.com/api/v1/room-details/{roomId}
The Room Details API is a useful tool for retrieving information about a specific meeting room. By passing in the roomId as a parameter, you can easily access the details of a previously created room.
This API is especially useful if you need to retrieve information about a room for administrative purposes or if you want to display information about a room to its participants. Overall, the Room Details API is a valuable resource for accessing information about your meeting rooms and can be used in a variety of scenarios to enhance your experience with Huddle01.
/room-details/{roomId}Room Details API
The API supports a POST request with the following required parameters:
roomId- The RoomId of the room, for which you need to get the details.
const response = await axios.get(
'https://api.huddle01.com/api/v1/room-details/{roomId}',
{
headers: {
'Content-Type': 'application/json',
'x-api-key': {{API_KEY}},
},
}
);Upon success, the API will return a response with the following fields:
roomId- The room ID of the newly created room.title- The title of the room.description- The description of the room.startTime- The start time of the room.endTime- The end time of the room.hostWalletAddress- The host wallet address of the room. .roomLock- A boolean value indicating if the room is locked.muteOnEntry- The mute on entry status of the room.videoOnEntry- The video on entry status of the room.
In case of an error, the API will return an error message with a corresponding status code.
{
{
"roomId": "emo-orrj-uvh",
"title": "Test Meeting",
"description": null,
"meetingLink": "https://app.huddle01.com/emo-orrj-uvh",
"startTime": null,
"expiryTime": null,
"videoOnEntry": false,
"muteOnEntry": false,
"roomLocked": false,
"hostWalletAddress": []
}
}Request
| Params | Definition | Data Type | Mandatory |
|---|---|---|---|
| roomId | The RoomId of the room, for which you need to get the details. | string | Y |
Response
| Fields | Definition | Data Type | Mandatory |
|---|---|---|---|
| roomId | The RoomId of the room, for which you need to get the details. | string | Y |
| title | The title of the room. | string | N |
| description | The description of the room. | string | N |
| startTime | The start time of the room. | string (ISO 8601) | N |
| expiryTime | The expiry time of the room. | string (ISO 8601) | N |
| hostWalletAddress | The host wallet address of the room. | string [ ] | N |
| roomLocked | The room locked status of the room. | boolean | N |
| muteOnEntry | The mute on entry status of the room. | boolean | false |
| videoOnEntry | The video on entry status of the room. | boolean | false |
Using Title
https://api.huddle01.com/api/v1/room-details?title={title}
The Room Details API is a useful tool for retrieving information about a specific meeting room. By passing in the roomId as a parameter, you can easily access the details of a previously created room.
This API is especially useful if you need to retrieve information about a room for administrative purposes or if you want to display information about a room to its participants. Overall, the Room Details API is a valuable resource for accessing information about your meeting rooms and can be used in a variety of scenarios to enhance your experience with Huddle01.
/rooms-details?roomId={roomId}Room Details API
The API supports a GET request with the following required parameters:
title- The title of the room, for which you need to get the meeting list.qty- The number of meetings to be returned.(optional)orderBy- The field to order the data by.(optional)
const response = await axios.get(
'https://api.huddle01.com/api/v1/room-details?title={title}',
{
headers: {
'Content-Type': 'application/json',
'x-api-key': {{API_KEY}},
},
}
);Upon success, the API will return a response with the following fields:
roomId- The room ID of the newly created room.title- The title of the room.description- The description of the room.startTime- The start time of the room.endTime- The end time of the room.hostWalletAddress- The host wallet address of the room. .roomLock- A boolean value indicating if the room is locked.muteOnEntry- The mute on entry status of the room.videoOnEntry- The video on entry status of the room.
In case of an error, the API will return an error message with a corresponding status code.
{
[
{
"roomId": "emo-orrj-uvh",
"title": "Test Meeting",
"description": null,
"meetingLink": "https://app.huddle01.com/emo-orrj-uvh",
"startTime": null,
"expiryTime": null,
"videoOnEntry": false,
"muteOnEntry": false,
"roomLocked": false,
"hostWalletAddress": []
},
{
"roomId": "xyz-ayxs-abd",
"title": "Something Random Meeting",
"description": "Description are important for meetings ?",
"meetingLink": "https://app.huddle01.com/xyz-ayxs-abd",
"startTime": null,
"expiryTime": null,
"videoOnEntry": false,
"muteOnEntry": false,
"roomLocked": false,
"hostWalletAddress": []
}
]
}Request
| Params | Definition | Data Type | Mandatory |
|---|---|---|---|
| title | The title of the room. | string | Y |
| qty | The quantity of the rooms to return | number | 1 |
| orderBy | The order by which the rooms to return | string | desc |
Response
| Fields | Definition | Data Type | Mandatory |
|---|---|---|---|
| roomId | The RoomId of the room, for which you need to get the details. | string | Y |
| title | The title of the room. | string | N |
| description | The description of the room. | string | N |
| startTime | The start time of the room. | string (ISO 8601) | N |
| expiryTime | The expiry time of the room. | string (ISO 8601) | N |
| hostWalletAddress | The host wallet address of the room. | string [ ] | N |
| roomLocked | The room locked status of the room. | boolean | N |
| muteOnEntry | The mute on entry status of the room. | boolean | false |
| videoOnEntry | The video on entry status of the room. | boolean | false |