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
}

6. Financial Order Data

Every order in the institution account is pushed in real time once it succeeds, including balance-increasing orders such as top-ups and grants, as well as balance-decreasing orders such as class consumption, recording, and storage.

For the following order types, order details are pushed together with the order: Class Consumption, Recording, Live Streaming Traffic, Storage, SMS, Voice Call, and Super Customer Service.

  • All amounts are in cents; all times are Unix timestamps in seconds.
  • An order's content does not change after it succeeds. In rare cases the same order may be pushed more than once, so deduplicate by OrderID.
  • The pushed content is consistent with what is shown on the order details page in the institution admin console.
  • Failed orders are never pushed.
Parameter Type Description
Cmd String Message type, fixed value OrderInfo
OrderID String Order ID
OrderType Integer Order type, see "Order Types" below
OrderTime Integer Order time
OrderSummary String Order summary
OrderAmount Integer Order amount, in cents. Positive for a balance increase, negative for a balance decrease
OrderDetails Object Order details; the structure varies by order type, see "Order Details" below. null for other order types and for refund orders

Order Types

OrderType Order Type In/Out Has Order Details
1 Top up Income -
101 Gift Income -
102 Fault compensation Income -
103 Class compensation Income -
104 Account entry Income -
105 Top-up Income -
201 Lesson Fee Expense Yes
202 Storage Expense Yes
203 Playback Traffic Expense -
204 Upgraded Trial User Expense -
205 Short Messages Expense Yes
206 Voice Call Expense Yes
207 Amount Deducted Expense -
209 Live Traffic Expense Yes
210 ClassIn Service Fee Expense -
211 Recording Expense Yes
215 Account Out Expense -
216 Clear Gift Expense -
217 Super Customer Service Expense Yes
218 Annual minimum charge Expense -
220 Manual deduction Expense -
221 Monthly service fee Expense -
222 Service Fee for Standard Plan Expense -

Order Details

Lesson Fee (OrderType = 201)

When a class allows overrun entry, billing is based on each member's actual attendance duration, and the order amount follows the member breakdown. The member breakdown can be viewed on the order details page in the institution admin console.

Parameter Type Description
CourseID Integer Course ID
ClassID Integer Class ID
ClassName String Class name
ClassBeginTime Integer Class start time
ClassEndTime Integer Class end time
ClassDuration Integer Class duration, in seconds
BillingDuration Float Billable duration, in hours; class duration is rounded up to the nearest half hour
StudentAttendanceCount Integer Number of valid attending students, including auditing students
AssistantAttendanceCount Integer Number of valid attending co-teachers
OnStageCount Integer Number of people on stage, i.e. N in 1vN
StudentPrice Integer Student unit price, in cents/person/hour
AssistantPrice Integer Co-teacher unit price, in cents/person/hour

Recording (OrderType = 211)

Capped billable duration: class duration is rounded up to the nearest half hour; when a class allows overrun entry, the actual recorded minutes are converted to hours, kept to 2 decimal places.

Parameter Type Description
CourseID Integer Course ID
ClassID Integer Class ID
ClassName String Class name
ClassBeginTime Integer Class start time
ClassEndTime Integer Class end time
ClassroomRecordMinutes Integer Duration recorded in the ClassIn classroom, in minutes
ClassroomRecordBillingHours Float Capped billable duration for recording in the ClassIn classroom, in hours
CameraRecordMinutes Integer Duration recorded on site, in minutes
CameraRecordBillingHours Float Capped billable duration for on-site recording, in hours
RecordPrice Integer Recording unit price, in cents/hour

Live Traffic (OrderType = 209)

Parameter Type Description
CourseID Integer Course ID
ClassID Integer Class ID
ClassName String Class name
ClassBeginTime Integer Class start time
ClassEndTime Integer Class end time
ClassroomLiveTrafficGB Float Actual live streaming traffic of the classroom, in GB, kept to 3 decimal places
CameraLiveTrafficGB Float Actual live streaming traffic of on-site recording, in GB, kept to 3 decimal places
FreeTrafficMB Float Free traffic, in MB
LiveTrafficPrice Integer Live streaming traffic unit price, in cents/GB

Storage (OrderType = 202)

Storage sizes are in GB. Monitor pictures are rounded down; all other items are kept to 3 decimal places. When an item is not a billable storage item for the institution, its value is -1.

Parameter Type Description
SchoolMaterialGB Float Size of school materials
MonitorPictureGB Float Size of billable monitor pictures
RecordVideoGB Float Size of billable recorded videos
CourseAttachmentGB Float Size of course attachments
ClassFileGB Float Size of class files
BoardNoteGB Float Size of board note files
CoCreateDocGB Float Size of co-created documents
OrgCloudDiskGB Float Size of the organization cloud drive
FreeStorageGB Float Free storage quota for the institution, i.e. the institution's storage limit
StoragePrice Integer Storage unit price, in cents/GB/month

Short Messages (OrderType = 205)

Parameter Type Description
DomesticSuccessCount Integer Number of successfully delivered SMS in China
ForeignSuccessCount Integer Number of successfully delivered SMS outside China
DomesticPrice Integer SMS unit price in China, in cents/message
ForeignPrice Integer SMS unit price outside China, in cents/message

Voice Call (OrderType = 206), Super Customer Service (OrderType = 217)

Parameter Type Description
DomesticDurationMinutes Integer Total call duration in mainland China, in minutes
Price Integer Unit price, in cents/minute

Examples

Class consumption order

{
    "Cmd": "OrderInfo",
    "SID": 1000001,
    "OrderID": "KJ20261109194825G83P",
    "OrderType": 201,
    "OrderTime": 1794224905,
    "OrderSummary": "Math Advanced Class - Lesson 1",
    "OrderAmount": -2200,
    "OrderDetails": {
        "CourseID": 42546,
        "ClassID": 12853,
        "ClassName": "Lesson 1",
        "ClassBeginTime": 1794222000,
        "ClassEndTime": 1794224700,
        "ClassDuration": 2700,
        "BillingDuration": 1,
        "StudentAttendanceCount": 3,
        "AssistantAttendanceCount": 1,
        "OnStageCount": 6,
        "StudentPrice": 400,
        "AssistantPrice": 1000
    },
    "ActionTime": 1794224905,
    "_id": "6af1b9fbd04d2a431c07c2b9",
    "TimeStamp": 1794225505,
    "SafeKey": "afd223385ff188094695772dc3d22c64"
}

Top-up order

{
    "Cmd": "OrderInfo",
    "SID": 1000001,
    "OrderID": "CZ202611091904175RW6",
    "OrderType": 1,
    "OrderTime": 1794225857,
    "OrderSummary": "Account Top-up",
    "OrderAmount": 10000,
    "OrderDetails": null,
    "ActionTime": 1794225857,
    "_id": "6af1b2c1d04d2a431c07c2a0",
    "TimeStamp": 1794226457,
    "SafeKey": "12f41906aae764f1ac3287564e08fc16"
}

results matching ""

    No results matching ""