接口调用说明
工作通知消息是以某个应用的名义推送到员工的工作通知消息,例如生日祝福、入职提醒等。可以发送文本、语音、链接等,消息类型和样例可参考消息通知类型。如果接口发送成功,接收人没有收到信息,可调用获取工作通知消息的发送结果查询结果,并对比文档中的返回错误码。
使用场景
重要
- 适用场景:适用于发送通知类的消息,不包含审批任务等。
- 不适用场景:需要发送一条任务类的通知提醒给员工,比如审批任务等,调用此接口无法实现。这种场景可以使用创建待办接口。
频率限制
超出以下限制次数后,接口返回成功,但用户无法接收到。
详细的限制说明,请参考调用频率限制。
- 企业内部应用发送消息单次最多只能给5000人发送,第三方企业应用发送消息单次最多能给1000人发送。
- 给同一员工一天只能发送一条内容相同的消息通知。
- 企业内部应用每天给每个员工最多可发送500条消息通知,第三方企业应用最多可发送100条。
- 企业内部应用或第三方企业应用发送消息时,每分钟最多有5000人可以接收到消息。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/topapi/message/corpconversation/asyncsend_v2 |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| agent_id | Long | 是 | 123L | 发送消息时使用的微应用的AgentID。 - 企业内部应用可在开发者后台的应用详情页面查看。 - 第三方企业应用可调用获取企业授权信息接口获取。 |
| userid_list | String | 否 | user123,user456 | 接收者的userid列表,最大用户列表长度100。 |
| dept_id_list | String | 否 | 123,345 | 接收者的部门id列表,最大列表长度20。 接收者是部门ID时,包括子部门下的所有用户。 |
| to_all_user | Boolean | 否 | false | 是否发送给企业全部用户。 说明 当设置为false时必须指定userid_list或dept_id_list其中一个参数的值。 |
| msg | JSON Object | 是 | {"msgtype":"text","text":{"content":"请提交日报。"}} | 消息内容,最长不超过2048个字节,支持以下消息通知类型,msgtype 包括: 重要 发送消息时,不支持同时发送多种消息类型。 - text:文本消息 - image:图片消息 - voice:语音消息 - file:文件消息 - link:链接消息 - oa:OA消息 说明 OA消息支持通过status_bar参数设置消息状态文案和颜色,发送后可通过更新工作通知状态栏接口更新消息状态和颜色。 - markdown:Markdown消息 - action_card:卡片消息 |
请求示例
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | 4jzllmte0wau | 请求ID。 |
| errmsg | String | ok | 返回码描述。 重要 如果接口发送成功,接收人没有收到信息,可调用获取工作通知消息的发送结果查询结果,并对比文档中的返回错误码。 |
| errcode | Number | 0 | 返回码。 |
| task_id | Number | 256271667526 | 创建的异步发送任务ID。 |