文档中心 > API类目 > 钉钉API

dingtalk.oapi.message.corpconversation.asyncsend_v2 (异步发送工作通知消息接口)

异步发送工作通知消息接口

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
agent_id	Number	必须	123		微应用的id
userid_list	String []	可选	123,456	最大列表长度：5000	接收者的用户userid列表
dept_id_list	Number []	可选	123,456	最大列表长度：500	接收者的部门id列表
to_all_user	Boolean	可选	false	默认值：false	是否发送给企业全部用户
msg	Msg	必须			消息体，具体见文档
└ msgtype String 必须 text 消息类型 text Text 可选文本消息 └ content String 可选 123 文本消息 image Image 可选图片消息 └ media_id String 可选 @123 图片消息 link Link 可选链接消息 └ picUrl String 可选 picUrl 图片地址 └ messageUrl String 可选 messageUrl 消息点击链接地址 └ text String 可选 text 消息标题，建议100字符以内 └ title String 可选 title 消息描述，建议500字符以内 file File 可选文件消息 └ media_id String 可选 media_id 媒体文件id。引用的媒体文件最大10MB voice Voice 可选语音消息 └ duration String 可选 100 正整数，小于60，表示音频时长 └ media_id String 可选 100 媒体文件id。2MB，播放长度不超过60s，AMR格式 oa OA 可选 OA消息 body Body 可选消息体 └ author String 可选 author 自定义的作者名字 └ file_count String 可选 file_count 自定义的附件数目。此数字仅供显示，钉钉不作验证 └ image String 可选 image 消息体中的图片，支持图片资源@mediaId └ content String 可选 content 消息体的内容，最多显示3行 rich Rich 可选单行富文本信息 └ unit String 可选 unit 单行富文本信息的单位 └ num String 可选 num 单行富文本信息的数目 form Form [] 可选消息体的表单，最多显示6个，超过会被隐藏 └ value String 可选 value 消息体的关键字对应的值 └ key String 可选 key 消息体的关键字 └ title String 可选 title 消息体的标题，建议50个字符以内 head Head 可选消息头部内容 └ bgcolor String 可选 bgcolor 消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x └ text String 可选 text 消息的头部标题 (向普通会话发送时有效，向企业会话发送时会被替换为微应用的名字)，长度限制为最多10个字符 └ pc_message_url String 可选 pc_message_url PC端点击消息时跳转到的地址 └ message_url String 可选 message_url 消息点击链接地址，当发送消息为小程序时支持小程序跳转链接 status_bar StatusBar 可选状态栏 └ status_value String 可选进行中状态栏文案 └ status_bg String 可选 0xFFF65E5E 状态栏背景色，默认为黑色 markdown Markdown 可选 markdown消息 └ text String 可选 text markdown格式的消息，建议500字符以内 └ title String 可选 title 首屏会话透出的展示内容 action_card ActionCard 可选卡片消息 btn_json_list BtnJsonList [] 可选使用独立跳转ActionCard样式时的按钮列表；必须与btn_orientation同时设置 └ action_url String 可选 action_url 消息点击链接地址，当发送消息为小程序时支持小程序跳转链接，最长500个字符 └ title String 可选 title 使用独立跳转ActionCard样式时的按钮的标题，最长20个字符 └ btn_orientation String 可选 btn_orientation 使用独立跳转ActionCard样式时的按钮排列方式，竖直排列(0)，横向排列(1)；必须与btn_json_list同时设置 └ single_url String 可选 single_url 消息点击链接地址，当发送消息为小程序时支持小程序跳转链接，最长500个字符 └ single_title String 可选 single_title 使用整体跳转ActionCard样式时的标题，必须与single_url同时设置，最长20个字符 └ markdown String 可选 markdown 消息内容，支持markdown，语法参考标准markdown语法。建议1000个字符以内 └ title String 可选 title 透出到会话列表和通知的文案，最长64个字符
enable_id_trans	Boolean	可选	false	默认值：false	是否开启id转译，默认false。仅第三方应用需要用到，企业内部应用可以忽略

