HiLink Docs

Overview

Using the VCaaS Open API can help third-party quickly integrate VCaaS virtual classrooms. It includes two parts: VCaaS Meeting API and VCaaS File API.

VCaaS Open API quality environment address: https://uat.vcaas.hilinkdemo.com/api
VCaaS Open API production environment address: https://vcaas.hilink.co/api

VCaaS Meeting API

1. Create Meeting

API Description

This API is used to create a new meeting. After a successful request, the response will return the meeting ID meetingId and meeting URL meetingUrl. The meeting ID meetingId will be used as a parameter to generate the JoinToken, and the meeting URL meetingUrl will be used to construct the meeting JoinUrl.

Request Method and Endpoint

Request Method: POST
Endpoint: /v2/meeting-center/meetings

HTTP Request

Path Parameters

Request Headers

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the request body:

Parameter	Type	Required	Note
meetingExternalId	String(64)	true	External Meeting ID
meetingTitle	String(100)	true	Meeting Title
startTime	Long	false	Meeting Start Time，UTC Timestamp，Unit：Second, Default: current time
endTime	Long	true	Meeting End Time，UTC Timestamp，Unit：Second
timerStartTime	Long	false	Timer Start Time，UTC Timestamp，Unit：Second, Default: startTime
timerEndTime	Long	false	Timer End Time，UTC Timestamp，Unit：Second, Default: endTime
timerCountdown	Integer	false	Countdown to Timer End Time，Unit：Minutes, Default: 5
callbackUrl	String	false	URL to send data after meeting ends
redirectUrl	String	false	URL to redirect to after meeting ends
invitationUrl	String	false	URL of in classroom invitation link
meetingRegion	String	false	Location of meeting host server.
config	Object	false	Meeting configuration
realTimeCallbackUrl	Object	false	Callback URLs for realtime event data push
docIds	List	false	IDs of documents associated with the meeting
lessonPlanIds	List	false	IDs of lesson plans associated with the meeting (Note: Accepts both lessonPlanId and aiLessonPlanId)
quizIds	List	false	Quiz ID collection

config Parameter Details:

Parameter	Type	Default Value	Note
enableChat	Boolean	true	Toggle on/off chat functionality
enableRecording	Boolean	true	Toggle on/off recording functionality
enableFiles	Boolean	true	Toggle on/off uploaded files functionality
enableQuiz	Boolean	true	Toggle on/off quiz functionality
enablePoll	Boolean	true	Toggle on/off poll functionality
enableScreenShare	Boolean	true	Toggle on/off screen share functionality
enableReward	Boolean	true	Toggle on/off student reward functionality
enableYoutubePlayer	Boolean	true	Toggle on/off YouTube player functionality
enableWaitingRoom	Boolean	true	Toggle on/off waiting room before class
enableAutoRecording	Boolean	false	Toggle on/off auto start recording when class begins functionality
enableWebLinks	Boolean	true	Toggle on/off WebLinks functionality (HTML 5)
enableCountdown	Boolean	true	Toggle on/off countdown timer functionality
enableNameRandomizer	Boolean	true	Toggle on/off name randomizer functionality (name selection wheel)
enableDice	Boolean	true	Toggle on/off dice
enableCalculator	Boolean	true	Toggle on/off graphing calculator functionality
enableAfterClassEval	Boolean	false	Toggle on/off after class evaluation functionality (classroom experience evaluation)
enableClassroomInvitation	Boolean	false	Toggle on/off in classroom invitation link functionality
enableRecordingButton	Boolean	true	Toggle on/off the recording button
enableRecordingPermission	Boolean	true	Toggle on/off the recording permission pop-up
enableEndButton	Boolean	true	Toggle on/off the end/exit class button
enableBreakoutGroup	Boolean	true	Toggle on/off the Breakout Group functionality
enableReaction	Boolean	true	Toggle on/off the Reaction functionality
recordingFileTypes	List	["mp4"]	Specify recording file types. Options: ["mp4"]、["mp3", "mp4"].
enableLessonPlan	Boolean	false	Toggle on/off the Lesson Plan functionality
enableNearpod	Boolean	true	Toggle on/off the Nearpod functionality
enableBrowserRecBanner	Boolean	false	Toggle on/off to prompt non-Chrome users to use the Chrome browser
enableBrowserUpdatePrompt	Boolean	true	Toggle on/off to control the display of the browser update prompt feature
enableStudentSendChatFile	Boolean	true	Toggle on/off to enable students sending files in chat
enableTeacherOnboarding	Boolean	false	Toggle on/off to enable the onboarding animation feature for first-time teachers
defaultView	String	"sidebar"	Specify default views. Options: "sidebar", "gallery", "whiteboard"

