请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/point/logMeta/list
Query参数说明:
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 应用access_token,2小时有效期 |
| userid_list | String | 否 | 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个 |
| start_time | Int | 否 | 查询积分明细的起始时间,Unix时间戳,单位毫秒 注意:开始时间与当前时间差不能大于365天 |
| end_time | Int | 否 | 查询积分明细的结束时间,Unix时间戳,单位毫秒 注意:起始与结束时间差不超7天 |
| page | Int | 否 | 页码,默认从1开始 |
| page_size | Int | 否 | 每页条数,最大100,最大100 |
Query参数提示: userid_list参数与start_time、end_time时间参数二选一,不能同时不传。
返回结果:
{
"code": "200",
"status": "ok",
"message": "success",
"data": {
"list": [{
"target_id": "来源对象id",
"target_title": "来源对象名称",
"module": "course",
"point_type": "finish_video_lesson",
"points": 5,
"create_time": 1546565453000,
"dept_user_id": "6940612436280423",
"dept_user_name": "XXX",
"remark": ""
}],
"has_more": 1
}
}
参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| data | Array | 返回的数据包 |
| list | Array | 返回的分类列表 |
| target_id | String | 来源对象id,最大长度36字符 |
| target_title | String | 来源对象名称,最大长度255字符 |
| module | String | 变更积分的模块: course 课程 exam 考试 training 线下培训 learningmap 学习地图 competition PK赛 pointmall 积分商城 user 用户操作 other 其他 |
| point_type | String | 变更积分类型: sign 每日签到 finish_video_lesson 完成视频课件 finish_document_lesson 完成文档课件 finish_article_lesson 完成文章课件 finish_link_lesson 完成超链接课件 finish_audio_lesson 完成音频课件 pass_exam 通过一门考试 course_comment 课程发表评论 training_comment 参与线下培训 pass_tollgate 通过PK赛的一个关卡 pass_test 通过课程的一个小测试 student_question 学员出题 point_convert 积分兑换 |
| points | Decimal(12,2) | 积分数量 |
| dept_user_id | String | 用户ID,最大长度64字符 |
| remark | String | 备注,最大长度255字符 |
| create_time | Int | 创建时间,Unix时间戳,单位毫秒 |
| has_more | Int | 是否还有数据没返回: 1 还有 0 没有 |
请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/user/point/info
Query参数说明:
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 应用access_token,2小时有效期 |
| dept_user_id | String | 否 | 员工在企业内的UserID |
| user_id | String | 否 | 员工在Lark或飞书平台的UserID |
Query参数提示: dept_user_id参数与user_id时间参数二选一,不能同时不传。
返回结果:
{
"code": "200",
"status": "ok",
"message": "获取详情成功",
"data": {
"dept_user_id" : "12345678",
"dept_user_name": "用户名",
"total_points":2.00
}
}
参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| data | Array | 返回的数据包 |
| dept_user_id | String | 用户ID,最大长度64字符 |
| dept_user_name | String | 用户姓名,最大长度100字符 |
| total_points | Decimal(12,2) | 用户总积分 |
请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/user/point/consume
Query参数说明:
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 应用access_token,2小时有效期 |
| trade_no | String | 是 | 用户在消费积分时候传入的自己的订单流水号 |
返回结果:
{
"code": "200",
"status": "ok",
"message": "获取详情成功",
"data": {
"order_no": "E8EE181D-3C76-4125-A09E-860CC18A67EC",
"dept_user_id": "21212121212",
"trade_no": "1234567",
"title": "测试第二单",
"point": 1,
"module": "consume",
"create_time": 1546565453000,
}
}
参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| data | Array | 返回的数据包 |
| order_no | String | 授客订单流水号,最大长度36字符 这个仅为授客内部使用无需保存,订单消费均已第三方提供的trade_no作为唯一值 |
| dept_user_id | String | 用户ID,最大长度36字符 |
| trade_no | String | 第三方订单流水号,最大长度64字符 |
| title | String | 订单描述,最大长度255字符 |
| point | Decimal(12,2) | 消费积分额度 |
| module | String | 订单类型: consume 消费积分 add 添加积分 |
| create_time | Int | 创建时间,Unix时间戳,单位毫秒 |
请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/user/point/consumeUpdate
Query参数说明:
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| trade_no | String | 是 | 第三方订单流水号,会验证是否重复 |
| dept_user_id | String | 是 | 用户在钉钉的uerid |
| title | String | 是 | 订单描述,不超32位字符串 |
| point | int | 是 | 积分额度,不等于0的正整数,小于0为消费积分,大于0为添加积分(消费积分目前必须填整数,用户的总积分小数位主要来自课程) |
返回结果: 正确时返回示例:
{
"code": "200",
"status": "ok",
"message": "积分修改成功",
}
错误时返回示例:
{
"code": "12005",
"status": "error",
"message":"积分余额不足"
}
{
"code": "12005",
"status": "error",
"message":"该订单已存在不能重复"
}