Documentation
Documentation
Demo APP
SDK 中心
API 中心
FAQ
代码市场
Console
Sign Up
Log In
中文站 English
Large Classes
  • Large Classes
Expand All
  • Overview
  • Demo App
  • Sample Codes
  • SDK Integration
  • Teacher-Side Implementation
  • Student-Side Implementation
  • GoClass Backend Service
  • Error Codes
  • Documentation
  • Large Classes
  • GoClass Backend Service
  • End a Class

End a Class

Last updated：2022-03-22 13:06

1 Description

Call end_teaching to end a class, which will log all members out of the current classroom and then immediately destroy the classroom.

API call frequency limit: 10 times/second.

Only teachers have the authority to end a class.

2 API Prototype

  • Request method: POST
  • Request endpoint: /edu_room/end_teaching
  • Transmission protocol: application/json

3 Request Parameters

Parameter Type Mandatory Example Description
room_id String Yes "123456" Room ID of the classroom, a string with a maximum of 9 characters and contains only digits.
uid Int64 Yes 171171717 User ID.
room_type Int32 No 2 Room type.

Valid values :
  • 1: Small class
  • 2: Large class
Defaults to "Small class" if not specified.

4 Request Example

{
  "uid":171171717,
  "room_id":"123456"
}

5 Response Parameters

None.

6 Response Example

{
  "ret": {
    "code": 0,
    "message": "succeed"
  }
}

7 Return Codes

Return Code Description
10003 The user does not have the authority to end the class.
10005 Please log in to the classroom first.
10006 The classroom does not exist.
Page Directory
  • Free trial