meetingRegion Available Locations:

The default meeting region is: Asia Pacific (Tokyo) ap-northeast-1. We recommend to select the nearest meeting region based on the attendees’ locations.

Location	Value
Asia Pacific (Mumbai)	`ap-south-1`
Asia Pacific (Seoul)	`ap-northeast-2`
Asia Pacific (Singapore)	`ap-southeast-1`
Asia Pacific (Sydney)	`ap-southeast-2`
Asia Pacific (Tokyo)	`ap-northeast-1`
Canada (Central)	`ca-central-1`
Europe (Frankfurt)	`eu-central-1`
Europe (Ireland)	`eu-west-1`
Europe (London)	`eu-west-2`
Europe (Paris)	`eu-west-3`
Europe (Stockholm)	`eu-north-1`
South America (São Paulo)	`sa-east-1`
US East (Ohio)	`us-east-2`
US East (N. Virginia)	`us-east-1`
US West (N. California)	`us-west-1`
US West (Oregon)	`us-west-2`

Request Example

Request URL: https://vcaas.hilink.co/api/v2/meeting-center/meetings
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request body:

{
  "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 Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
meetingExternalId	String	meeting ID
meetingTitle	String	meeting title
meetingId	String	meeting ID, JoinToken’s param
meetingUrl	String	meeting Url
startTime	Long	Meeting Start Time，UTC Timestamp，Unit：Second
endTime	Long	Meeting End Time，UTC Timestamp，Unit：Second
timerStartTime	Integer	Timer Start Time，UTC Timestamp，Unit：Second
timerEndTime	Integer	Timer End Time，UTC Timestamp，Unit：Second
meetingStatus	String	Meeting Status

Response Example

{
  "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. Update Meeting

API Description

This API is used to update a created but not yet started meeting. After a successful request, the response will return the meeting ID meetingId and meeting URL meetingUrl. The meeting ID meetingId will be used as a parameter to generate the JoinToken, and the meeting URL meetingUrl will be used to construct the meeting JoinUrl.

Note: Meetings that have passed their start time cannot be updated or modified.

Request Method and Endpoint

Request Method: PATCH
Endpoint: /v2/meeting-center/meetings/{id}

HTTP Request

Path Parameters

This API requires the following parameters to be passed in the URL:

Parameters	Type	Required	Note
id	Long	true	Meeting ID

Request Headers

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the request body:

Parameter	Type	Required	Note
meetingTitle	String(100)	false	Meeting Title
startTime	Long	false	Meeting Start Time，UTC Timestamp，Unit：Second
endTime	Long	false	Meeting End Time，UTC Timestamp，Unit：Second
timerStartTime	Long	false	Timer Start Time，UTC Timestamp，Unit：Second
timerEndTime	Long	false	Timer End Time，UTC Timestamp，Unit：Second
timerCountdown	Integer	false	Countdown to Timer End Time，Unit：Minutes
callbackUrl	String	false	URL to send data after meeting ends
redirectUrl	String	false	URL to redirect to after meeting ends
invitationUrl	String	false	URL of the in-class invitation link
meetingRegion	String	false	Location of meeting host server
config	Object	false	Meeting configurations
realTimeCallbackUrl	Object	false	Callback URLs for realtime event data push
docIds	List	false	IDs of documents associated with the meeting
lessonPlanIds	List	false	IDs of lesson plans associated with the meeting (Note: Accepts both lessonPlanId and aiLessonPlanId)
quizIds	List	false	Quiz ID collection

config Parameter Details:

Parameter	Type	Note
enableChat	Boolean	Toggle on/off chat functionality
enableRecording	Boolean	Toggle on/off recording functionality
enableFiles	Boolean	Toggle on/off uploaded files functionality
enableQuiz	Boolean	Toggle on/off quiz functionality
enablePoll	Boolean	Toggle on/off poll functionality
enableScreenShare	Boolean	Toggle on/off screen share functionality
enableReward	Boolean	Toggle on/off student reward functionality
enableYoutubePlayer	Boolean	Toggle on/off YouTube player functionality
enableWaitingRoom	Boolean	Toggle on/off waiting room before class
enableAutoRecording	Boolean	Toggle on/off auto start recording when class begins functionality
enableWebLinks	Boolean	Toggle on/off WebLinks functionality (HTML 5)
enableCountdown	Boolean	Toggle on/off countdown timer functionality
enableNameRandomizer	Boolean	Toggle on/off name randomizer functionality (name selection wheel)
enableCalculator	Boolean	Toggle on/off graphing calculator functionality
enableAfterClassEval	Boolean	Toggle on/off after class evaluation functionality (classroom experience evaluation)
enableClassroomInvitation	Boolean	Toggle on/off in classroom invitation link functionality
enableRecordingButton	Boolean	Toggle on/off the recording button
enableRecordingPermission	Boolean	Toggle on/off the recording permission pop-up
enableEndButton	Boolean	Toggle on/off the end/exit class button
enableBreakoutGroup	Boolean	Toggle on/off the Breakout Group functionality
enableReaction	Boolean	Toggle on/off the Reaction functionality
recordingFileTypes	List	Specify recording file types. Options: ["mp4"]、["mp3", "mp4"].
enableLessonPlan	Boolean	Toggle on/off the Lesson Plan functionality
enableNearpod	Boolean	Toggle on/off the Nearpod functionality
enableBrowserRecBanner	Boolean	Toggle on/off to prompt non-Chrome users to use the Chrome browser
enableBrowserUpdatePrompt	Boolean	Toggle on/off to control the display of the browser update prompt feature
enableStudentSendChatFile	Boolean	Toggle on/off to enable students sending files in chat
enableTeacherOnboarding	Boolean	Toggle on/off to enable the onboarding animation feature for first-time teachers
defaultView	String	Specify default views. Options: "sidebar", "gallery", "whiteboard"

meetingRegion Available Locations:

Location	Value
Asia Pacific (Mumbai)	`ap-south-1`
Asia Pacific (Seoul)	`ap-northeast-2`
Asia Pacific (Singapore)	`ap-southeast-1`
Asia Pacific (Sydney)	`ap-southeast-2`
Asia Pacific (Tokyo)	`ap-northeast-1`
Canada (Central)	`ca-central-1`
Europe (Frankfurt)	`eu-central-1`
Europe (Ireland)	`eu-west-1`
Europe (London)	`eu-west-2`
Europe (Paris)	`eu-west-3`
Europe (Stockholm)	`eu-north-1`
South America (São Paulo)	`sa-east-1`
US East (Ohio)	`us-east-2`
US East (N. Virginia)	`us-east-1`
US West (N. California)	`us-west-1`
US West (Oregon)	`us-west-2`

Request Example

Request URL: https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request body:

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
meetingExternalId	String	meeting ID
meetingTitle	String	meeting title
meetingId	String	meeting ID, JoinToken’s param
meetingUrl	String	meeting Url
startTime	Long	Meeting Start Time，UTC Timestamp，Unit：Second
endTime	Long	Meeting End Time，UTC Timestamp，Unit：Second
timerStartTime	Integer	Timer Start Time，UTC Timestamp，Unit：Second
timerEndTime	Integer	Timer End Time，UTC Timestamp，Unit：Second
meetingStatus	String	Meeting Status

Response Example

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

3. End Meeting

API Description

This API can be used to actively end a meeting that is in progress.

Request Method and Access Point

Method：PUT
Path：/v1/meeting-center/meetings/{id}/end

HTTP Request

Path Parameters

This API requires the following parameters to be passed in the URL:

Parameters	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/end
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Description
code	String	VCaaS API response code
message	String	VCaaS API response message

Response Example

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

4. Query the meeting list

API Description

This API can be used to query all meetings under an organization in a paginated manner.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/meeting-center/meetings

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Notes
page	Long	false	Current page, default value: 0
size	Long	false	Page size, default value: 10

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings?page=0&size=10
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it means the request was successful. The response body contains the following fields:

Fields	Type	Note
total	Long	Total record count
page	Long	Current page
size	Long	Page size
data	List	Data collection

Response Example

{
  "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": 1673062042,
      "timerEndTime": 1673755042,
      "meetingStatus": "CREATED"
    }
  ]
}

