HiLink 文件

概述

使用 VCaaS Open API 可以幫助第三方可以快速集成 VCaaS 的虛擬教室。包括 VCaaS Meeting API 和 VCaaS File API 兩部分。

VCaaS Open API 質量環境地址：https://uat.vcaas.hilinkdemo.com/api
VCaaS Open API 生產環境地址：https://vcaas.hilink.co/api

VCaaS Meeting API

1.創建會議

介面說明

該 API 可用於創建一個新的會議，請求成功後響應結果會返回會議ID meetingId 和會議地址 meetingUrl。會議ID meetingId 將作為生成 JoinToken 的參數，而會議地址 meetingUrl 將用於拼接會議鏈接 JoinUrl。

請求方法與接入點

請求方法：POST
接入點：/v2/meeting-center/meetings

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
meetingExternalId	String(64)	true	會議外部ID
meetingTitle	String(100)	true	會議名稱
startTime	Long	false	會議開始時間，UTC時間戳，單位：秒，默認值：當前時間
endTime	Long	true	會議結束時間，UTC時間戳，單位：秒
timerStartTime	Long	false	計時開始時間，UTC時間戳，單位：秒，默認值：startTime
timerEndTime	Long	false	計時結束時間，UTC時間戳，單位：秒，默認值：endTime
timerCountdown	Integer	false	倒計時開始時間，單位：分鐘，默認值：5
callbackUrl	String	false	會議結束數據推送回調地址
redirectUrl	String	false	會議結束跳轉地址
invitationUrl	String	false	教室內邀請鏈接地址
meetingRegion	String	false	會議服務器區域
realTimeCallbackUrl	Object	false	會議實時數據推送回調地址
config	Object	false	會議配置
docIds	List	false	文件ID集合
lessonPlanIds	List	false	教案ID集合（注意：接受 LessonPlanId 和 aiLessonPlanId）
quizIds	List	false	預設 Quiz ID集合

config 參數詳情：

參數	類型	默認值	描述
enableChat	Boolean	true	是否啟用聊天
enableRecording	Boolean	true	是否啟用錄像
enableFiles	Boolean	true	是否啟用多媒體檔案播放
enableQuiz	Boolean	true	是否啟用測驗
enablePoll	Boolean	true	是否啟用投票
enableScreenShare	Boolean	true	是否啟用屏幕分享
enableReward	Boolean	true	是否啟用獎勵
enableYoutubePlayer	Boolean	true	是否啟用Youtube播放
enableWaitingRoom	Boolean	true	是否啟用等待室
enableAutoRecording	Boolean	false	是否啟用自動錄屏
enableWebLinks	Boolean	true	是否啟用Web鏈接
enableCountdown	Boolean	true	是否啟用倒計時
enableNameRandomizer	Boolean	true	是否啟用大轉盤
enableDice	Boolean	true	是否啟用骰子
enableCalculator	Boolean	true	是否啟用計算器
enableAfterClassEval	Boolean	false	是否啟用課後評價
enableClassroomInvitation	Boolean	false	是否啟用教室內邀請鏈接
enableRecordingButton	Boolean	true	是否啟用錄屏按鈕
enableRecordingPermission	Boolean	true	是否啟用錄屏權限彈窗
enableEndButton	Boolean	true	是否啟用結束/退出課堂按鈕
enableBreakoutGroup	Boolean	true	是否啟用討論組功能
enableReaction	Boolean	true	是否啟用表情互動功能
recordingFileTypes	List	["mp4"]	指定錄音檔類型。選項包括：["mp4"]、["mp3", "mp4"]。
enableLessonPlan	Boolean	false	是否啟用教案功能
enableNearpod	Boolean	true	是否啟用 Nearpod
enableBrowserRecBanner	Boolean	false	是否啟用向非Chrome用戶提示使用Chrome瀏覽器
enableBrowserUpdatePrompt	Boolean	true	是否啟用允許客戶控制瀏覽器更新提示功能的顯示
enableStudentSendChatFile	Boolean	true	是否允許學生在chat中發送文件
enableTeacherOnboarding	Boolean	false	是否允許給第一次進入教室的新老師展現引導動畫
defaultView	String	"sidebar"	指定預設視圖，選項包括 "sidebar", "gallery", "whiteboard"

meetingRegion 可用區域:

預設的會議區域是：亞太地區（東京）ap-northeast-1，建議依照與會者的位置狀況，選擇就近的會議區域。

區域	值
亞太地區（孟買）	`ap-south-1`
亞太地區（首爾）	`ap-northeast-2`
亞太地區（新加坡）	`ap-southeast-1`
亞太地區（悉尼）	`ap-southeast-2`
亞太地區（東京）	`ap-northeast-1`
加拿大（中部）	`ca-central-1`
歐洲（法蘭克福）	`eu-central-1`
歐洲（愛爾蘭）	`eu-west-1`
歐洲（倫敦）	`eu-west-2`
歐洲（巴黎）	`eu-west-3`
歐洲（斯德哥爾摩）	`eu-north-1`
南美洲（聖保羅）	`sa-east-1`
美國東部（俄亥俄州）	`us-east-2`
美國東部（弗吉尼亞北部）	`us-east-1`
美國西部（加利福尼亞北部）	`us-west-1`
美國西部（俄勒岡）	`us-west-2`

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容
請求包體內容：

