课中互动环节
本章接口列表:
数目 | 接口名称 | 接口说明 |
---|---|---|
1 | 获取奖励数接口 | 该接口提供获取奖励数量服务。 |
获取奖励数接口
接口说明:该接口提供获取奖励数量服务
接口URL: /light/lesson/awards
接口域名: http(s)://api.weclassroom.com
(测试环境:http://test-api.weclassroom.com
) (老域名,可以使用但不再更新维护)
接口域名: http(s)://openapi.weclassroom.com
(测试环境:http://test-openapi.weclassroom.com
)(新域名,推荐使用)
验签规则请查看附录下验签代码示例
api接口和openapi接口统一请求方式: GET
api接口上传参数:
参数 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
lesson_id | INT | 是 | 课堂ID,用于标识该课节 |
institution_id | INT | 是 | 机构ID,直播云下发用于标识对接机构ID |
user_id | STRING | 否 | 用户ID,如果使用用户ID,则表示该课节下某用户user_id的奖励数 |
third_token | STRING | 是 | 对接机构用于验签的TOKEN |
openapi接口上传参数:
参数 | 说明 | 是否必填 | 类型 |
---|---|---|---|
applicationID | 下发机构key | 是 | string |
signMsg | 加密参数字符串 | 是 | string |
signMsg包含参数:
参数 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
lesson_id | INT | 是 | 课堂ID,用于标识该课节 |
institution_id | INT | 是 | 机构ID,直播云下发用于标识对接机构ID |
user_id | STRING | 否 | 用户ID,如果使用用户ID,则表示该课节下某用户user_id的奖励数 |
返回格式: JSON
返回参数说明:
参数 | 类型 | 参数说明 |
---|---|---|
status | INT | 返回状态信息:1.成功 0.失败 |
msg | STRING | 对返回的状态信息的补充说明,如调用失败原因等 |
data | JSON或者INT | 返回课件ID信息,成功为JSON |
data参数说明:
参数 | 类型 | 参数说明 |
---|---|---|
award_num | INT | 奖励数量 |
user_id | STRING | 用户ID |
返回常见错误:
接口返回msg参数内容 | 说明 |
---|---|
lesson_id参数为空 | 接口参数中lesson_id必传 |
暂无相关奖励 | 查询课节或这该课节下user_id没有相关奖励 |
课节不存在 | 查询的课节不存在 |
成功示例:
{
"status":1,
"msg":"",
"data":[
{"award_num":4,//奖励数
"user_id":201701//用户ID
}
]
}
失败示例:
{
"status":0,//返回状态0为错误,1为成功
"msg":"lesson_id参数为空"
}