Cho phép đăng ký tối đa 10 người dùng cùng một lúc. Lệnh gọi API yêu cầu các tham số SID, safeKey, timeStamp và số điện thoại hoặc địa chỉ email hợp lệ được sử dụng làm tài khoản để đăng nhập vào ứng dụng ClassIn. Biệt danh là tùy chọn. Mật khẩu có thể là văn bản thuần túy hoặc mã hóa MD5 (khuyến nghị sử dụng mã hóa MD5). ID người dùng (UID) sẽ được trả về sau khi đăng ký thành công. UID là mã định danh duy nhất của tài khoản và được sử dụng trong các lần gọi API tiếp theo. Do đó, vui lòng lưu trữ các UID trong cơ sở dữ liệu của bạn.
Ghi chú:
- Giao diện này không hỗ trợ tải lên ảnh đại diện của người dùng. Vui lòng gọi Edit User Info để chỉnh sửa thông tin ảnh đại diện của từng người dùng.
- Biệt danh được sử dụng để hiển thị trong ứng dụng ClassIn. Truyền tham số 1 hoặc 2 trong addToSchoolMember sẽ đồng bộ hóa biệt danh này lên trang quản lý học sinh/giáo viên trong Trang quản lý ClassIn.
- Người dùng mới đăng ký sẽ không hiển thị trên trang quản lý học sinh/giáo viên trong Trang quản lý của trường theo mặc định. Có hai cách để liên kết người dùng với trường của bạn:
- Truyền các tham số sau đến addToSchoolMember. 1: thêm học sinh vào trường; 2: thêm giáo viên vào trường; các giá trị khác không thể thêm vào trường.
- Gọi add Student và add Teacher để liên kết người dùng với trường của bạn trực tiếp dưới vai trò học sinh hoặc giáo viên.
- Tham số addToSchoolMember sẽ luôn có hiệu lực, bất kể là lần đăng ký đầu tiên hay không.
- Nếu bạn bỏ qua quy trình thêm người dùng vào trường, hệ thống sẽ trả về lỗi khi bạn xếp lịch học cho người dùng thông qua API. (Ví dụ lỗi: Người dùng không phải là giáo viên trong trường của bạn, v.v.)
Vui lòng lưu ý:
- Nếu số điện thoại di động hoặc email đã được đăng ký tài khoản ClassIn, khi bạn gọi register-user, mã lỗi 135 sẽ được trả về cùng với UID.
- Biệt danh, hình đại diện và mật khẩu sẽ chỉ có hiệu lực trong lần đăng ký đầu tiên.
You can register up to 10 users at a time. The API call requires SID, safeKey, timeStamp and valid phone numbers or email addresses used as the account to log into the ‘ClassIn client’. The Nicknames are optional. The passwords can be plaintext or MD5 encryption (MD5 encryption is recommended). The User ID(UID) will be returned after a successful registration. The UID is the unique ID of the account and is used in subsequent API calls. Therefore, please store UIDs in your database.
Notes:
- This interface does not support passing users’ avatars. Please call the Edit User Info to modify the individual user’s avatar information.
- The nickname is used to display on the ClassIn client. When you pass 1 or 2 in the field of addToSchoolMember and the mobile phone number/email address has never been registered before, the nickname will also be displayed as a name in the student/teacher management page in the ClassIn management console.
Newly registered users will not be shown in the student/teacher management session by default, and here are two ways to add users to your school in the role of school student or school teacher.
- Pass the parameter addToSchoolMember when calling this interface. 1: add as an institution student; 2: add as an institution teacher; other values do not add as institution members)
- Call add Student interface and add Teacher interface to bind the user to your institution as students or teachers.
You are only allowed to operate teachers/students added to your school, thus the binding relationship is a required step. If you did not add users to your school based on the above guidance, you would meet request failures when scheduling classes for the users. For example, the error info returns that the user is not a teacher in your school.
Please note that:
- If the mobile phone number or email is already registered as ClassIn account, when you call register-user interface, error code 135 will be returned, together with the UID.
- The nickname, avatar, and password will only take effect during the first registration.
URL #
https://api.eeo.cn/partner/api/course.api.php?action=registerMultiple
HTTP Request Methods #
- POST
Coding Format #
- UTF-8
Request Data #
| Key | Bắt buộc | Yêu cầu thêm | Mô tả | Hướng dẫn |
|---|---|---|---|---|
| SID | Bắt buộc | — | ID của trường | Xem dữ liệu này tại Trang quản lý classin.com trong mục API |
| safeKey | Bắt buộc | Fixed 32-bit all lowercase characters | Khóa bảo mật xác thực trường học | safeKey=MD5(SECRET+timeStamp) |
| timeStamp | Bắt buộc | — | Theo Unix Epoch timestamp & có hiệu lực trong vòng 20 phút | Thời gian UNIX Epoch là số giây đã trôi qua kể từ 00:00:00 (giờ chuẩn quốc tế) vào ngày 1 tháng 1 năm 1970 |
| userJson | Bắt buộc | thêm ít nhất 1 giá trị | Thêm hàng loạt dữ liệu | — |
| └telephone | Bắt buộc (Hoặc có thể bỏ qua và sử dụng email) | Định dạng: 00 Mã vùng-Số điện thoại. Lưu ý: Đối với số điện thoại di động ở Trung Quốc Đại Lục, không nhập mã quốc gia, và số đầu tiên của số điện thoại không được là 0 | Số điện thoại dùng để đăng ký | Ví dụ：Số điện thoại Việt Nam, 0901234567, vui lòng gửi tham số 0084-901234567 |
| Bắt buộc (Hoặc có thể bỏ qua và sử dụng telephone) | — | — | ||
| ┖nickname | Không bắt buộc | Độ dài tối đa 24 ký tự. Nếu biệt danh vượt quá 24 ký tự thì hệ thống sẽ tự động cắt ngắn | — | Nếu tham số này được gửi, nó sẽ được sử dụng làm biệt danh của giáo viên hoặc học sinh để hiển thị trên ứng dụng. Nếu biệt danh không được truyền, số điện thoại di động sẽ được sử dụng làm biệt danh của giáo viên hoặc học sinh. Khi người dùng đăng nhập vào ứng dụng, một cửa sổ sẽ xuất hiện để người dùng điền biệt danh. Biệt danh được hiển thị dưới camera của người dùng trong lớp học ảo, với tối đa 24 ký tự. |
| ┖password | Bắt buộc (Hoặc có thể bỏ qua và dùng md5pass) | — | Mật khẩu dạng văn bản không mã hóa | Mật khẩu có độ dài trong khoảng từ 6 – 20 ký tự. Nếu mật khẩu không đúng như yêu cầu thì báo lỗi sẽ hiển thị. |
| ┖md5pass | Bắt buộc (Hoặc có thể bỏ qua và dùng password) | — | Mật khẩu được mã hóa MD5 | Mã hóa 32-bit MD5 |
| ┖addToSchoolMember | Không bắt buộc | 0: Không thêm người dùng này vào trường； 1: Thêm vào trường với vai trò học sinh； 2: Thêm vào trường với vai trò giáo viên； Các giá trị khác: Không thêm người dùng này vào trường; Và nếu để trống thì giá trị mặc định là 0 | Khi tham số addToSchoolMember là 1 hoặc 2, người dùng sẽ hiển thị tại Trang quản lý của trường với vai trò là học sinh hoặc giáo viên. Và biệt danh sẽ được sử dụng để hiển thị tại trang danh sách học sinh/giáo viên của trường | Quyết định xem có thêm tài khoản vào trường hay không. |
| └customColumn | Không bắt buộc | 1-50 ký tự. Nếu biệt danh vượt quá 50 ký tự thì hệ thống sẽ tự động cắt ngắn | Định danh người dùng | Nếu rỗng, trường này sẽ không được trả về |
Response data #
| Key | Định dạng | Phản hồi | Ý Nghĩa |
|---|---|---|---|
| data | array | Danh sách người dùng đã được tạo thành công | |
| └ | object | Thông tin người dùng sau khi đăng ký | |
| └ data | number | 1283830 | Trả về ID của người dùng (UID) |
| └ telephone | string | 13800000000 | Số điện thoại được dùng để đăng ký |
| └ customColumn | string | 08cbe7986a2da0975ef0e538790b9987 | Trả về thông tin custom field |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Routine execution” | Thông tin lỗi |
| error_info | object | Return information object | |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Routine execution” | Thông tin lỗi |
Sample #
userJson
userJson:[ {"telephone":"xxxx","nickname":"xxxx","password":"xxxx"}, {"telephone":"xxxx","nickname":"xxxx","password":"xxxx"} ]HTTP request
POST /partner/api/course.api.php?action=registerMultiple HTTP/1.1
Host: root_url
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=5458edceccc78c6698de624e94364285&timeStamp=1493026245&userJson=[{"telephone":18516900101,"password":123456,"addToSchoolMember":1},{"telephone":18516900102,"password":123456,"addToSchoolMember":1}]
- Shell cURL analog request instruction
curl -H "Content-Type: application/x-www-form-urlencoded" -X "POST" \
-d "SID=1234567"\
-d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2"\
-d "timeStamp=1484719085"\
-d 'userJson=
[ \
{\
"telephone": 18516900101,\
"password": 123456,\
"addToSchoolMember": 1\
},
{
"telephone": 18516900102,\
"password": 123456,\
"addToSchoolMember": 1\
}\
]'\
"https://root_url/partner/api/course.api.php?action=registerMultiple"
Response sample（The normal return json packet example） #
{
"data": [
{
"data": 19820374,
"telephone": "13800000000",
"errno": 1,
"error": "程序正常执行"
}
],
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Instruction #
| Error Code | Mô tả |
|---|---|
| 1 | Thành công |
| 100 | Parameters sai định dạng hoặc không hoàn chỉnh |
| 102 | Không có quyền thao tác (Xác thực bảo mật thất bại). |
| 114 | Lỗi server |
| 131 | Tạo tài khoản thất bại |
| 134 | Số điện thoại không hợp lệ |
| 135 | Số điện thoại đã được đăng ký (thông tin UID của người dùng sẽ được trả về cùng lúc) |
| 137 | Độ dài mật khẩu không hợp lệ (6-20 ký tự). |
| 224 | Định dạng hình ảnh không hợp lệ |
| 288 | Mã vùng không hợp lệ |
| 340 | Tạo tài khoản thành công, thiết lập ảnh đại diện thất bại. |
| 341 | Kích cỡ hình ảnh không hợp lệ (300 * 300). |
| 342 | Dung lượng hình ảnh quá lớn (tối đa 1MB). |
| 461 | Email đã được đăng ký (thông tin UID của người dùng sẽ được trả về cùng lúc). |
| 820 | Tạo tài khoản thành công, nhưng thêm người dùng làm học sinh của trường thất bại |
| 821 | Tạo tài khoản thành công, nhưng thêm người dùng làm giáo viên của trường thất bại |
| 845 | Số lượng giáo viên của trường đã đạt đến giới hạn |
