新增钉钉待办任务
POST
/topapi/workrecord/add最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口发起一个待办任务。
服务地址:https://oapi.dingtalk.com
权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 是 | 开发者后台申请 | 调试 |
第三方企业应用 | 是 | 开发者后台申请 | 调试 |
第三方个人应用 | 否 | — | — |
错误码
参数 | 说明 | 排查方法 |
---|---|---|
33012 | 无效的userid | 请检查userid参数是否合法。 |
40035 | 参数不合法 | 请检查title参数是否小于50个字符。formItemList数组长度是否小于20。 |
400002 | 参数错误 | 请检查title或者content参数是否为空。 |
854001 | 待办任务重复 | 每人每天最多收到一条表单内容相同的待办,这里的表单内容,包括title和formItemList参数。还有一种情况,当传了biz_id参数时,每个用户的biz_id不能重复。 |
854002 | 待办任务超过每日限额 | 每人每天最多收到100条待办。 |
请求参数
Query 参数
access_token
string
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
userid
string
必需
任务的执行人userid。
create_time
number
必需
待办时间,Unix时间戳。该参数只影响待办显示的先后顺序。
title
string
必需
待办任务的标题,最多50个字符。
url
string
必需
待办任务的跳转链接。当链接是某个微应用链接时,希望在PC端工作台打开,可通过消息链接在PC端侧边栏打开实现。待办跳转地址不支持跳转进入小程序。
pcUrl
string
可选
PC端跳转URL,不传则使用URL参数。
formItemList
array [object {2}]
表单列表。
title
string
表单标题。
content
string
表单内容。
originator_user_id
string
可选
发起人的userid。
source_name
string
可选
待办来源名称。该名称会显示在待办的“来源”位置。
pc_open_type
number
可选
待办的PC打开方式:2:在PC端打开4:在浏览器打开
biz_id
string
可选
外部业务ID,建议带上业务方来源字段,防止与其他业务方冲突。
示例
{
"create_time": 1599580799000,
"pcUrl": "https://oa.dingtalk.com",
"pc_open_type": 2,
"formItemList": [
{
"title": "新人学习2",
"content": "产品学习"
}
],
"title": "学习任务",
"biz_id": "1112",
"userid": "manager4220",
"url": "https://oa.dingtalk.com",
"originator_user_id": "manager7078",
"source_name": "学习"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errcode
number
返回码。
errmsg
string
可选
调用接口失败时返回的错误信息。创建成功不会返回。
request_id
string
请求ID。
record_id
string
待办任务ID。
示例
{
"errcode": 0,
"errmsg": "string",
"request_id": "string",
"record_id": "string"
}
最后修改时间: 2 年前