Room

createRoom

Create a new meeting room. Only switch and admin roles can create meeting rooms.

Request:

{
    "name": "泌尿科：李醫師線上看診",
    "description": "李醫師上午診"
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
name		string	Y		會議室名稱
description		string	N		會議室描述

Response:

{
    "status": 1,
    "message": "",
    "data": {
        "roomId": "xp4z6dani",
        "name": "泌尿科：李醫師線上看診",
        "description": "李醫師上午診",
        "createdAt": "2024-06-23T06:00:52.330Z",
        "host": {
            "id": "1",
            "displayName": "陳曉玲"
        }
    }
}

Parameter	Meaning	Type	Existed	Description
`BODY`
status	response status	string	Y	0: fail
1: success
2: warning
message	message	string	Y	Error messages should be shown when there are errors.
data	Return Information	object	Y	此房間資訊
`roomId`		string	Y	創建的會議室 ID
`name`		string	Y	會議室名稱
`description`		string	Y	會議室描述
`createdAt`		string	Y	創建時間
data.host	Return host info	object	Y
`id`		string	Y	主持人 ID（即 `userId`）
`displayName`		string	Y	主持人顯示名稱
`carrierId`		string	Y	主持人的 Carrier ID
`carrierAddress`		string	Y	主持人的 Carrier Address

Error code:

Code	Status	Message
`200`	1	success
	0	error message
`404`		Resource Not Found
`403`		Access to the requested resource is not allowed

removeRoom

Close the specified meeting room. admin can close any meeting room, switch can only close the meeting room where they are the host.

Request:

{
    "roomId": "a37fsupzg"
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID

Response:

{
    "status": 1,
    "message": "Room closed",
    "data": null
}

Parameter	Meaning	Type	Existed	Description
`BODY`
status	response status	string	Y	0: fail
1: success
2: warning
message	message	string	Y	Error messages should be shown when there are errors.
data	Return Information	object	Y

Error code:

Code	Status	Message
`200`	1	Room closed
	0	error message
	0	Room not found
	2	Failed to publish MQTT message
`404`		Resource Not Found
`403`		Access to the requested resource is not allowed

getRoomList

Get a list of all meeting rooms.

Request:

{
    
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (array) : 會議室列表，每個會議室包含 roomId, name, description, createdAt, host

Error code:

HTTP 狀態碼	狀態	訊息	說明
200	1	""	請求成功

Get detailed information about the meeting room. The information returned varies depending on the user's role. Hosts and administrators can see all information, participants can see information about other participants but not about applicants. Applicants can only see basic information about the room and the host. Non-room members can only see basic information about the room and the host.

Request:

{
    "roomId": "a37fsupzg"
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (object):
- roomId (string): 會議室 ID
- name (string): 會議室名稱
- description (string): 會議室描述
- createdAt (string): 創建時間
- status (string): 會議室狀態，host_joined 或 created
- host:
  - id (string): 主持人 ID
  - displayName (string): 主持人顯示名稱
  - carrierId (string): 主持人的 Carrier ID
  - carrierAddress (string): 主持人的 Carrier Address
- participants (array): 參與者列表，每個參與者包含 id, displayName, joinedAt
- applicants (array): 申請者列表，每個申請者包含 id, displayName, appliedAt

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	""	請求成功
200	0	"Room not found"	找不到會議室
403	0	"Forbidden"	權限不足

addRoomParticipants

申請加入指定的會議室。成功申請後，返回房間的基本資訊和主持人資訊。

Request:

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID
carrierId		string	Y		申請者的 Carrier ID
carrierAddress		string	Y		申請者的 Carrier Address

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (object, 可選): 房間基本資訊和主持人資訊
- roomId (string): 會議室 ID
- name (string): 會議室名稱
- description (string): 會議室描述
- createdAt (string): 創建時間
- status (string): 會議室狀態，host_joined 或 created
- host:
  - id (string): 主持人 ID
  - displayName (string): 主持人顯示名稱

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	"Application to join room submitted"	請求成功
200	0	"Already a participant, an applicant, or host already joined"	已經是參與者、申請者或主持人已加入
403	0	"Forbidden"	權限不足
200	0	"Room not found"	找不到會議室
200	2	"Failed to publish MQTT message"	無法發布 MQTT 訊息

deleteRoomParticipants

離開指定的會議室。主持人離開將關閉會議室。主持人和管理員可以移除參與者並提供移除原因。申請者使用這個方法的話，意義上相當於放棄申請加入會議室。

Request:

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID
participantId		string			被移除的參與者 ID，如果是自己離開則不需要此參數
message		string	Y		移除原因

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (object, 可選): 更新後的房間資訊

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	"Successfully left the room"	成功離開會議室
200	0	"Not a participant or applicant in the room"	不在會議室中
200	0	"Participant not found in the room"	找不到參與者
403	0	"Forbidden"	權限不足
200	1	"Host left and room closed"	主持人離開並關閉會議室
200	2	"Failed to publish MQTT message"	無法發布 MQTT 訊息

handleRoomParticipantsRequest

處理加入會議室的請求。只有主持人和管理員可以處理申請。

Request:

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID
applicantId		string	Y		申請者 ID
accept		boolean	Y		是否同意加入
message		string			拒絕原因

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (object, 可選): 更新後的房間資訊

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	"Request handled"	請求已處理
200	0	"Applicant not found"	找不到申請者
403	0	"Forbidden"	權限不足
200	0	"Room not found"	找不到會議室
200	2	"Failed to publish MQTT message"	無法發布 MQTT 訊息

updateRoomInfo

更新會議室的資訊。只有主持人和管理員可以更新會議室的資訊。

Request:

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID
name		string	Y		新的會議室名稱
description		string	Y		新的會議室描述
carrierId		string	Y		主持人的新 Carrier ID
carrierAddress		string	Y		主持人的新 Carrier Address

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息
data (object, 可選): 更新後的房間資訊

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	"Room info updated"	會議室信息已更新
403	0	"Forbidden"	權限不足
200	0	"Room not found"	找不到會議室
200	2	"Failed to publish MQTT message"	無法發布 MQTT 訊息

triggerRoomCustomEvent

由主持人發布自定義 MQTT 訊息給所有人，可以用來發布應用程式自定義訊息如開始錄影、啟動畫板等等。

Request:

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer	用於驗證權限

`BODY`
roomId		string	Y		會議室 ID
eventMessage		string	Y		要發布的自定義訊息

Response:

status (number): 1 表示成功，0 表示失敗，2 表示警告
message (string): 提示訊息

HTTP 狀態碼與返回訊息:

HTTP 狀態碼	狀態	訊息	說明
200	1	"Custom event published"	已發布訊息
403	0	"Forbidden"	權限不足
200	2	"Failed to publish MQTT message"	無法發布 MQTT 訊息
200	0	"Room not found"	找不到房間