{
  "meetingExternalId": "500000",
  "meetingTitle": "Tech meeting",
  "startTime": 1673062042,
  "endTime": 1673753242,
  "countdownStartTime": 5,
  "callbackUrl": "<https://www.hilink.co/>",
  "redirectUrl": "<https://www.hilink.co/>",
  "meetingRegion": "us-east-2",
  "invitationUrl" : "<https://www.hilink.co/>",
  "config": {
    "enableChat": true,
    "enableRecording": true,
    "enableFilePlayer": true,
    "enableQuiz": true,
    "enablePoll": true,
    "enableClassroomInvitation" : true,
    "recordingFileTypes": ["mp4", "mp3"],
    "enableBrowserRecBanner" : true,
    "enableBrowserUpdatePrompt" : true
  },
  "docIds": [
  ],
  "lessonPlanIds": [
  ],
  "quizIds": [
  ]
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
meetingExternalId	String	會議外部ID
meetingTitle	String	會議名稱
meetingId	String	會議ID，將作為生成 JoinToken 的參數
meetingUrl	String	會議地址，用於拼接會議鏈接
startTime	Long	會議開始時間，UTC時間戳，單位：秒
endTime	Long	會議結束時間，UTC時間戳，單位：秒
timerStartTime	Integer	計時開始時間，UTC時間戳，單位：秒
timerEndTime	Integer	計時結束時間，UTC時間戳，單位：秒
meetingStatus	String	會議狀態

響應示例

{
  "meetingExternalId": "500000",
  "meetingTitle": "Tech meeting",
  "meetingId": "109391932341489664",
  "meetingUrl": "https://dev.vcaas.hilinkdemo.com/meeting",
  "startTime": 1673062042,
  "endTime": 1673755042,
  "timerStartTime": 1673062042,
  "timerEndTime": 1673755042,
  "meetingStatus": "CREATED"
}

2.更新會議

介面說明

該 API 可用於更新一個已創建未開啟的會議，請求成功後響應結果會返回會議ID meetingId 和會議地址 meetingUrl。會議ID meetingId 將作為生成 JoinToken 的參數，而會議地址 meetingUrl 將用於拼接會議鏈接 JoinUrl。

請注意：已經過了開始時間的會議無法更新或修改。

請求方法與接入點

請求方法：PATCH
接入點：/v2/meeting-center/meetings/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
meetingTitle	String(100)	false	會議名稱
startTime	Long	false	會議開始時間，UTC時間戳，單位：秒
endTime	Long	false	會議結束時間，UTC時間戳，單位：秒
timerStartTime	Long	false	計時開始時間，UTC時間戳，單位：秒
timerEndTime	Long	false	計時結束時間，UTC時間戳，單位：秒
timerCountdown	Integer	false	倒計時開始時間，單位：分鐘
callbackUrl	String	false	會議結束數據推送回調地址
redirectUrl	String	false	會議結束跳轉地址
invitationUrl	String	false	教室內邀請鏈接地址
meetingRegion	String	false	會議服務器區域
realTimeCallbackUrl	Object	false	會議實時數據推送回調地址
config	Object	false	會議配置
docIds	List	false	文件ID集合
lessonPlanIds	List	false	教案ID集合（注意：接受 LessonPlanId 和 aiLessonPlanId）
quizIds	List	false	預設 Quiz ID集合

config 參數詳情：

參數	類型	描述
enableChat	Boolean	是否啟用聊天
enableRecording	Boolean	是否啟用錄像
enableFiles	Boolean	是否啟用多媒體檔案播放
enableQuiz	Boolean	是否啟用測驗
enablePoll	Boolean	是否啟用投票
enableScreenShare	Boolean	是否啟用屏幕分享
enableReward	Boolean	是否啟用獎勵
enableYoutubePlayer	Boolean	是否啟用Youtube播放
enableWaitingRoom	Boolean	是否啟用等待室
enableAutoRecording	Boolean	是否啟用自動錄屏
enableWebLinks	Boolean	是否啟用Web鏈接
enableCountdown	Boolean	是否啟用倒計時
enableNameRandomizer	Boolean	是否啟用大轉盤
enableCalculator	Boolean	是否啟用計算器
enableAfterClassEval	Boolean	是否啟用課後評價
enableClassroomInvitation	Boolean	是否啟用教室內邀請鏈接
enableRecordingButton	Boolean	是否啟用錄屏按鈕
enableRecordingPermission	Boolean	是否啟用錄屏權限彈窗
enableEndButton	Boolean	是否啟用結束/退出課堂按鈕
enableBreakoutGroup	Boolean	是否啟用討論組功能
enableReaction	Boolean	是否啟用表情互動功能
recordingFileTypes	List	指定錄音檔類型。選項包括：["mp4"]、["mp3", "mp4"]。
enableLessonPlan	Boolean	是否啟用教案功能
enableNearpod	Boolean	是否啟用 Nearpod
enableBrowserRecBanner	Boolean	是否啟用向非Chrome用戶提示使用Chrome瀏覽器
enableBrowserUpdatePrompt	Boolean	是否啟用允許客戶控制瀏覽器更新提示功能的顯示
enableStudentSendChatFile	Boolean	是否允許學生在chat中發送文件
enableTeacherOnboarding	Boolean	是否允許給第一次進入教室的新老師展現引導動畫
defaultView	String	指定預設視圖，選項包括 "sidebar", "gallery", "whiteboard"

meetingRegion 可用區域:

區域	值
亞太地區（孟買）	`ap-south-1`
亞太地區（首爾）	`ap-northeast-2`
亞太地區（新加坡）	`ap-southeast-1`
亞太地區（悉尼）	`ap-southeast-2`
亞太地區（東京）	`ap-northeast-1`
加拿大（中部）	`ca-central-1`
歐洲（法蘭克福）	`eu-central-1`
歐洲（愛爾蘭）	`eu-west-1`
歐洲（倫敦）	`eu-west-2`
歐洲（巴黎）	`eu-west-3`
歐洲（斯德哥爾摩）	`eu-north-1`
南美洲（聖保羅）	`sa-east-1`
美國東部（俄亥俄州）	`us-east-2`
美國東部（弗吉尼亞北部）	`us-east-1`
美國西部（加利福尼亞北部）	`us-west-1`
美國西部（俄勒岡）	`us-west-2`

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容
請求包體內容：

{
  "meetingTitle": "Tech meeting Title Update"
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
meetingExternalId	String	會議外部ID
meetingTitle	String	會議名稱
meetingId	String	會議ID，將作為生成 JoinToken 的參數
meetingUrl	String	會議地址，用於拼接會議鏈接
startTime	Long	會議開始時間，UTC時間戳，單位：秒
endTime	Long	會議結束時間，UTC時間戳，單位：秒
timerStartTime	Integer	計時開始時間，UTC時間戳，單位：秒
timerEndTime	Integer	計時結束時間，UTC時間戳，單位：秒
meetingStatus	String	會議狀態

響應示例

{
  "meetingExternalId": "500000",
  "meetingTitle": "Tech meeting Title Update",
  "meetingId": "109391932341489664",
  "meetingUrl": "https://dev.vcaas.hilinkdemo.com/meeting",
  "startTime": 1673062042,
  "endTime": 1673755042,
  "timerStartTime": 1673062042,
  "timerEndTime": 1673755042,
  "meetingStatus": "CREATED"
}

3.結束會議

介面說明

該 API 可用於主動結束一個正在進行中的會議。

請求方法與接入點

請求方法：PUT
接入點：/v1/meeting-center/meetings/{id}/end

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/end
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

4.查詢會議列表

介面說明

該 API 可用於分頁查詢機構下的所有會

議。

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
page	Long	false	當前頁，默認值：0
size	Long	false	分頁大小，默認值：10

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings?page=0&size=10
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
total	Long	總記錄數
page	Long	當前頁
size	Long	分頁大小
data	List	數據集合

響應示例

{
  "total": 1,
  "page": 0,
  "size": 10,
  "data": [
    {
      "meetingExternalId": "500000",
      "meetingTitle": "Tech meeting",
      "meetingId": "109391932341489664",
      "meetingUrl": "https://dev.vcaas.hilinkdemo.com/meeting",
      "startTime": 1673062042,
      "endTime": 1673755042,
      "timerStartTime": 1673071200,
      "timerEndTime": 1673078400,
      "meetingStatus": "CREATED"
    }
  ]
}

5.查詢會議

介面說明

該 API 可用於根據會議ID查詢單個會議。

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
meetingExternalId	String	會議外部ID
meetingTitle	String	會議名稱
meetingId	String	會議ID，將作為生成 JoinToken 的參數
meetingUrl	String	會議地址，用於拼接會議鏈接
startTime	Long	會議開始時間，UTC時間戳，單位：秒
endTime	Long	會議結束時間，UTC時間戳，單位：秒
timerStartTime	Integer	計時開始時間，UTC時間戳，單位：秒
timerEndTime	Integer	計時結束時間，UTC時間戳，單位：秒
meetingStatus	String	會議狀態

響應示例

{
  "meetingExternalId": "500000",
  "meetingTitle": "Tech meeting",
  "meetingId": "109391932341489664",
  "meetingUrl": "https://dev.vcaas.hilinkdemo.com/meeting",
  "startTime": 1673062042,
  "endTime": 1673755042,
  "timerStartTime": 1673071200,
  "timerEndTime": 1673078400,
  "meetingStatus": "CREATED"
}

6.刪除會議

介面說明

該 API 可用於刪除一個會議，刪除後會議無法通過查詢介面查詢。

請求方法與接入點

請求方法：DELETE
接入點：/v1/meeting-center/meetings/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

7.查詢會議文檔列表

介面說明

該 API 可用於查詢指定會議下的文檔集合。

請求方法與接入點

請求方法：GET
接入點：/v1/meeting-center/meetings/{id}/documents

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求

頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docId	String	文件ID
name	String	文件名
type	String	文件類型
fileKey	String	文件Key
fileStatus	String	文件狀態
fileSize	Long	文件大小

響應示例

[
  {
    "docId": "128930307276673024",
    "name": "exampleFolder",
    "type": "folder",
    "fileKey": "",
    "fileStatus": "uploaded",
    "fileSize": 460668,
    "children": [
      {
        "docId": "100313458125443072",
        "name": "test000.ppt",
        "type": "ppt",
        "fileKey": "91232529172008960/test000.ppt",
        "fileStatus": "uploaded",
        "fileSize": 460668,
        "children": []
      }
    ]
  }
]

8.添加會議文檔

介面說明

該 API 可用於向指定會議添加一個或多個文檔。

請求方法與接入點

請求方法：POST
接入點：/v1/meeting-center/meetings/{id}/documents

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
docIds	List	true	文檔ID集合

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容
請求包體內容：

{
  "docIds": [
    "101102960439857152",
    "102944975171489792"
  ]
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

9.刪除會議文檔

介面說明

該 API 可用於刪除指定會議中的指定文檔。

請求方法與接入點

請求方法：DELETE
接入點：/v1/meeting-center/meetings/{id}/documents/{docId}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID
docId	Long	true	文檔ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents/101102960439857152
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

10.查詢會議錄像列表

介面說明

該 API 可用於查詢會議中的錄像視頻。

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings/{id}/recordings

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271373502823706624/recordings
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
meetingId	String	會議ID
meetingTitle	String	會議標題
recordingTitle	String	錄像標題
videoUrl	String	錄像播放位址
audioUrl	String	音訊播放位址（建立會議 recordingFileTypes 配置了 mp3 格式）
beginTime	Long	開始時間
endTime	Long	結束時間

響應示例

[
  {
    "meetingId": "271373502823706624",
    "meetingTitle": "test meeting",
    "recordingTitle": "test meeting 01",
    "videoUrl": "https://hilink-agora-record-dev.s3.amazonaws.com/71/f20295c78e46e69e7f1c74960821d3f1_VCaaS7161748_0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230331T055224Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIA5MC3STOBS4HWLDDJ%2F20230331%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f6c4cb6d46c6c9af0c4c76521d98078e6bbc7f587dce215139ef2e0d51dd6255",
    "audioUrl": "https://hilink-agora-record-dev.s3.amazonaws.com/71/f20295c78e46e69e7f1c74960821d3f1_VCaaS7161748_0_1711598011095.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230331T055224Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIA5MC3STOBS4HWLDDJ%2F20230331%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f6c4cb6d46c6c9af0c4c76521d98078e6bbc7f587dce215139ef2e0d51dd6255",
    "beginTime": "1711594322",
    "endTime": "1711594380"
  }
]

11.查詢會後數據

介面說明

該 API 可用於查詢會議過程中產生的數據，包括會議時長數據，會議與會者考勤數據，會議錄像數據，會議互動數據，會議與會者互動數據。

請求方法與接入點

請求方法：GET
接入點：/v1/meeting-center/meetings/{id}/data

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/data
Content-Type: application

/json

Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
meetingData	Object	會議時長數據
attendeeDatas	Object	會議與會者考勤數據
meetingVideoData	Object	會議錄像數據
meetingInteractiveData	Object	會議互動數據
attendeeInteractiveDatas	Object	會議與會者互動數據
evaluationData	Object	課後評價數據

響應示例

{
  "meetingData": {
    "meetingUid": "103288082375249920",
    "meetingExternalId": "123",
    "scheduledStartTime": "1671519598",
    "scheduledEndTime": "1692196976",
    "startTime": "1672132286",
    "endTime": "1672201926",
    "duration": "2024"
  },
  "attendeeDatas": [
    {
      "meetingUid": "103288082375249920",
      "meetingExternalId": "123",
      "attendeeUid": "105859080664518656",
      "externalId": "Q8NnQKOaWhax8cD195wB7Q==",
      "timeIn": "1672132517",
      "timeOut": "1672133011",
      "device": "",
      "details": [
        {
          "type": "AttendeeJoined",
          "timestamp": 1672132517822
        },
        {
          "type": "AttendeeLeft",
          "timestamp": 1672132700326
        },
        {
          "type": "AttendeeJoined",
          "timestamp": 1672132952680
        },
        {
          "type": "AttendeeLeft",
          "timestamp": 1672133011815
        }
      ]
    }
  ],
  "meetingVideoData": {
    "meetingUid": "103288082375249920",
    "meetingExternalId": "123",
    "videoUrls": [
      "https://hilink-agora-record-dev.s3.amazonaws.com/31/11e35f12a24b170324e9b38307ee9011_VCaaS31104936_0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230113T105238Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIA5MC3STOBSQDRGF7M%2F20230113%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f08aa8d30c2e12ef4a909824413a13e489d409f673013414cd4b444cb48b03b6"
    ]
  },
  "meetingInteractiveData": {
    "meetingUid": "103288082375249920",
    "meetingExternalId": "123",
    "quizData": {
      "totalCount": 1,
      "detailDatas": [
        {
          "id": "f8d836e56fb030b893e0f3a05bc487a9",
          "content": {
            "options": [
              {
                "value": "A",
                "label": "ff"
              },
              {
                "value": "B",
                "label": "ffff"
              }
            ],
            "content": "jjjf"
          },
          "averageAccuracy": "",
          "correctAnswer": "A"
        }
      ]
    },
    "pollData": {
      "totalCount": 1,
      "detailDatas": [
        {
          "id": "65155160d48337ee47bcd634bd67bc66",
          "content": {
            "options": [
              {
                "value": "A",
                "label": "fff"
              },
              {
                "value": "B",
                "label": "ffffff"
              }
            ],
            "content": "nihaoy"
          }
        }
      ]
    }
  },
  "attendeeInteractiveDatas": [
    {
      "meetingUid": "103288082375249920",
      "meetingExternalId": "123",
      "attendeeUid": "106838452825362432",
      "externalId": "FWhhpuTn1rUif3UM70gq7Q==",
      "attendeeQuizData": {
        "count": 1,
        "answers": [
          {
            "id": "ef84a2b4634bd53dee901b59076a5d5d",
            "username": "106838452825362432",
            "questionType": "MULTIPLE_CHOICE",
            "selection": "A"
          }
        ]
      },
      "attendeePollData": {
        "count": 1,
        "answers": [
          {
            "id": "6f3d5e11338c834b667940f85e0da317",
            "username": "106838452825362432",
            "pollType": "MULTIPLE_CHOICE",
            "pollOption": {
              "value": "A",
              "label": "hoa"
            }
          }
        ]
      }
    }
  ],
  "evaluationData": [
    {
      "attendeeUid": "222883139968741376",
      "externalId": "3f4cf897028313443fcf93e48a5fda60",
      "attendeeType": "HOST",
      "score": 4,
      "feedback": [],
      "review": ""
    }
  ]
}

12.新增會議預設 Quiz

介面說明

此 API 用於將一個或多個 Quiz 添加到指定會議中。

請求方式與端點

請求方式：POST
端點：/v2/meeting-center/meetings/{id}/quizzes

HTTP 請求

路徑參數

此 API 需要在 URL 中傳入以下參數：

參數	類型	必填	說明
id	Long	true	會議ID

請求標頭

Content-Type: application/json
Authorization: 請參考文件說明部分中的獲取開發者帳號內容。

請求主體

此 API 需要在請求主體中傳入以下參數：

參數	類型	必填	說明
quizIds	List	true	文件ID集合

請求範例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes
Content-Type: application/json
Authorization: 請參考文件說明部分中的獲取開發者帳號內容
請求主體內容：

{
  "quizIds": [
    "259031606768046080",
    "259031736292347904"
  ]
}

HTTP 回應

如果 HTTP 狀態碼為 200，表示請求成功。回應主體包含以下欄位：

欄位	類型	說明
code	字串	VCaaS 系統代碼
message	字串	VCaaS 系統訊息

回應範例

{
  "code": "SYS20000",
  "message": "success"
}

13.刪除會議預設 Quiz

介面說明

此介面可用於刪除指定會議中的指定 Quiz。

請求方法與接入點

請求方法：DELETE
接入點：/v2/meeting-center/meetings/{id}/quizzes/{quizId}

HTTP 請求

路徑參數

此介面需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID
quizId	Long	true	Quiz ID

請求頭

Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes/260868005909630976
Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

14.查詢會議 Quiz 清單

介面說明

此介面可用於查詢指定會議下的 Quiz 集合。

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings/{id}/quizzes

HTTP 請求

路徑參數

此介面需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes
Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容

HTTP 回應

若 HTTP 狀態碼為 200，表示請求成功。回應主體中包含以下欄位：

欄位	類型	描述
quizId	String	ID
externalQuizId	String	外部 ID
type	String	類型
duration	String	答題時長，單位：秒
question	String	題幹
options	Object	選項
quizStatus	String	狀態

回應範例

[
  {
    "quizId": "260868005909630976",
    "externalQuizId": "123456",
    "type": "MULTIPLE_CHOICE",
    "duration": "45",
    "question": "Which of the following are planets in the solar system?",
    "options": {
      "Moon": "false",
      "Mars": "true",
      "Earth": "true",
      "Sun": "false"
    },
    "quizStatus": "CREATED"
  }
]

15. 查詢會議聊天數據

接口說明

該 API 可用於查詢指定會議下的聊天數據。備註：目前版本的介面僅限於查詢主會議中生成的聊天數據，不包括討論組聊天數據。

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings/{id}/chatMessage

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議 ID

請求頭

Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/chatMessage
Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容。

HTTP 響應

若 HTTP 狀態碼為 200，表示請求成功。回應主體中包含以下欄位：

欄位	類型	描述
meetingExternalId	String	會議外部 ID
meetingTitle	String	會議標題
meetingId	String	會議 ID
classChat	List	消息列表

classChat 字段結構：

欄位	類型	描述
sender	String	消息發送者
timestamp	Long	消息發送時間戳，單位：秒
message	String	消息內容
hasRecalled	Boolean	是否被撤回

響應示例

{
    "meetingExternalId": "1709691919",
    "meetingTitle": "chat msg test",
    "meetingId": "109391932341489664",
    "classChat": [
        {
            "sender": "Linda",
            "timestamp": 1711506181,
            "message": "Hi, morning",
            "hasRecalled": true
        },
        {
            "sender": "David",
            "timestamp": 1711506177,
            "message": "Good morning",
            "hasRecalled": false
        }
    ]
}

16.添加會議 Lesson Plan

接口說明

該 API 可用於添加 lesson Plan

請求方法與接入點

請求方法：POST
接入點：/v2/meeting-center/meetings/{id}/lesson-plans

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
lessonPlanIds	List	true	教案的唯一標識符數組

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271625972762198016/lesson-plans
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容
請求包體內容：

{
  "lessonPlanIds": [
    "208765402413666304",
    "265273736456966144"
  ]
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
    "code": "SYS20000",
    "message": "success"
}

17.查詢會議 Lesson Plan 列表

接口說明

該 API 可用於查詢會議的 lesson Plan 列表

請求方法與接入點

請求方法：GET
接入點：/v2/meeting-center/meetings/{id}/lesson-plans

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271625972762198016/lesson-plans
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
lessonPlanId	String	教案的唯一標識符
lessonPlanExternalId	String	外部標識符
topic	String	課題名稱
audience	String	目標聽眾
duration	String	課程時長
learningObjective	String	學習目標
language	String	授課語言
additionalInfo	String	額外信息（例如學生的特殊需求）
content	String	課程內容，支持Markdown格式

響應示例

[
  {
        "lessonPlanId": "271541303442059264",
        "lessonPlanExternalId": "123456",
        "topic": "Math",
        "audience": "1st grade student",
        "duration": "1 hour",
        "learningObjective": "",
        "additionalInfo": "",
        "language": "English",
        "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
    },
    {
        "lessonPlanId": "271541234223460352",
        "lessonPlanExternalId": "123456",
        "topic": "Math",
        "audience": "1st grade student",
        "duration": "1 hour",
        "learningObjective": "",
        "additionalInfo": "",
        "language": "English",
        "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
    }
]

18.刪除會議 Lesson Plan

接口說明

該 API 可用於刪除 lesson Plan

請求方法與接入點

請求方法：DELETE
接入點：/v2/meeting-center/meetings/{id}/lesson-plans/{lessonPlanId}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID
lessonPlanId	String	true	教案ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://test.vcaas.hilinkdemo.com/api/v2/meeting-center/meetings/271625972762198016/lesson-plans/271541303442059264
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
    "code": "SYS20000",
    "message": "success"
}

19.刪除會議錄影

介面說明

此介面可用於刪除指定會議中的錄影

請求方法與接入點

請求方法：DELETE
接入點：/v1/meeting-center/meetings/{id}/videos

HTTP 請求

路徑參數

此介面需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	會議ID

請求頭

Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/videos
Content-Type: application/json
Authorization: 請參考文檔說明部分中的獲取開發者帳號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

VCaaS File API

1.創建文檔上傳URL

介面說明

該 API 可用於獲取文件的上傳地址。

請求方法與接入點

請求方法：POST
接入點：/v1/document-center/upload-urls

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
key	String(200)	true	文件Key
duration	Integer	true	上傳地址鏈接有效時長，單位：分鐘
callback	String	true	文檔上傳完回調地址

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/document-center/upload-urls
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容
請求包體內容：

{
  "key": "test.doc",
  "duration": 5,
  "callback": ""
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docId	String	文件ID
url	String	文件的上傳地址

響應示例

{
  "docId": "96397990553587712",
  "url": "https://dev.file.vcaas.hilinkdemo.com/91232529172008960%2Ftest.doc?Expires=1672991509&Signature=OE-hM31AmLFnquWi8BVvtiim0aP~4c~e2EewkA6h5GT0sYw0ejYQUD9fYmz5ScI00tkL8mCaTnbnkHoWGaLZqSt24h-SYotmkbeFAaLVJTS8MdTZkPvkgThYd39AsJiE2KReLA35cdwjyx5mzyQCnuiCHue-uV6~mJ3MAJcFIA75j39s~u0qCDEjBM2Ez-MqtUKYu-xSSWvb3Hwu8Ztg8srV40zoM3hPtC2KjQ7lgCYUK1xTPJa97xS6U4i5FZsiGu~HvSotdZ-ETeTLu6ebbY~Gu6qFef1ajBUqc8jACkI~UBhoE4Az8drc5NzmsyYUTAt4I958DFrmc671TbNM-Q__&Key-Pair-Id=K21VT8DFTV93QE"
}

2.獲取文檔列表

介面說明

該 API 可用於分頁查詢機構下的所有文檔。

請求方法與接入點

請求方法：GET
接入點：/v1/document-center/documents

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
keyword	String	false	查詢關鍵字
status	String	false	文件狀態：presign（預簽名），uploaded（已上傳）
page	Int	false	當前頁，默認值：0
size	Int	false	分頁大小，默認值：10

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/document-center/documents
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docId	String	文件ID
parentId	String	父文件夾的文檔ID（如果沒有父文件夾則返回0）
name	String	文件名稱
type	String	文件類型
fileKey	String	文件Key
fileStatus	String	文件狀態
fileSize	Long	文件大小，單位：字節

響應示例

{
  "total": 1,
  "page": 1,
  "size": 10,
  "data": [
    {
      "docId": "99221259577069568",
      "parentId": "0",
      "name": "通信 學院 論文 模板 A4.doc",
      "type": "doc",
      "fileKey": "91232529172008960/通信 學院 論文 模板 A4.doc",
      "fileStatus": "uploaded",
      "fileSize": 69632
    }
  ]
}

3.查詢文檔

介面說明

該 API 可用於根據文件ID查詢指定文檔。

請求方法與接入點

請求方法：GET
接入點：/v2/document-center/documents/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	文件ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔

說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/document-center/documents/99221259577069568
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docId	String	文件ID
parentId	String	父文件夾的文檔ID（如果沒有父文件夾則返回0）
name	String	文件名稱
type	String	文件類型
fileKey	String	文件Key
fileStatus	String	文件狀態
fileSize	Long	文件大小，單位：字節
children	List	子文件（僅適用於文件夾）

響應示例

{
  "docId":"217665352530874368",
  "parentId":"217665158003249152",
  "name":"Untitled folder 2",
  "type":"folder",
  "fileKey":"",
  "fileStatus":"uploaded",
  "fileSize":1119650,
  "children":
  [
    {
      "docId":"148508893595701248",
      "name":"Presentation1.ppt",
      "type":"ppt",
      "fileKey":"130840909813256192/Presentation1.ppt",
      "fileStatus":"uploaded",
      "fileSize":41472
    },
    {
      "docId":"189671712768528384",
      "name":"staticimage.png",
      "type":"png",
      "fileKey":"130840909813256192/189671712768528384/staticimage.png",
      "fileStatus":"uploaded",
      "fileSize":1078178
    }
  ]
}

4. 創建文件夾

介面說明

該 API 可用於在文檔中心創建新文件夾。

請求方法與接入點

請求方法：POST
接入點：/v1/document-center/folder

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
name	String	true	文件夾名字
parentId	String	true	新文件夾將被創建在其下的父文件夾的ID（如果不屬於任何父文件夾，則為0）

請求示例

請求 URL：https://vcaas.hilink.co/api/v1/document-center/folder
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docId	String	文件夾 ID
name	String	文件夾名字
parentId	String	父文件夾的文檔ID（如果沒有父文件夾則返回0）

響應示例

{
  "docId": "99221259577069568",
  "name": "exampleFolder",
  "parentId": "0"
}

5.刪除文檔

介面說明

該 API 可用於根據文件ID刪除指定文檔和文件夾。

請求方法與接入點

請求方法：DELETE
接入點：/v2/document-center/documents/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	文件ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/document-center/documents/99221259577069568
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
docIds	List	被刪除文件docId列表

響應示例

{
  "docIds":["99221259577069568"]
}

6. 移動文檔

介面說明

該API可用於將文檔或文件夾移動到新的父位置。

請求方法與接入點

請求方法：POST
接入點：/v1/document-center/move-document

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
docId	String	true	文件夾ID
parentId	String	true	期望目標文件夾的父ID（如果不屬於任何父文件夾，則為0）

請求頭

請求 URL：https://vcaas.hilink.co/api/v1/document-center/move-document
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

VCaaS Quiz API

1.創建 Quiz

介面說明

此 API 可用於創建機構下預設的 Quiz 內容。

請求方法與接入點

請求方法：POST
接入點：/v2/feature-center/quizzes

HTTP 請求

路徑參數

請求標頭

Content-Type: application/json
Authorization: 該欄位的值請參考文件說明部分中的獲取開發者帳號內容。

請求包體

此 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
externalQuizId	String(128)	false	外部 ID
type	String(100)	true	類型，可選值：MULTIPLE_CHOICE（多選）、TRUE_FALSE（判斷）
duration	String(30)	false	答題時長，單位：秒，可選值：15、30、45、60。默認值：45
question	String(65535)	true	題幹
options	Object	true	選項規則說明： MULTIPLE_CHOICE 規則： - options 必須要有一個 true - options 必須要至少兩個選項 - options 的 value 必須是 "true" 或者 "false" TRUE_FALSE 規則： - options 只能包含 "true" 和 "false" - 必須且只能有一個正確答案

請求範例 1

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes
Content-Type: application/json
Authorization: 該欄位的值請參考文件說明部分中的獲取開發者帳號內容
請求包體內容：

{
  "externalQuizId": "123456",
  "type": "MULTIPLE_CHOICE",
  "duration": "45",
  "question": "Which of the following are planets in the solar system?",
  "options": {
    "Moon": "false",
    "Mars": "true",
    "Earth": "true",
    "Sun": "false"
  }
}

請求範例 2

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes
Content-Type: application/json
Authorization: 該欄位的值請參考文件說明部分中的獲取開發者帳號內容
請求包體內容：

{
  "externalQuizId": "123456",
  "type": "TRUE_FALSE",
  "duration": "45",
  "question": "The sun revolves around the Earth",
  "options": {
    "true": "false",
    "false": "true"
  }
}

HTTP 回應

如果返回的 HTTP 狀態碼為 200，表示請求成功。回應包體中包含以下欄位：

欄位	類型	說明
quizId	String	ID
externalQuizId	String	外部 ID
type	String	類型
duration	String	答題時長，單位：秒
question	String	題幹
options	Object	選項
quizStatus	String	狀態

回應範例

{
  "quizId": "260868005909630976",
  "externalQuizId": "123456",
  "type": "MULTIPLE_CHOICE",
  "duration": "45",
  "question": "Which of the following are planets in the solar system?",
  "options": {
    "Moon": "false",
    "Mars": "true",
    "Earth": "true",
    "Sun": "false"
  },
  "quizStatus": "CREATED"
}

2.刪除 Quiz

介面說明

該 API 可用於刪除一個 Quiz，刪除後 Quiz 無法透過查詢介面查詢。

請求方法與接入點

請求方法：DELETE
接入點：/v2/feature-center/quizzes/{id}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
id	Long	true	Quiz ID

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes/260868005909630976
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
  "code": "SYS20000",
  "message": "success"
}

3.查詢 Quiz 列表

介面說明

該 API 可用於分頁查詢機構下的所有 Quiz。

請求方法與接入點

請求方法：GET
接入點：/v2/feature-center/quizzes

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
page	Long	false	當前頁，默認值：0
size	Long	false	分頁大小，默認值：10

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes?page=0&size=10
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
total	Long	總記錄數
page	Long	當前頁
size	Long	分頁大小
data	List	數據集合

響應示例

{
  "total": 1,
  "page": 0,
  "size": 10,
  "data": [
    {
      "quizId": "260868005909630976",
      "externalQuizId": "123456",
      "type": "MULTIPLE_CHOICE",
      "duration": "45",
      "question": "Which of the following are planets in the solar system?",
      "options": {
        "Moon": "false",
        "Mars": "true",
        "Earth": "true",
        "Sun": "false"
      },
      "quizStatus": "CREATED"
    }
  ]
}

VCaaS Lesson Plan API

1. 上傳 Lesson Plan

接口說明

該 API 可用於上傳 lesson Plan 至 VCaaS

請求方法與接入點

請求方法：POST
接入點：/v2/feature-center/lesson-plans

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容。

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
lessonPlanExternalId	String(64)	false	外部Id
topic	String(200)	false	主題
audience	String(500)	false	觀眾
duration	String(200)	false	時長
learningObjective	String(800)	false	目標
language	String(200)	false	語言
additionalInfo	String(1500)	false	額外信息
content	String	true	Lesson plan 內容（Markdown 格式）

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容
請求包體內容：

{
    "lessonPlanExternalId": "123456",
    "topic": "Math",
    "audience": "1st grade student",
    "duration": "1 hour",
    "learningObjective": "",
    "additionalInfo": "",
    "language": "English",
    "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
lessonPlanId	String	教案的唯一標識符
lessonPlanExternalId	String	外部Id
topic	String	主題
audience	String	觀眾
duration	String	時長
learningObjective	String	目標
language	String	語言
additionalInfo	String	額外信息
content	String	Lesson plan 內容（Markdown 格式）

響應示例

{
    "lessonPlanId": "271540816638554112",
    "lessonPlanExternalId": "123456",
    "topic": "Math",
    "audience": "1st grade student",
    "duration": "1 hour",
    "learningObjective": "",
    "additionalInfo": "",
    "language": "English",
    "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
}

2. 刪除 Lesson Plan

接口說明

該 API 可以用於從 VCaaS 刪除 Lesson Plan

請求方法與接入點

請求方法：DELETE
接入點：/v2/feature-center/lesson-plans/{lessonPlanId}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
lessonPlanId	Long	true	教案的唯一標識符

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans/271625972762198016
Content-Type: application/json
Authorization: 該字段的值請參考文檔說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
code	String	VCaaS 系統響應碼
message	String	VCaaS 系統響應提示

響應示例

{
    "code": "SYS20000",
    "message": "success"
}

3. 分頁查詢 Lesson Plan 列表

接口說明

該 API 可用於分頁查詢所有的 Lesson Plan

請求方法與接入點

請求方法：GET
接入點：/v2/feature-center/lesson-plans

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
page	Int	false	當前頁，默認值：0
size	Int	false	分頁大小，默認值：10

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans?page=0&size=10
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
total	Integer	查詢結果的總數量
page	Integer	當前頁碼，從0開始計數
size	Integer	每頁顯示的數量
data	Array	包含查詢結果的數組，每個對象包含以下字段：

data 數組中的對象包含以下字段：

字段	類型	描述
lessonPlanId	String	教案的唯一標識符
lessonPlanExternalId	String	外部Id
topic	String	主題
audience	String	觀眾
duration	String	時長
learningObjective	String	目標
language	String	語言
additionalInfo	String	額外信息
content	String	Lesson plan 內容（Markdown 格式）

響應示例

{
    "total": 90,
    "page": 0,
    "size": 10,
    "data": [
        {
            "lessonPlanId": "271541303442059264",
            "lessonPlanExternalId": "123456",
            "topic": "Math",
            "audience": "1st grade student",
            "duration": "1 hour",
            "learningObjective": "",
            "additionalInfo": "",
            "language": "English",
            "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
        },
        {
            "lessonPlanId": "271541234223460352",
            "lessonPlanExternalId": "123456",
            "topic": "Math",
            "audience": "1st grade student",
            "duration": "1 hour",
            "learningObjective": "",
            "additionalInfo": "",
            "language": "English",
            "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
        }
    ]
}

4. 查詢 Lesson Plan

接口說明

該 API 可通過 LessonPlanId 查詢 Lesson Plan

請求方法與接入點

請求方法：GET
接入點：/v2/feature-center/lesson-plans/{lessonPlanId}

HTTP 請求

路徑參數

該 API 需要在 URL 中傳入以下參數：

參數	類型	必填	描述
lessonPlanId	Long	true	教案的唯一id

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容。

請求包體

請求示例

請求 URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans/271541303442059264
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者賬號內容

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
lessonPlanId	String	教案的唯一標識符
lessonPlanExternalId	String	外部Id
topic	String	主題
audience	String	觀眾
duration	String	時長
learningObjective	String	目標
language	String	語言
additionalInfo	String	額外信息
content	String	Lesson plan 內容（Markdown 格式）

響應示例

{
  
    "lessonPlanId": "271541303442059264",
    "lessonPlanExternalId": "123456",
    "topic": "Math",
    "audience": "1st grade student",
    "duration": "1 hour",
    "learningObjective": "",
    "additionalInfo": "",
    "language": "English",
    "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
  
}

Ai Service (測試版)

說明

AI Service 存取端點如下：

AI Service API 生產環境位址：https://ai.vcaas.hilink.co/api

1. 產生 lesson plan

介面說明

此 API 可用於產生 AI lesson plan

請求方法與存取點

請求方法：POST
接入點：/ai-center/v1/ai-lesson-planner

HTTP 請求

路徑參數

請求頭

Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容

請求包體

該 API 需要在請求包體中傳入以下參數：

參數	類型	必填	描述
topic	String(200)	true	教案主題
audience	String(500)	true	教案受眾
duration	String(200)	true	計畫課程時長
learningObjective	String(800)	false	教學目標
additionalInfo	String(800)	false	額外信息
language	String(200)	false	教案輸出語言

請求示例

請求 URL：https://vcaas.ai.hilink.co/api/ai-center/v1/ai-lesson-planner
Content-Type: application/json
Authorization: 該字段的值請參考文件說明部分中的獲取開發者帳號內容
請求包體內容：

{
    "topic": "Math",
    "audience": "1st grade student",
    "duration": "1 hour",
    "learningObjective": "",
    "additionalInfo": "",
    "language": "English"
}

HTTP 響應

如果返回的 HTTP 狀態碼為 200，表示請求成功。響應包體中包含以下字段：

字段	類型	描述
aiLessonPlanId	String	Lesson plan ID
language	String	語言
additionalInfo	String	額外信息
audience	String	教案受眾
duration	String	計畫課程時長
learningObjective	String	教學目標
topic	String	教案主題
content	String	Lesson plan 內容（Markdown 格式）

響應示例

{
    "aiLessonPlanId": "ALP-LAZ0T7M2cam",
    "topic": "Math",
    "audience": "1st grade student",
    "duration": "1 hour",
    "learningObjective": "",
    "additionalInfo": "",
    "language": "English",
    "content": "# Math Lesson Plan for 1st Grade Students\n\n## Learning Objective:\n- Students will be able to identify and describe the properties of 2D shapes.\n\n## Opening Assessment:\n- Ask students to name as many shapes as they can in 1 minute. This will help the teacher understand the prior knowledge of the students regarding shapes.\n\n## Lesson Plan:\n1. **Introduction to 2D Shapes**\n   - Use a whiteboard to draw and label different 2D shapes (circle, square, triangle, rectangle).\n   - Play a YouTube video showing real-life examples of these shapes.\n   - Ask students to list the shapes they saw in the video.\n\n2. **Properties of Shapes**\n   - Explain the properties of each shape (number of sides, corners, etc.).\n   - Use the annotation tool to allow students to draw the shapes and label their properties.\n   - Quiz: \n     - Question: How many sides does a square have?\n     - Answers: A) 3 B) 4 C) 5\n     - Explanation: A square has 4 sides, so the correct answer is B.\n\n3. **Sorting Shapes**\n   - Show students a mix of different shapes and ask them to sort them into groups based on their properties (number of sides, corners, etc.).\n   - Poll: \n     - Question: Which shape has 3 sides?\n     - Answers: A) Circle B) Triangle C) Square\n     - Explanation: A triangle has 3 sides, so the correct answer is B.\n\n4. **Review and Student Rewards**\n   - Review the properties of each shape with the students.\n   - Give out virtual stickers or points to students who actively participated and answered questions correctly.\n\n## Exit Ticket:\n- Quiz: \n  - Question: How many sides does a triangle have?\n  - Answers: A) 2 B) 3 C) 4\n  - Explanation: A triangle has 3 sides, so the correct answer is B.\n\nBy following this lesson plan, students will have a better understanding of the properties of 2D shapes."
}

# 概述

# VCaaS Meeting API

# 1.創建會議

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 2.更新會議

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 3.結束會議

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 4.查詢會議列表

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 5.查詢會議

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 6.刪除會議

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 7.查詢會議文檔列表

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求

# 請求包體

# 請求示例

# HTTP 響應

# 響應示例

# 8.添加會議文檔

# 介面說明

# 請求方法與接入點

# HTTP 請求

# 路徑參數

# 請求頭

# 請求包體

# 請求示例

概述

VCaaS Meeting API

1.創建會議

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

2.更新會議

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

3.結束會議

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

4.查詢會議列表

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

5.查詢會議

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

6.刪除會議

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例

HTTP 響應

響應示例

7.查詢會議文檔列表

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求

請求包體

請求示例

HTTP 響應

響應示例

8.添加會議文檔

介面說明

請求方法與接入點

HTTP 請求

路徑參數

請求頭

請求包體

請求示例