响应参数

名称	类型	示例值	描述
errmsg	String	ok	错误信息
errcode	Number	0	错误码。0代表成功。
task_id	Number	123	创建的异步发送任务id

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend_v2");
OapiMessageCorpconversationAsyncsendV2Request req = new OapiMessageCorpconversationAsyncsendV2Request();
req.setAgentId(123L);
req.setUseridList("123,456");
req.setDeptIdList("123,456");
req.setToAllUser(false);
Msg obj1 = new Msg();
obj1.setMsgtype("text");
Text obj2 = new Text();
obj2.setContent("123");
obj1.setText(obj2);
Image obj3 = new Image();
obj3.setMediaId("@123");
obj1.setImage(obj3);
Link obj4 = new Link();
obj4.setPicUrl("picUrl");
obj4.setMessageUrl("messageUrl");
obj4.setText("text");
obj4.setTitle("title");
obj1.setLink(obj4);
File obj5 = new File();
obj5.setMediaId("media_id");
obj1.setFile(obj5);
Voice obj6 = new Voice();
obj6.setDuration("100");
obj6.setMediaId("100");
obj1.setVoice(obj6);
OA obj7 = new OA();
Body obj8 = new Body();
obj8.setAuthor("author");
obj8.setFileCount("file_count");
obj8.setImage("image");
obj8.setContent("content");
Rich obj9 = new Rich();
obj9.setUnit("unit");
obj9.setNum("num");
obj8.setRich(obj9);
List<Form> list11 = new ArrayList<Form>();
Form obj12 = new Form();
list11.add(obj12);
obj12.setValue("value");
obj12.setKey("key");
obj8.setForm(list11);
obj8.setTitle("title");
obj7.setBody(obj8);
Head obj13 = new Head();
obj13.setBgcolor("bgcolor");
obj13.setText("text");
obj7.setHead(obj13);
obj7.setPcMessageUrl("pc_message_url");
obj7.setMessageUrl("message_url");
StatusBar obj14 = new StatusBar();
obj14.setStatusValue("进行中");
obj14.setStatusBg("0xFFF65E5E");
obj7.setStatusBar(obj14);
obj1.setOa(obj7);
Markdown obj15 = new Markdown();
obj15.setText("text");
obj15.setTitle("title");
obj1.setMarkdown(obj15);
ActionCard obj16 = new ActionCard();
List<BtnJsonList> list18 = new ArrayList<BtnJsonList>();
BtnJsonList obj19 = new BtnJsonList();
list18.add(obj19);
obj19.setActionUrl("action_url");
obj19.setTitle("title");
obj16.setBtnJsonList(list18);
obj16.setBtnOrientation("btn_orientation");
obj16.setSingleUrl("single_url");
obj16.setSingleTitle("single_title");
obj16.setMarkdown("markdown");
obj16.setTitle("title");
obj1.setActionCard(obj16);
req.setMsg(obj1);
req.setEnableIdTrans(false);
OapiMessageCorpconversationAsyncsendV2Response rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend_v2");
OapiMessageCorpconversationAsyncsendV2Request req = new OapiMessageCorpconversationAsyncsendV2Request();
req.AgentId = 123L;
req.UseridList = "123,456";
req.DeptIdList = "123,456";
req.ToAllUser = false;
OapiMessageCorpconversationAsyncsendV2Request.MsgDomain obj1 = new OapiMessageCorpconversationAsyncsendV2Request.MsgDomain();
obj1.Msgtype = "text";
OapiMessageCorpconversationAsyncsendV2Request.TextDomain obj2 = new OapiMessageCorpconversationAsyncsendV2Request.TextDomain();
obj2.Content = "123";
obj1.Text= obj2;
OapiMessageCorpconversationAsyncsendV2Request.ImageDomain obj3 = new OapiMessageCorpconversationAsyncsendV2Request.ImageDomain();
obj3.MediaId = "@123";
obj1.Image= obj3;
OapiMessageCorpconversationAsyncsendV2Request.LinkDomain obj4 = new OapiMessageCorpconversationAsyncsendV2Request.LinkDomain();
obj4.PicUrl = "picUrl";
obj4.MessageUrl = "messageUrl";
obj4.Text = "text";
obj4.Title = "title";
obj1.Link= obj4;
OapiMessageCorpconversationAsyncsendV2Request.FileDomain obj5 = new OapiMessageCorpconversationAsyncsendV2Request.FileDomain();
obj5.MediaId = "media_id";
obj1.File= obj5;
OapiMessageCorpconversationAsyncsendV2Request.VoiceDomain obj6 = new OapiMessageCorpconversationAsyncsendV2Request.VoiceDomain();
obj6.Duration = "100";
obj6.MediaId = "100";
obj1.Voice= obj6;
OapiMessageCorpconversationAsyncsendV2Request.OADomain obj7 = new OapiMessageCorpconversationAsyncsendV2Request.OADomain();
OapiMessageCorpconversationAsyncsendV2Request.BodyDomain obj8 = new OapiMessageCorpconversationAsyncsendV2Request.BodyDomain();
obj8.Author = "author";
obj8.FileCount = "file_count";
obj8.Image = "image";
obj8.Content = "content";
OapiMessageCorpconversationAsyncsendV2Request.RichDomain obj9 = new OapiMessageCorpconversationAsyncsendV2Request.RichDomain();
obj9.Unit = "unit";
obj9.Num = "num";
obj8.Rich= obj9;
List<OapiMessageCorpconversationAsyncsendV2Request.FormDomain> list11 = new List<OapiMessageCorpconversationAsyncsendV2Request.FormDomain>();
OapiMessageCorpconversationAsyncsendV2Request.FormDomain obj12 = new OapiMessageCorpconversationAsyncsendV2Request.FormDomain();
list11.Add(obj12);
obj12.Value = "value";
obj12.Key = "key";
obj8.Form= list11;
obj8.Title = "title";
obj7.Body= obj8;
OapiMessageCorpconversationAsyncsendV2Request.HeadDomain obj13 = new OapiMessageCorpconversationAsyncsendV2Request.HeadDomain();
obj13.Bgcolor = "bgcolor";
obj13.Text = "text";
obj7.Head= obj13;
obj7.PcMessageUrl = "pc_message_url";
obj7.MessageUrl = "message_url";
OapiMessageCorpconversationAsyncsendV2Request.StatusBarDomain obj14 = new OapiMessageCorpconversationAsyncsendV2Request.StatusBarDomain();
obj14.StatusValue = "进行中";
obj14.StatusBg = "0xFFF65E5E";
obj7.StatusBar= obj14;
obj1.Oa= obj7;
OapiMessageCorpconversationAsyncsendV2Request.MarkdownDomain obj15 = new OapiMessageCorpconversationAsyncsendV2Request.MarkdownDomain();
obj15.Text = "text";
obj15.Title = "title";
obj1.Markdown= obj15;
OapiMessageCorpconversationAsyncsendV2Request.ActionCardDomain obj16 = new OapiMessageCorpconversationAsyncsendV2Request.ActionCardDomain();
List<OapiMessageCorpconversationAsyncsendV2Request.BtnJsonListDomain> list18 = new List<OapiMessageCorpconversationAsyncsendV2Request.BtnJsonListDomain>();
OapiMessageCorpconversationAsyncsendV2Request.BtnJsonListDomain obj19 = new OapiMessageCorpconversationAsyncsendV2Request.BtnJsonListDomain();
list18.Add(obj19);
obj19.ActionUrl = "action_url";
obj19.Title = "title";
obj16.BtnJsonList= list18;
obj16.BtnOrientation = "btn_orientation";
obj16.SingleUrl = "single_url";
obj16.SingleTitle = "single_title";
obj16.Markdown = "markdown";
obj16.Title = "title";
obj1.ActionCard= obj16;
req.Msg_ = obj1;
req.EnableIdTrans = false;
OapiMessageCorpconversationAsyncsendV2Response rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiMessageCorpconversationAsyncsendV2Request;
$req->setAgentId("123");
$req->setUseridList("123,456");
$req->setDeptIdList("123,456");
$req->setToAllUser("false");
$msg = new Msg;
$msg->msgtype="text";
$text = new Text;
$text->content="123";
$msg->text = $text;
$image = new Image;
$image->media_id="@123";
$msg->image = $image;
$link = new Link;
$link->picUrl="picUrl";
$link->messageUrl="messageUrl";
$link->text="text";
$link->title="title";
$msg->link = $link;
$file = new File;
$file->media_id="media_id";
$msg->file = $file;
$voice = new Voice;
$voice->duration="100";
$voice->media_id="100";
$msg->voice = $voice;
$oa = new OA;
$body = new Body;
$body->author="author";
$body->file_count="file_count";
$body->image="image";
$body->content="content";
$rich = new Rich;
$rich->unit="unit";
$rich->num="num";
$body->rich = $rich;
$form = new Form;
$form->value="value";
$form->key="key";
$body->form = array($form);
$body->title="title";
$oa->body = $body;
$head = new Head;
$head->bgcolor="bgcolor";
$head->text="text";
$oa->head = $head;
$oa->pc_message_url="pc_message_url";
$oa->message_url="message_url";
$status_bar = new StatusBar;
$status_bar->status_value="进行中";
$status_bar->status_bg="0xFFF65E5E";
$oa->status_bar = $status_bar;
$msg->oa = $oa;
$markdown = new Markdown;
$markdown->text="text";
$markdown->title="title";
$msg->markdown = $markdown;
$action_card = new ActionCard;
$btn_json_list = new BtnJsonList;
$btn_json_list->action_url="action_url";
$btn_json_list->title="title";
$action_card->btn_json_list = array($btn_json_list);
$action_card->btn_orientation="btn_orientation";
$action_card->single_url="single_url";
$action_card->single_title="single_title";
$action_card->markdown="markdown";
$action_card->title="title";
$msg->action_card = $action_card;
$req->setMsg($msg);
$req->setEnableIdTrans("false");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend_v2");

