钉钉开发文档

待办事项

更新时间: 2019-3-12

发起待办

企业可以调用该接口发起一个待办事项,该待办事项会出现在钉钉客户端“待办事项”页面,与钉钉审批待办事项并列。待办功能如下图所示,需要注意的是,通过开放接口发起的待办,只会有一个“前往”按钮:

image.png

目前待办事项有防骚扰控制,具体为:
1、每人每天最多收到一条表单内容相同的待办。触发这个限制,会返回错误码854001
2、每人每天最多收到100条待办。触发这个限制,会返回错误码854002

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

名称 类型 是否必须 示例值 描述
userid String 必须 manager70 待办事项对应的用户id
create_time Long 必须 1496678400000 待办时间。Unix时间戳,毫秒级
title String 必须 标题 待办事项的标题
url String 必须 https://oa.dingtalk.com 待办事项的跳转链接
formItemList List 必须 待办事项表单
└title String 必须 表单标题 表单标题
└content String 必须 表单内容 表单内容

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workrecord/add");
OapiWorkrecordAddRequest req = new OapiWorkrecordAddRequest();
req.setUserid("manager7078");
req.setCreateTime(1496678400000L);
req.setTitle("title");
req.setUrl("https://oa.dingtalk.com");
List<FormItemVo> list2 = new ArrayList<FormItemVo>();
FormItemVo obj3 = new FormItemVo();
list2.add(obj3);
obj3.setTitle("标题");
obj3.setContent("内容");
req.setFormItemList(list2);
OapiWorkrecordAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回结果

{
    "errcode":0,
    "errmsg":"ok",
    "record_id":"12345"
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
record_id 待办事项唯一id,更新待办事项的时候需要用到

更新待办

企业可以调用该接口更新待办事项状态,调用成功后,该待办事项在该用户的“待办事项”列表页面中消失。

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

名称 类型 是否必须 示例值 描述
userid String 必须 manager70 待办事项对应的用户id
record_id String 必须 record123 待办事项唯一id

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workrecord/update");
OapiWorkrecordUpdateRequest req = new OapiWorkrecordUpdateRequest();
req.setUserid("manager7078");
req.setRecordId("record123");
OapiWorkrecordUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回结果

{
    "errcode":0,
    "errmsg":"ok",
    "result":true
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
result true表示更新成功,false表示更新失败

获取用户待办事项

企业可以调用该接口分页获取用户的待办事项列表

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

名称 类型 是否必须 示例值 描述
userid String 必须 manager70 待办事项对应的用户id
offset Number 必须 0 分页游标,从0开始,如返回结果中has_more为true,则表示还有数据,offset再传上一次的offset+limit
limit Number 必须 50 分页大小,最多50
status Number 必须 1 待办事项状态,0表示未完成,1表示完成

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workrecord/getbyuserid");
OapiWorkrecordGetbyuseridRequest req = new OapiWorkrecordGetbyuseridRequest();
req.setUserid("manager7080");
req.setOffset(0L);
req.setLimit(50L);
req.setStatus(0L);
OapiWorkrecordGetbyuseridResponse rsp = client.execute(req, accessToken);
System.out.println(rsp.getBody());

返回结果

{
    "errcode":0,
    "errmsg":"成功",
    "records":{
        "has_more":true,
        "list":[
            {
                    "record_id":"aaa",
                    "create_time":111,
                    "title":"标题",
                    "url":"跳转链接",
                    "forms":[
                        {
                                "title":"表单标题",
                                "content":"表单内容"
                        }
                    ]
            }
        ]
    }
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
has_more true和false,其中true表示还有多余的数据
record_id 待办事项id,可用此id调用更新待办的接口
create_time 待办事项发起时间
title 待办标题
url 待办跳转链接
forms 待办表单列表
└title 表单标题
└content 表单内容
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!