jiangtengfei

add other .md files

#发推送接口
接口地址:/teaching/callback/push_notification
请求方式:GET
Request Params:
|参数名 |是否必须 |说明 |参数类型 |
|--------------|-----------|--------|-----------------|
|work_order_id |是 |工单id |Long |
|notification_type|是 |推送类型 |“ABSENT” or "START_CLASS" 不区分大小写|
# 发推送接口 - 通用
接口地址:/teaching/callback/push
请求方式:POST
RequestBody:
```
[
{
"user_id":12938,
"push_title":"testtt",
"data":{
"type":"GRABORDER",
"count":123
}
},
{
"user_id":12938,
"push_title":"testtt",
"data":{
"type":"GRABORDER",
"count":123
}
}
]
```
返回值:
```
{
"data": {},
"returnCode": 200,
"returnMsg": "success"
}
```
#查询工单对应的腾讯云错误码和信息
接口地址:/teaching/callback/qcloud/error_info
请求方式:GET
请求参数: work_order_id
返回值:
```
[
{
"work_order_id": 345,
"error_code":"10002",
"error_msg":"群组不存在,或者曾经存在过,但是目前已经被解散。"
},
{
"work_order_id": 3453,
"error_code":"10001",
"error_msg":"群组ID非法,请检查群组ID是否填写正确。"
}
]
```
# 发短信接口 - 通用
接口地址: /teaching/sms/send
请求方式: POST
请求参数:
|参数名 |是否必须 |说明 |参数类型 |
|--------------|-----------|--------|-----------------|
|user_id |是 |用户id |Long |
|template_code |是 |短信模板id|String |
|data |是 |短信模板中的参数json|String |
返回值:
status: 200
# 群发通知接口 - 通用
接口地址: /teaching/callback/push/group
请求方式: POST
request body :
```
{
"alias": [
"12938",
"12939"
],
"push_title": "aaaa",
"data": {
"type":"T"
}
}
```
返回值:
```
{
"data": "ok",
"returnCode": 200,
"returnMsg": "success"
}
```
# 根据工单id获取群成员资料
接口地址: /teaching/group/member
请求方式: POST
request body:
```
[123,456,789,57073]
```
response body:
```
[
{
"groupId": "@TGS#2MSRWMJEG",
"workOrderId": 123,
"memberAccount": [
"202cb962ac59075b964b07152d234b70"
]
},
{
"groupId": "@TGS#2RSE7WJEH",
"workOrderId": 57073,
"memberAccount": [
"b0d3549dd95ee0e99f402b37778d1a88",
"2d7d9ba8bc62e62b491208e7bb1e397c"
]
}
]
```
\ No newline at end of file
... ...
This diff is collapsed. Click to expand it.
|学生 |templateCode |
|-----------------------------------------------------------------------------|---------------|
|同学,你今天{startTime}的在线课程在{minute}分钟后开始,请提前做好上课准备。 |SMS_15110230 |
|同学,你明天有{quantity}节在线课程,上课时间{startTime},请提前做好上课准备。 |SMS_15120322 |
|老师 |templateCode |
|-----------------------------------------------------------------------------|---------------|
|老师您好,您今天有{quantity}节在线课程,第一节在{startTime}开始,请准时上课。祝愉快。 |SMS_15160346 |
|老师您好,新增{startTime}课程《{courseName}》,请您准时上课。祝愉快。 |SMS_15085203 |
|老师您好,您的课程:{startTime}《{courseName}》,由于{cancelReason}已取消。祝愉快。 |SMS_15115267 |
\ No newline at end of file
... ...
# 状态码
* 设备未绑定成功 错误码:101 描述:设备未绑定成功
* deprecate ~~工单校验失败 错误码:102 描述:工单校验失败~~
* 进入房间回调失败 错误码:103 描述: 进入房间回调失败
* 旷课回调失败 错误码: 104 描述: 旷课回调失败
* 工单不存在 错误码: 105 描述: 工单不存在
\ No newline at end of file
... ...
# 工单校验文案
英文文案
订单不存在: WORK_ORDER_NOT_EXISTS=The lesson's canceled for some reason.
上课太早:WORK_ORDER_TOO_EARLY=Not the right time for class yet; Please try again later.
老师旷课:WORK_ORDER_TOO_LATE=You've missed the lesson; It's already over.
学生旷课:WORK_ORDER_STUDENT_ABSENT=Your student have missed the lesson; It's already over.
课程已结束:WORK_ORDER_CLASS_OVER=Class is over
中文文案
订单不存在: WORK_ORDER_NOT_EXISTS=本次课已取消
上课太早:WORK_ORDER_TOO_EARLY=未到上课时间,请准点上课。
老师旷课:WORK_ORDER_TOO_LATE=您已旷课,课程结束。
学生旷课:WORK_ORDER_STUDENT_ABSENT=您的学生已旷课
课程已结束:WORK_ORDER_CLASS_OVER=课程已结束
\ No newline at end of file
... ...