curl -X POST "https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend_v2" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=37e346e3-af80-481d-9ca2-f1b4ab97187f' \
-d 'agent_id=123' \
-d 'dept_id_list=123%2C456' \
-d 'enable_id_trans=false' \
-d 'msg=%7B+++++%5C%22msgtype%5C%22%3A+%5C%22text%5C%22%2C+++++%5C%22text%5C%22%3A+%7B+++++++++%5C%22content%5C%22%3A+%5C%22%E5%BC%A0%E4%B8%89%E7%9A%84%E8%AF%B7%E5%81%87%E7%94%B3%E8%AF%B7%5C%22+++++%7D+%7D' \
-d 'to_all_user=false' \
-d 'userid_list=123%2C456'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiMessageCorpconversationAsyncsendV2Request("https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend_v2")

req.agent_id=123
req.userid_list="123,456"
req.dept_id_list="123,456"
req.to_all_user=false
req.msg="{     \"msgtype\": \"text\",     \"text\": {         \"content\": \"张三的请假申请\"     } }"
req.enable_id_trans=false
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.message.corpconversation.asyncsend_v2");
add_param(pRequest,"agent_id","123");
add_param(pRequest,"userid_list","123,456");
add_param(pRequest,"dept_id_list","123,456");
add_param(pRequest,"to_all_user","false");
add_param(pRequest,"msg","数据结构JSON示例");
add_param(pRequest,"enable_id_trans","false");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.message.corpconversation.asyncsend_v2', {
	'agent_id':'123',
	'userid_list':'123,456',
	'dept_id_list':'123,456',
	'to_all_user':'false',
	'msg':'数据结构JSON示例',
	'enable_id_trans':'false'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errmsg":"ok",
    "errcode":0,
    "task_id":123
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.message.corpconversation.asyncsend_v2 (异步发送工作通知消息接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