5. Query Meeting

API Description

This API can be used to query a single meeting based on the meeting ID.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/meeting-center/meetings/{id}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
meetingExternalId	String	External Meeting ID
meetingTitle	String	Meeting Name
meetingId	String	Meeting ID, which will be used as a parameter to generate JoinToken
meetingUrl	String	Meeting URL, used to concatenate the meeting link
startTime	Long	Meeting start time, UTC timestamp, unit: seconds
endTime	Long	Meeting end time, UTC timestamp, unit: seconds
timerStartTime	Integer	Timer start time, UTC timestamp, unit: seconds
timerEndTime	Integer	Timer end time, UTC timestamp, unit: seconds
meetingStatus	String	Meeting status

Response Example

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

6. Delete Meeting

API Description

This API can be used to delete a meeting. After deletion, the meeting will not be retrievable through the query interface.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v1/meeting-center/meetings/{id}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

7. Query Meeting Document List

API Description

This API can be used to query the collection of documents for a specified meeting.

Request Method and Endpoint

Request Method：GET
Endpoint：/v1/meeting-center/meetings/{id}/documents

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docId	String	Document ID
name	String	Document Name
type	String	Document Type
fileKey	String	Document Key
fileStatus	String	Document Status
fileSize	Long	Document Size
children	List	Children files (only applicable to folders)

