Add class section
<h5>Interface introduction</h5>
<p>-Add a class section interface to create a class section and add a series of configuration information of the class section, including teachers, students, and the beginning and ending time of the class, as well as the video configuration information of the class, video resolution, music class mode, classroom layout mode, whether the class is supervised by pictures, the number of people on the stage, and whether the member information is checked, and sid, timestamp, sign are required. See the list of form parameters for details.</p>
<h5>Interface Information</h5>
<table>
<thead>
<tr>
<th style="text-align: left;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">URL</td>
<td style="text-align: left;"><a href="https://neukol.axzt.net/edu_openapi/booking/class/create">https://neukol.axzt.net/edu_openapi/booking/class/create</a></td>
</tr>
<tr>
<td style="text-align: left;">HTTP Request Methods</td>
<td style="text-align: left;">POST</td>
</tr>
<tr>
<td style="text-align: left;">Coding format</td>
<td style="text-align: left;">UTF-8</td>
</tr>
</tbody>
</table>
<h5>Header</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Is it necessary to choose</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
</tr>
</tbody>
</table>
<h5>Form parameters</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: center;">Description</th>
<th style="text-align: left;">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">sid</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: center;">Institution ID</td>
<td style="text-align: left;">5f1140092302bd0ac2dbc7c4</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: center;">Fixed 32-bit all lowercase characters, institution authentication security key，sign=MD5(params+SECRET)，Among them, params represents the concatenated string of all parameters in the request body except sign in lexicographic order（like: "key1=value1key2=value2"）</td>
<td style="text-align: left;">c09636a3a529a386fdaa389228e36fac</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">True</td>
<td style="text-align: center;">Unix Epoch timestamp within 20 minutes of current calling interface, unit: milliseconds</td>
<td style="text-align: left;">1600140360000</td>
</tr>
<tr>
<td style="text-align: left;">courseId</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Class ID</td>
<td style="text-align: left;">123</td>
</tr>
<tr>
<td style="text-align: left;">className</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: center;">Class section name</td>
<td style="text-align: left;">The first lesson of Ma teacher ' s lecture</td>
</tr>
<tr>
<td style="text-align: left;">teacher</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: center;">Teacher ID<br>Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account（like: tea00001）<br>Format 2 : country code + character' # ' + mobile phone number, indicating mobile phone account number（like: 86#15751860597）</td>
<td style="text-align: left;">teacher0010</td>
</tr>
<tr>
<td style="text-align: left;">startTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Class start timestamp, default for the current operation timestamp, unit : milliseconds.</td>
<td style="text-align: left;">1605672882910</td>
</tr>
<tr>
<td style="text-align: left;">endTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Class section deadline timestamp ( once the deadline of the class is reached, the class in the class will automatically end, please configure the end time of the class reasonably ), the default is 24 hours after the start time, unit : millisecond</td>
<td style="text-align: left;">1605672883910</td>
</tr>
<tr>
<td style="text-align: left;">readyTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Class section preparation time, indicating how long before the start time can enter, unit : milliseconds</td>
<td style="text-align: left;">600000</td>
</tr>
<tr>
<td style="text-align: left;">extraTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Drag time of the class, which means that more time will not end after the end, unit: milliseconds</td>
<td style="text-align: left;">600000</td>
</tr>
<tr>
<td style="text-align: left;">students</td>
<td style="text-align: left;">List</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Student ID set<br>Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account（like: tea00001）<br>Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number（like: 86#15751860597）</td>
<td style="text-align: left;">[stu0011,stu0012]</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Institution customizes the class section typr</td>
<td style="text-align: left;">Mathematics / Physics / Chinese language and literature</td>
</tr>
<tr>
<td style="text-align: left;">resolutionType</td>
<td style="text-align: left;">ENUM</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Video resolution RESOLUTION <em> 480P ( standard definition ), RESOLUTION </em> 720P ( high definition ), RESOLUTION _ 1080P ( full high definition ), not configured for mechanism configuration</td>
<td style="text-align: left;">RESOLUTION_480P</td>
</tr>
<tr>
<td style="text-align: left;">picMonitor</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Whether to monitor the picture ( if you open the picture monitor, you can query the monitor picture data in the specified class by querying the monitor picture interface ), not configured to take the organization configuration</td>
<td style="text-align: left;">false</td>
</tr>
<tr>
<td style="text-align: left;">music</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Sound mode ( 1 - high fidelity music ; 0 − clear voice ), without institutional configuration, default 0</td>
<td style="text-align: left;">0</td>
</tr>
<tr>
<td style="text-align: left;">platformCount</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Number of arrivals, current options : 2, 7, representing 1V1, 1V6 respectively, not configured for institutional configuration, defaulted to 7</td>
<td style="text-align: left;">7</td>
</tr>
<tr>
<td style="text-align: left;">checkMember</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Check members ( if open, enter the class, will determine whether the user is a student or teacher specified in the booking class, if not, cannot enter the class ), not configured for institutional configuration</td>
<td style="text-align: left;">false</td>
</tr>
<tr>
<td style="text-align: left;">folderId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Classes can access the cloud disk ID, please ensure that the cloud disk ID exists and can be accessed Please ensure that the cloud disk ID exists and can be accessed ( in cloud disk management support cloud disk directory related operations)</td>
<td style="text-align: left;">5fb36843e5e9be1c861a67ac</td>
</tr>
<tr>
<td style="text-align: left;">cloudRecord</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Cloud recording mode ( can not coexist with local recording, can only open one ) RESOLUTION <em> 720P ( forced to 720p cloud recording ), ALLOW </em> RESOLUTION <em> 720P ( allow teachers to 720p cloud recording, requires the teacher manually click start recording ), NO </em> RECORD ( do not allow cloud recording ), currently open cloud recording is recorded in 720p</td>
<td style="text-align: left;">NO_RECORD</td>
</tr>
<tr>
<td style="text-align: left;">localRecord</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Local recording mode ( can not coexist with the cloud recording, can only open one ) ALLOW <em> RECORD ( allow teachers to local recording ), NO </em> RECORD ( do not allow local recording ).</td>
<td style="text-align: left;">NO_RECORD</td>
</tr>
<tr>
<td style="text-align: left;">assistant</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Assistant <br>Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account（like: tea00001）<br>Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number（like: 86#15751860597）</td>
<td style="text-align: left;">assistant_id</td>
</tr>
<tr>
<td style="text-align: left;">teacherPlayback</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Whether to open the teacher and teaching assistant in the client view playback permissions, default closed</td>
<td style="text-align: left;">false</td>
</tr>
<tr>
<td style="text-align: left;">studentPlayback</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: center;">Open the permissions for students to view playback on the client，default closed</td>
<td style="text-align: left;">false</td>
</tr>
</tbody>
</table>
<h5>Response parameter description</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Type</th>
<th>Desciption</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">responseHeader</td>
<td style="text-align: left;">Object</td>
<td>Response header information</td>
</tr>
<tr>
<td style="text-align: left;"> └status</td>
<td style="text-align: left;">int</td>
<td>Neukol API status code</td>
<td>200</td>
</tr>
<tr>
<td style="text-align: left;"> └msg</td>
<td style="text-align: left;">String</td>
<td>error message</td>
<td>OK</td>
</tr>
<tr>
<td style="text-align: left;">response</td>
<td style="text-align: left;">Object</td>
<td>Response body content</td>
</tr>
<tr>
<td style="text-align: left;"> └classroomId</td>
<td style="text-align: left;">String</td>
<td>reservation class ID ( the integrator needs to save this class id )</td>
<td>5fb37586e845541cf8e6bf25</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/booking/class/create HTTP/1.1
Host: https://neukol.axzt.net
Content-Type: application/x-www-form-urlencoded
timestamp=1598880734439&sid=5f195b1b2302bdedee4809c0&sign=bf972bbd42ef1746b3ccf24c396b4762&className=The first lesson of Ma teacher ‘ s lecture&teacher=teacher0011&students=stu0011,stu0012&startTime=1605672882910&endTime=1605672892910&type=Physics Laboratory</code></pre>
<h5>Response example</h5>
<pre><code> {
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"classroomId": "5f1119e7b1ce8d1b6327f3b1"
}
}</code></pre>
<h5>Error codes</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Error codes</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">2106</td>
<td>The class section icloud information does not exist</td>
</tr>
<tr>
<td style="text-align: left;">321</td>
<td>Parameter format error</td>
</tr>
<tr>
<td style="text-align: left;">2000</td>
<td>sign certification failed</td>
</tr>
<tr>
<td style="text-align: left;">2001</td>
<td>Request timeout</td>
</tr>
<tr>
<td style="text-align: left;">2002</td>
<td>Institution does not open an open interface</td>
</tr>
<tr>
<td style="text-align: left;">2010</td>
<td>Institution is inexistent</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td>Unknown anomalies at the server</td>
</tr>
<tr>
<td style="text-align: left;">211</td>
<td>Phone number format error</td>
</tr>
</tbody>
</table>