发送工作通知
POST
/topapi/message/corpconversation/asyncsend_v2最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口发送工作通知消息。
服务地址:https://oapi.dingtalk.com
权限
服务端API是以应用维度授权的,在创建应用时,系统已默认添加了消息通知权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 是 | 无需申请 | 调试 |
第三方企业应用 | 是 | 无需申请 | 调试 |
第三方个人应用 | 否 | — | — |
请求参数
Query 参数
access_token
string
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
agent_id
integer
必需
发送消息时使用的微应用的AgentID。企业内部应用可在开发者后台的应用详情页面查看。第三方企业应用可调用获取企业授权信息接口获取。
userid_list
string
可选
接收者的userid列表,最大用户列表长度100。
dept_id_list
string
可选
接收者的部门id列表,最大列表长度20。接收者是部门ID时,包括子部门下的所有用户。
to_all_user
boolean
可选
是否发送给企业全部用户。当设置为false时必须指定userid_list或dept_id_list其中一个参数的值。
msg
string
必需
消息内容,最长不超过2048个字节,支持以下消息类型:文本消息图片消息语音消息文件消息链接消息OA消息OA消息支持通过status_bar参数设置消息的状态文案和颜色,消息发送后可调用更新工作通知状态栏接口更新消息状态和颜色。Markdown消息卡片消息
示例
{
"msg": {
"voice": {
"duration": "100",
"media_id": "100"
},
"image": {
"media_id": "@123"
},
"oa": {
"head": {
"bgcolor": "bgcolor",
"text": "text"
},
"pc_message_url": "pc_message_url",
"status_bar": {
"status_value": "进行中",
"status_bg": "0xFFF65E5E"
},
"body": {
"file_count": "file_count",
"image": "image",
"form": {
"value": "value",
"key": "key"
},
"author": "author",
"rich": {
"unit": "unit",
"num": "num"
},
"title": "title",
"content": "content"
},
"message_url": "message_url"
},
"file": {
"media_id": "media_id"
},
"action_card": {
"btn_json_list": {
"action_url": "action_url",
"title": "title"
},
"single_url": "single_url",
"btn_orientation": "btn_orientation",
"single_title": "single_title",
"markdown": "markdown",
"title": "title"
},
"link": {
"picUrl": "picUrl",
"messageUrl": "messageUrl",
"text": "text",
"title": "title"
},
"markdown": {
"text": "text",
"title": "title"
},
"text": {
"content": "123"
},
"msgtype": "text"
},
"to_all_user": "false",
"agent_id": "123",
"dept_id_list": "123,456",
"userid_list": "123,456"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
request_id
string
请求ID。
errmsg
string
可选
返回码描述。如果接口发送成功,接收人没有收到信息,可调用获取工作通知消息的发送结果查询结果,并对比文档中的返回错误码。
errcode
number
返回码。
task_id
number
可选
创建的异步发送任务ID。
示例
{
"request_id": "string",
"errmsg": "string",
"errcode": 0,
"task_id": 0
}
最后修改时间: 2 年前