Response Example

[
  {
    "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. Add Meeting Document

API Description

This API can be used to add one or more documents or folders to a specified meeting.

Request Method and Endpoint

Request Method：POST
Endpoint：/v1/meeting-center/meetings/{id}/documents

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
docIds	List	true	Document and folder ID collection

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content：

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

9. Delete Meeting Document

API Description

This API can be used to delete a specified document from a specified meeting.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v1/meeting-center/meetings/{id}/documents/{docId}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID
docId	Long	true	Document ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/documents/101102960439857152
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

10. Query Meeting Recording List

API Description

This API can be used to query the recording videos of a meeting.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/meeting-center/meetings/{id}/recordings

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271373502823706624/recordings
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
meetingId	String	Meeting ID
meetingTitle	String	Meeting Title
recordingTitle	String	Video Title
videoUrl	String	Video URL
audioUrl	String	Audio URL (if recordingFileTypes configured with mp3 format in create meeting API)
beginTime	Long	Begin Time
endTime	Long	End Time

Response Example

[
  {
    "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. Query Meeting Metadata

API Description

This API can be used to query the data generated during a meeting, including meeting duration data, attendee attendance data, meeting recording data, meeting interaction data, and attendee interaction data.

Request Method and Endpoint

Request Method：GET
Endpoint：/v1/meeting-center/meetings/{id}/data

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/data
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
meetingData	Object	Meeting Length Data
attendeeDatas	Object	Meeting Attendance Data
meetingVideoData	Object	Meeting Video Data
meetingInteractiveData	Object	Meeting Interaction Data
attendeeInteractiveDatas	Object	Meeting Attendee Interaction Data
evaluationData	Object	After-class evaluation data

Response Example

{
  "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.Add Quiz to Meeting

API Description

This API can be used to add one or more quizzes to a specified meeting.

Request Method and Endpoint

Request Method：POST
Endpoint: /v2/meeting-center/meetings/{id}/quizzes

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
quizIds	List	true	Quiz ID collection

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content：

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

13.Delete Meeting Quiz

API Description

This API can be used to delete a specified quiz from a specified meeting.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v2/meeting-center/meetings/{id}/quizzes/{quizId}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID
quizId	Long	true	Quiz ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes/260868005909630976
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

14.Query Meeting Quiz List

API Description

This API can be used to query the quizzes of a meeting.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/meeting-center/meetings/{id}/quizzes

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/quizzes
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
quizId	String	Quiz ID
externalQuizId	String	Unique identifier assigned by the client's system for referencing quizzes in VCaaS
type	String	Quiz Type
duration	String	Duration of the question, in seconds
question	String	Question content
options	Object	The question's available answer options
quizStatus	String	Quiz status

Response Example

[
  {
    "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. Query Meeting Chat Data

Interface Description

This API can be used to query chat data for a specified meeting. Note: The current version of the interface is limited to querying chat data generated only in the main meeting, excluding chat data from discussion groups.

Request Method and Endpoint

Request Method: GET
Endpoint: /v2/meeting-center/meetings/{id}/chatMessage

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL: https://vcaas.hilink.co/api/v2/meeting-center/meetings/109391932341489664/chatMessage
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
meetingExternalId	String	Meeting External ID
meetingTitle	String	Meeting Title
meetingId	String	Meeting ID
classChat	List	Class Message List

Structure of the classChat field:

Fields	Type	Note
sender	String	Sender of the message
timestamp	Long	Message sending timestamp (seconds)
message	String	Message content
hasRecalled	Boolean	Whether the message has been recalled

Response Example

{
    "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.Add Meeting Lesson Plan

API Description

This API is used to add a lesson plan to a meeting.

Request Method and Endpoint

Request Method：POST
Endpoint：/v2/meeting-center/meetings/{id}/lesson-plans

HTTP Request

Path Parameters

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the request body:

Parameter	Type	Required	Note
lessonPlanIds	List	true	Array of unique identifiers for lesson plans

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271625972762198016/lesson-plans
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field
Request Body Content:

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS system response code
message	String	VCaaS system response message

Response Example

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

17.Query Meeting Lesson Plan List

API Description

This API is used to query the complete list of lesson plans for a meeting.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/meeting-center/meetings/{id}/lesson-plans

HTTP Request

Path Parameter

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/meeting-center/meetings/271625972762198016/lesson-plans
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
lessonPlanId	String	Unique identifier for the lesson plan
lessonPlanExternalId	String	External identifier
topic	String	Topic name
audience	String	Target audience
duration	String	Course duration
learningObjective	String	Learning objectives
language	String	Language
additionalInfo	String	Additional information
content	String	Course content, supports Markdown format

Response Example

[
  {
        "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.Delete Meeting Lesson Plan

API Description

This API is used to delete a lesson plan from a meeting.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v2/meeting-center/meetings/{id}/lesson-plans/{lessonPlanId}

HTTP Request

Path parameter

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID
lessonPlanId	String	true	Lesson Plan ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://test.vcaas.hilinkdemo.com/api/v2/meeting-center/meetings/271625972762198016/lesson-plans/271541303442059264
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS system response code
message	String	VCaaS system response message

Response Example

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

19.Delete Meeting Recordings

API Description

This API can be used to delete recordings from a specified meeting.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v1/meeting-center/meetings/{id}/videos

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Meeting ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/meeting-center/meetings/109391932341489664/videos
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

VCaaS File API

1. Create document upload URL

API Description

This API can be used to obtain the upload address for a file

Request Method and Endpoint

Request Method：POST
Endpoint：/v1/document-center/upload-urls

HTTP Request

Path Parameters

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
key	String(200)	true	Document Key
duration	Integer	true	Upload address link validity duration, unit: minutes
callback	String	true	Callback URL for document upload completion
parentId	String	false	Document ID of folder in which the file will be uploaded to

Request Example

Request URL：https://vcaas.hilink.co/api/v1/document-center/upload-urls
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content：

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docId	String	Document ID
url	String	Upload URL

Response Example

{
  "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. Get Document List

API Description

This API can be used to paginate through all documents under an organization.

Request Method and Endpoint

Request Method：GET
Endpoint：/v1/document-center/documents

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
keyword	String	false	Search keyword(s)
status	String	false	Document Status：presign，uploaded
page	Int	false	Current page，default value：0
size	Int	false	Page size，default value：10

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/document-center/documents
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docId	String	Document ID
parentId	String	Document ID of the parent folder (returns 0 if no parent)
name	String	Document Name
type	String	Document Type
fileKey	String	Document Key
fileStatus	String	Document Status
fileSize	Long	Document Size，Unit：Byte

Response Example

{
  "total": 1,
  "page": 1,
  "size": 10,
  "data": [
    {
      "docId": "99221259577069568",
      "parentId": "0",
      "name": "example.doc",
      "type": "doc",
      "fileKey": "91232529172008960/example.doc",
      "fileStatus": "uploaded",
      "fileSize": 69632
    }
  ]
}

3. Query Specific Document or Folder

API Description

This API can be used to query a specified document or folder based on its Document ID. When a folder in queried all children documents and folders will also be returned.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/document-center/documents/{id}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Document ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/document-center/documents/217665352530874368
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docId	String	Document ID
name	String	Document Name
type	String	Document Type
fileKey	String	Document Key
fileStatus	String	Document Status
fileSize	Long	Document Size，Unit：Byte
children	List	Children files (only for folders)

Response Example

{
  "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/aPresentation1.ppt",
      "fileStatus":"uploaded",
      "fileSize":41472
    },
    {
      "docId":"189671712768528384",
      "name":"staticimage.png",
      "type":"png",
      "fileKey":"130840909813256192/189671712768528384/static watermark.png",
      "fileStatus":"uploaded",
      "fileSize":1078178
    }
  ]
}

4. Create Folder

API Description

This API can be used to create a new folder in the document center

Request Method and Endpoint

Request Method：POST
Endpoint：/v1/document-center/folder

HTTP Request

Path Parameters

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the request body:

Parameter	Type	Required	Note
name	String	true	Folder name
parentId	String	true	ID of parent folder the new folder will be created in (0 for no parent folder)

Request Example

Request URL：https://vcaas.hilink.co/api/v1/document-center/folder
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docId	String	Folder ID
name	String	Folder name
parentId	String	Parent folder ID

Response Example

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

5. Delete Document or Folder

API Description

This API can be used to delete a specified document or folder based on its Document ID. When a folder is deleted all children documents and folders are also deleted.

Request Method and Endpoint

Request Method：DELETE
Endpoint：/v2/document-center/documents/{id}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
id	Long	true	Document ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v1/document-center/documents/99221259577069568
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
docIds	List	List of docId of files deleted

Response Example

{
  "docIds":["99221259577069568"]
}

6. Move Document or Folder

API Description

This API can be used to move a document or folder to a new parent location

Request Method and Endpoint

Request Method：POST
Endpoint：/v1/document-center/move-document

HTTP Request

Path Parameters

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the request body:

Parameter	Type	Required	Note
docId	String	true	ID of document or folder that is wanted to be moved
parentId	String	true	Parent ID of desired destination (0 for no parent folder)

Request Example

Request URL：https://vcaas.hilink.co/api/v1/document-center/move-document
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

VCaaS Quiz API

1.Create Quiz

API Description

This API can be used to create and save pre-filled quizzes

Request Method and Endpoint

Request Method：POST
Endpoint：/v2/feature-center/quizzes

HTTP Request

Path Parameters

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
externalQuizId	String(128)	false	Unique identifier assigned by the client's system for referencing quizzes in VCaaS
type	String(100)	true	Quiz Type, options: MULTIPLE_CHOICE, TRUE_FALSE
duration	String(30)	false	Duration of the question, in seconds, options: 15, 30, 45, 60. Default: 45
question	String(65535)	true	Question content
options	Object	true	Options Rules Description： MULTIPLE_CHOICE Rules： - At least one "true" option is required - A minimum of two options is required - The values of options must be either "true" or "false" TRUE_FALSE Rules： - Options can only include "true" and "false" - Only one correct answer is allowed - It is mandatory to have one correct answer

Request Example - MULTIPLE CHOICE

Request URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content:

{
  "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"
  }
}

Request Example - TRUE/FALSE

Request URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content:

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
quizId	String	Quiz ID
externalQuizId	String	Unique identifier assigned by the client's system for referencing quizzes in VCaaS
type	String	Quiz Type
duration	String	Duration of the question, in seconds
question	String	Question content
options	Object	The question's available answer options
quizStatus	String	Quiz status

Response Example

{
  "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.Delete Quiz

API Description

This API can be used to delete a quiz. After deletion, the quiz will not be retrievable through the query interface.

Request Method and Endpoint

Request Method：DELETE
Endpoint: /v2/feature-center/quizzes/{id}

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL：

Parameter	Type	Required	Note
id	Long	true	Quiz ID

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Exmaple

Request URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes/260868005909630976
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
code	String	VCaaS System response code
message	String	VCaaS System response message

Response Example

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

3.Query Quiz List

API Description

This API can be used to query the collection of quizzes for a specified meeting.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/feature-center/quizzes

HTTP Request

Path Parameters

This API requires passing the following parameters in the URL:

Parameter	Type	Required	Note
page	Long	false	Current page, default value: 0
size	Long	false	Page size, default value: 10

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/feature-center/quizzes?page=0&size=10
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
total	Long	Total quiz count
page	Long	Current page
size	Long	Page size
data	List	Data collection

Response Example

{
  "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. Upload Lesson Plan

API Description

This API can be used to upload a lesson plan to VCaaS.

Request Method and Endpoint

Request Method：POST
Endpoint：/v2/feature-center/lesson-plans

HTTP Request

Path Parameters

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
lessonPlanExternalId	String(64)	false	External ID
topic	String(200)	false	Topic of the lesson plan
audience	String(500)	false	Target audience
duration	String(200)	false	Duration of the lesson plan
learningObjective	String(800)	false	Learning objective
language	String(200)	false	Language of the content
additionalInfo	String(1500)	false	Additional information
content	String	true	Content of the lesson plan

Request Example

Request URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content:

{
    "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 Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
lessonPlanId	String	Unique identifier for the lesson plan
lessonPlanExternalId	String	External ID
topic	String	Topic
audience	String	Audience
duration	String	Duration
learningObjective	String	Learning Objective
language	String	Language
additionalInfo	String	Additional information
content	String	Lesson plan content(Markdown format)

Response Example

{
    "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. Delete Lesson Plan

API Description

This API can be used to delete a lesson plan from VCaaS.

Request Method and Endpoint

Request Method: DELETE
Endpoint：/v2/feature-center/lesson-plans/{lessonPlanId}

HTTP Request

Path Parameters

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
lessonPlanId	Long	true	Unique identifier for the lesson plan

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans/271625972762198016
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Response Example

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
code	String	VCaaS system response code
message	String	VCaaS system response message

Response Example

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

3. Paginate Query of Lesson Plan List

API Description

This API can be used to paginate through all lesson plans.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/feature-center/lesson-plans

HTTP Request

Path Parameters

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
page	Int	false	The current page, default value: 0
size	Int	false	Page size, default value: 10

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans?page=0&size=10
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
total	Integer	The total number of results found
page	Integer	The current page number, starting from 0
size	Integer	The number of results per page
data	Array	An array containing the result objects

The objects in the data array contain the following fields:

Field	Type	Note
lessonPlanId	String	Unique identifier for the lesson plan
lessonPlanExternalId	String	External ID
topic	String	Topic
audience	String	Audience
duration	String	Duration
learningObjective	String	Learning Objective
language	String	Language
additionalInfo	String	Additional information
content	String	Lesson plan content(Markdown format)

Response Example

{
    "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. Query Lesson Plan

API Description

This API can be used to query a lesson plan by LessonPlanId.

Request Method and Endpoint

Request Method：GET
Endpoint：/v2/feature-center/lesson-plans/{lessonPlanId}

HTTP Request

Path Parameters

This API requires the following parameter to be passed in the URL:

Parameter	Type	Required	Note
lessonPlanId	Long	true	Unique ID of the lesson plan

Request Header

Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

Request Example

Request URL：https://vcaas.hilink.co/api/v2/feature-center/lesson-plans/271541303442059264
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field

Http Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Field	Type	Note
lessonPlanId	String	Unique identifier for the lesson plan
lessonPlanExternalId	String	External ID
topic	String	Topic
audience	String	Audience
duration	String	Duration
learningObjective	String	Learning Objective
language	String	Language
additionalInfo	String	Additional information
content	String	Lesson plan content(Markdown format)

Response Example

{
  
    "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 (beta)

Overview

AI Service The access endpoints are as follows：

AI Service API production environment address：https://ai.vcaas.hilink.co/api

1. Generate lesson plan

API Description

This API can be used to generate AI lesson plans

Request Method and Endpoint

Request Method：POST
Endpoint：/ai-center/v1/ai-lesson-planner

HTTP Request

Path Parameters

Request Header

Content-Type: application/json Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.

Request Body

This API requires the following parameters to be passed in the Request Body:

Parameter	Type	Required	Note
topic	String(200)	true	Lesson plan topic
audience	String(500)	true	Audience for the lesson
duration	String(200)	true	Duration of the lesson
learningObjective	String(800)	false	Objective of the lesson
additionalInfo	String(800)	false	Additional information
language	String(200)	false	Output language for the lesson plan

Request Example

Request URL：https://vcaas.ai.hilink.co/api/ai-center/v1/ai-lesson-planner
Content-Type: application/json
Authorization: Please refer to the 'Authentication' section in 'Introduction' of the documentation for the value of this field.
Request Body Content：

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

HTTP Response

If the returned HTTP status code is 200, it indicates a successful request. The response body contains the following fields:

Fields	Type	Note
aiLessonPlanId	String	Lesson plan ID
language	String	Output language for the lesson plan
additionalInfo	String	Additional information
audience	String	Audience for the lesson
duration	String	Duration of the lesson
learningObjective	String	Objective of lesson
topic	String	Lesson plan topic
content	String	Lesson plan content Note: output is in Markdown format

Response Example

{
    "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."
}

# Overview

# VCaaS Meeting API

# 1. Create Meeting

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Headers

# Request Body

# Request Example

# HTTP Response

# Response Example

# 2. Update Meeting

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Headers

# Request Body

# Request Example

# HTTP Response

# Response Example

# 3. End Meeting

# API Description

# Request Method and Access Point

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

# HTTP Response

# Response Example

# 4. Query the meeting list

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

# HTTP Response

# Response Example

# 5. Query Meeting

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

# HTTP Response

# Response Example

# 6. Delete Meeting

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

# HTTP Response

# Response Example

# 7. Query Meeting Document List

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

# HTTP Response

# Response Example

# 8. Add Meeting Document

# API Description

# Request Method and Endpoint

# HTTP Request

# Path Parameters

# Request Header

# Request Body

# Request Example

Overview

VCaaS Meeting API

1. Create Meeting

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Headers

Request Body

Request Example

HTTP Response

Response Example

2. Update Meeting

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Headers

Request Body

Request Example

HTTP Response

Response Example

3. End Meeting

API Description

Request Method and Access Point

HTTP Request

Path Parameters

Request Header

Request Body

Request Example

HTTP Response

Response Example

4. Query the meeting list

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Header

Request Body

Request Example

HTTP Response

Response Example

5. Query Meeting

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Header

Request Body

Request Example

HTTP Response

Response Example

6. Delete Meeting

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Header

Request Body

Request Example

HTTP Response

Response Example

7. Query Meeting Document List

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Header

Request Body

Request Example

HTTP Response

Response Example

8. Add Meeting Document

API Description

Request Method and Endpoint

HTTP Request

Path Parameters

Request Header

Request Body

Request Example