jiangtengfei

add other .md files

  1 +#发推送接口
  2 +
  3 +接口地址:/teaching/callback/push_notification
  4 +
  5 +请求方式:GET
  6 +
  7 +Request Params:
  8 +
  9 +|参数名 |是否必须 |说明 |参数类型 |
  10 +|--------------|-----------|--------|-----------------|
  11 +|work_order_id |是 |工单id |Long |
  12 +|notification_type|是 |推送类型 |“ABSENT” or "START_CLASS" 不区分大小写|
  13 +
  14 +
  15 +# 发推送接口 - 通用
  16 +
  17 +接口地址:/teaching/callback/push
  18 +
  19 +请求方式:POST
  20 +
  21 +RequestBody:
  22 +
  23 +```
  24 +[
  25 + {
  26 + "user_id":12938,
  27 + "push_title":"testtt",
  28 + "data":{
  29 + "type":"GRABORDER",
  30 + "count":123
  31 + }
  32 + },
  33 + {
  34 + "user_id":12938,
  35 + "push_title":"testtt",
  36 + "data":{
  37 + "type":"GRABORDER",
  38 + "count":123
  39 + }
  40 + }
  41 +]
  42 +```
  43 +
  44 +返回值:
  45 +
  46 +```
  47 +{
  48 + "data": {},
  49 + "returnCode": 200,
  50 + "returnMsg": "success"
  51 +}
  52 +
  53 +```
  54 +
  55 +
  56 +
  57 +#查询工单对应的腾讯云错误码和信息
  58 +
  59 +接口地址:/teaching/callback/qcloud/error_info
  60 +
  61 +请求方式:GET
  62 +
  63 +请求参数: work_order_id
  64 +
  65 +返回值:
  66 +
  67 +```
  68 +[
  69 + {
  70 + "work_order_id": 345,
  71 + "error_code":"10002",
  72 + "error_msg":"群组不存在,或者曾经存在过,但是目前已经被解散。"
  73 + },
  74 + {
  75 + "work_order_id": 3453,
  76 + "error_code":"10001",
  77 + "error_msg":"群组ID非法,请检查群组ID是否填写正确。"
  78 + }
  79 +
  80 +]
  81 +```
  82 +
  83 +
  84 +# 发短信接口 - 通用
  85 +
  86 +接口地址: /teaching/sms/send
  87 +
  88 +请求方式: POST
  89 +
  90 +请求参数:
  91 +
  92 +|参数名 |是否必须 |说明 |参数类型 |
  93 +|--------------|-----------|--------|-----------------|
  94 +|user_id |是 |用户id |Long |
  95 +|template_code |是 |短信模板id|String |
  96 +|data |是 |短信模板中的参数json|String |
  97 +
  98 +返回值:
  99 +
  100 +status: 200
  101 +
  102 +
  103 +# 群发通知接口 - 通用
  104 +
  105 +接口地址: /teaching/callback/push/group
  106 +
  107 +请求方式: POST
  108 +
  109 +request body :
  110 +
  111 +```
  112 +{
  113 + "alias": [
  114 + "12938",
  115 + "12939"
  116 + ],
  117 + "push_title": "aaaa",
  118 + "data": {
  119 + "type":"T"
  120 + }
  121 +}
  122 +
  123 +```
  124 +
  125 +返回值:
  126 +
  127 +```
  128 +{
  129 + "data": "ok",
  130 + "returnCode": 200,
  131 + "returnMsg": "success"
  132 +}
  133 +```
  134 +
  135 +
  136 +
  137 +# 根据工单id获取群成员资料
  138 +
  139 +接口地址: /teaching/group/member
  140 +
  141 +请求方式: POST
  142 +
  143 +request body:
  144 +
  145 +```
  146 +[123,456,789,57073]
  147 +```
  148 +
  149 +response body:
  150 +
  151 +```
  152 +[
  153 + {
  154 + "groupId": "@TGS#2MSRWMJEG",
  155 + "workOrderId": 123,
  156 + "memberAccount": [
  157 + "202cb962ac59075b964b07152d234b70"
  158 + ]
  159 + },
  160 + {
  161 + "groupId": "@TGS#2RSE7WJEH",
  162 + "workOrderId": 57073,
  163 + "memberAccount": [
  164 + "b0d3549dd95ee0e99f402b37778d1a88",
  165 + "2d7d9ba8bc62e62b491208e7bb1e397c"
  166 + ]
  167 + }
  168 +]
  169 +```
This diff is collapsed. Click to expand it.
  1 +
  2 +|学生 |templateCode |
  3 +|-----------------------------------------------------------------------------|---------------|
  4 +|同学,你今天{startTime}的在线课程在{minute}分钟后开始,请提前做好上课准备。 |SMS_15110230 |
  5 +|同学,你明天有{quantity}节在线课程,上课时间{startTime},请提前做好上课准备。 |SMS_15120322 |
  6 +
  7 +
  8 +
  9 +
  10 +|老师 |templateCode |
  11 +|-----------------------------------------------------------------------------|---------------|
  12 +|老师您好,您今天有{quantity}节在线课程,第一节在{startTime}开始,请准时上课。祝愉快。 |SMS_15160346 |
  13 +|老师您好,新增{startTime}课程《{courseName}》,请您准时上课。祝愉快。 |SMS_15085203 |
  14 +|老师您好,您的课程:{startTime}《{courseName}》,由于{cancelReason}已取消。祝愉快。 |SMS_15115267 |
  1 +
  2 +# 状态码
  3 +* 设备未绑定成功 错误码:101 描述:设备未绑定成功
  4 +* deprecate ~~工单校验失败 错误码:102 描述:工单校验失败~~
  5 +* 进入房间回调失败 错误码:103 描述: 进入房间回调失败
  6 +* 旷课回调失败 错误码: 104 描述: 旷课回调失败
  7 +* 工单不存在 错误码: 105 描述: 工单不存在
  1 +# 工单校验文案
  2 +英文文案
  3 +订单不存在: WORK_ORDER_NOT_EXISTS=The lesson's canceled for some reason.
  4 +上课太早:WORK_ORDER_TOO_EARLY=Not the right time for class yet; Please try again later.
  5 +老师旷课:WORK_ORDER_TOO_LATE=You've missed the lesson; It's already over.
  6 +学生旷课:WORK_ORDER_STUDENT_ABSENT=Your student have missed the lesson; It's already over.
  7 +课程已结束:WORK_ORDER_CLASS_OVER=Class is over
  8 +
  9 +中文文案
  10 +订单不存在: WORK_ORDER_NOT_EXISTS=本次课已取消
  11 +上课太早:WORK_ORDER_TOO_EARLY=未到上课时间,请准点上课。
  12 +老师旷课:WORK_ORDER_TOO_LATE=您已旷课,课程结束。
  13 +学生旷课:WORK_ORDER_STUDENT_ABSENT=您的学生已旷课
  14 +课程已结束:WORK_ORDER_CLASS_OVER=课程已结束