1.File conversion message
school account upload file after the transformation can receive this message
Parameter names |
type |
instructions |
Cmd |
String |
type is string,'FileCov' |
FileID |
init |
file conversion ID |
Result |
init |
conversion results:2 is success,3 is error |
Data |
object |
conversion file describe |
└ addTime |
init |
upload time |
└ changeTime |
init |
conversion time |
└ fileName |
string |
file name |
Response sample(The normal return json
packet example)
{
'ActionTime': 1521541032,
'Cmd': 'FileCov',
'Result': 2,
'SID': 1001921,
'Data': {
'addTime': 1521541000,
'changeTime': 1521541032,
'fileName': 'origin'
},
'FileID': 9300
}
2.Test report of equipment outside the classroom
Parameter names |
type |
instructions |
Cmd |
String |
Type is String,'UserCheck' |
UID |
Int64 |
UID of the user |
Data |
Object |
Detailed equipment test results |
└ OperatingSystem |
string |
operating system |
└ ServerName |
string |
servere name |
└ ClientIP |
string |
user IP |
└ CPU |
string |
user CPU |
└ NetworkDelay |
string |
network delay |
└ FrameLoss |
string |
packet loss probability |
└ MicrophoneArbitrary |
number |
The state of the microphone selected by the user(0:undetected,1:normal,2:abnormality) |
└ HeadphoneArbitrary |
number |
The user selects the headset status (0:undetected,1:normal,2:abnormality) |
└ CameraArbitrary |
number |
The user selects the camera status(0:undetected,1:normal,2:abnormality) |
└ EEO_VIDEO_DEVICE_NAME |
string |
Choose the camera device name |
└ EEO_AUDIO_DEVICE_NAME |
string |
Choose the microphone device name |
└ EEO_AUDIO_OUTPUT_NAME |
string |
Choose the headset device name |
└ EEO_DEVICE_LIST |
Object |
The hardware list |
└ camera |
array |
List of all camera device names |
└ micphone |
array |
List of all microphone equipment names |
└ speaker |
array |
List of all speaker equipment names |
└ MicrophoneImpersonal |
number |
Program detects microphone status(0:undetected,1:normal,2:abnormality) |
└ HeadphoneImpersonal |
number |
Program detects headset status((0:undetected,1:normal,2:abnormality) |
└ CameraImpersonal |
number |
Program detects camera status((0:undetected,1:normal,2:abnormality) |
└ MicrophoneAttachment |
string |
Microphone accessories |
└ HeadphoneAttachment |
string |
headset accessories (Temporary is empty) |
└ CameraAttachment |
string |
camera accessories |
└ ClassInVersion |
string |
Client version |
└ Mac |
string |
MAC address |
└ addTime |
string |
Self-checking time(timestamp) |
└ InfoSource |
number |
trigger to upload this self-check :3,The introspection to complete;6, Login successfully ; 7,Self-inspection interrupt; |
Response sample(The normal return json
packet example)
{
"_id" : "5ae021b6e826ef1964cb18d3",
"ActionTime" : 1524638134,
"UID" : 1577526,
"Cmd" : "UserCheck",
"SID" : 1228552,
"Data" : {
"MicrophoneArbitrary" : null,
"ClassInVersion" : "2.1.2.123",
"OperatingSystem" : "Windows 7",
"FrameLoss" : "0%",
"EEO_AUDIO_DEVICE_NAME" : "",
"CameraImpersonal" : 0,
"addTime" : 1524638134,
"CPU" : "Intel(R) Core(TM) i5-6300U CPU @ 2.40GHz",
"EEO_AUDIO_OUTPUT_NAME" : "",
"Mac" : "00:FF:B3:D7:DC:D2",
"CameraArbitrary" : null,
"HeadphoneImpersonal" : 0,
"EEO_VIDEO_DEVICE_NAME" : "",
"ServerName" : "EEO-A1012 (Auto)",
"HeadphoneAttachment" : "",
"ClientIP" : "59.60.9.*",
"MicrophoneAttachment" : "https://root_url/upload/autocheck/",
"EEO_DEVICE_LIST" : "{\"camera\": [\"Logitech HD Webcam C270\"], \"micphone\": [\"HD Webcam C270\"], \"speaker\": [\"LG HDR 4K\"]}",
"MicrophoneImpersonal" : 0,
"CameraAttachment" : "",
"HeadphoneArbitrary" : null,
"InfoSource" : 3,
"NetworkDelay" : "50ms"
}
}
3. Account Cancellation
This message is sent to schools after the user cancel the account on the ClassIn client.
After receiving the message, schools need to update the relevant user data table, because after the account is cancelled, it cannot be added as a teacher or student to the school or as a member of a lesson (as teacher, co-teacher or student), or set as a course member (as a course advisor, student, or auditor).
Parameter names |
type |
instructions |
Cmd |
String |
'AccountCancellation' |
UID |
Int |
User's UID |
CancellationTime |
Int |
Account cancellation operation time |
AccountStatus |
Int |
255 indicates that the UID is cancelled already. |
Response sample(The normal return json
packet example)
{
"Cmd":"AccountCancellation",
"SID":1001920,
"UID":100191,
"CancellationTime":1524638134
"AccountStatus":255
}
4. Change the mobile phone number of the account
When the user changes the mobile phone number of the account on the ClassIn client, the schools can receive this message.
After receiving this message, schools need to update the relevant user data table and replace the old mobile number with the new one. Other data will not be affected.
Parameter names |
type |
instructions |
Cmd |
String |
'ReplacePhoneNumber' |
UID |
Int |
User's UID |
ReplaceTime |
Int |
Operation time of changing mobile phone number |
Telephone |
String |
New phone number of the UID |
Email |
String |
Email address of the UID |
Response sample(The normal return json
packet example)
{
"Cmd":"ReplacePhoneNumber",
"SID":1001920,
"UID":100191,
"ReplaceTime":1524638134
"Telephone":18600000000
}
5. Set Sub-account
After the administrator successfully adds/edits the sub account in the eeo's Admin Dashboard, this message will be sent.
Parameter names |
type |
instructions |
Cmd |
String |
'setSubAccount' |
UID |
int |
UID of the user added as the sub-account |
Telephone |
String |
Mobile phone number corresponding to UID |
Email |
String |
Email address of the UID |
RemarkName |
String |
Nickname of UID user |
PermissionList |
String |
The operation permission list assigned to the UID. The separator between the numbers is comma. The meaning of the number is as follows: 1 course management and lesson data, 3 school resources, 3_1 permission to delete school data, 3_2 permission to download school data, 4 teacher management, 5 student management, 7 course supervision and account quick check, 9 API integration documents, 10 financial center, 11 teaching data, 12 school settings, 13 storage management, 16 homework management, 17 resource commodities, 20 live broadcast and playback, 22 test management |
SetTime |
int |
Time of setting sub account |
Response sample(The normal return json
packet example)
{
"Cmd":"setSubAccount",
"SID":1001920,
"UID":100191,
"Telephone":"18600000000",
"RemarkName":"Zhang San",
"PermissionList":"1,3,3_1,4,5",
"SetTime":1524638134
}