钉钉开发文档

钉钉运动

更新时间: 2019-4-8

获取用户钉钉运动开启状态

企业使用此接口可查询用户是否启用了钉钉运动,如果未开启,不会参与企业的钉钉运动排名。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/health/stepinfo/getuserstatus?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
userid String 必须 manager1 用户id

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/health/stepinfo/getuserstatus");
OapiHealthStepinfoGetuserstatusRequest request = new OapiHealthStepinfoGetuserstatusRequest();
request.setUserid("userid1");
OapiHealthStepinfoGetuserstatusResponse response = client.execute(request, accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "status": true
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
status true表示开启,false表示未开启

获取个人或部门的钉钉运动数据

查询企业用户或部门每天的钉钉运动步数,最多可以查询31天的数据。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/health/stepinfo/list?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
type Number 必须 1 0表示取用户步数,1表示取部门步数
object_id String 必须 11 可以传入用户userid或者部门id
stat_dates String 必须 20180101, 20180102 时间列表,注意时间格式是YYYYMMDD

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/health/stepinfo/list");
OapiHealthStepinfoListRequest request = new OapiHealthStepinfoListRequest();
request.setObjectId("24354152");
request.setType(1L);
request.setStatDates("20180503,20180504");
OapiHealthStepinfoListResponse response = client.execute(request, accessToken);

返回结果

{
    "errcode":0,
    "errmsg":"success",
    "stepinfo_list":[
        {
                "stat_date":20180101,
                "step_count":100
        }
    ]
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
stepinfo_list 步数列表
└ stat_date 统计的时间
└ step_count 步数

批量获取钉钉运动数据

在钉钉运动中,每天会对员工运动步数统计和排名,如果企业想更灵活的定制统计规则,比如按月、按部门等维度,可使用此接口。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/health/stepinfo/listbyuserid?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
userids String 必须 manager1, manager2 员工userid列表,最多传50个
stat_date String 必须 20180101 时间,注意时间格式是YYMMDD

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/health/stepinfo/listbyuserid");
OapiHealthStepinfoListbyuseridRequest request = new OapiHealthStepinfoListbyuseridRequest();
request.setUserids("userid1,userid2");
request.setStatDate("20180504");
OapiHealthStepinfoListbyuseridResponse response = client.execute(request, accessToken);

返回结果

{
    "errcode":0,
    "errmsg":"success",
    "stepinfo_list":[
        {
                "stat_date":20180101,
                "step_count":100,
                "userid":"manager1"
        }
    ]
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
stepinfo_list 步数列表
└ stat_date 统计的时间
└ step_count 步数
└ userid 员工userid
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!