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

dingtalk.oapi.message.corpconversation.asyncsend (企业会话消息异步发送)

企业会话消息异步发送接口

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
msgtype	String	必须	oa		消息类型,如text、file、oa等，具体见文档
agent_id	Number	必须	1234		微应用的id
userid_list	String []	可选	zhangsan,lisi	最大列表长度：100	接收者的用户userid列表
dept_id_list	Number []	可选	123,456	最大列表长度：20	接收者的部门id列表
to_all_user	Boolean	可选	false	默认值：false	是否发送给企业全部用户
msgcontent	Json	必须	{"content":"消息内容"}		与msgtype对应的消息体，具体见文档

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
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");
OapiMessageCorpconversationAsyncsendRequest req = new OapiMessageCorpconversationAsyncsendRequest();
req.setMsgtype("oa");
req.setAgentId(1234L);
req.setUseridList("zhangsan,lisi");
req.setDeptIdList("123,456");
req.setToAllUser(false);
req.setMsgcontentString("{\"content\":\"消息内容\"}");
OapiMessageCorpconversationAsyncsendResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend");
OapiMessageCorpconversationAsyncsendRequest req = new OapiMessageCorpconversationAsyncsendRequest();
req.Msgtype = "oa";
req.AgentId = 1234L;
req.UseridList = "zhangsan,lisi";
req.DeptIdList = "123,456";
req.ToAllUser = false;
req.Msgcontent = "{\"content\":\"消息内容\"}";
OapiMessageCorpconversationAsyncsendResponse 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 OapiMessageCorpconversationAsyncsendRequest;
$req->setMsgtype("oa");
$req->setAgentId("1234");
$req->setUseridList("zhangsan,lisi");
$req->setDeptIdList("123,456");
$req->setToAllUser("false");
$req->setMsgcontent("{\"content\":\"消息内容\"}");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend");

curl -X POST "https://oapi.dingtalk.com/topapi/message/corpconversation/asyncsend" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2b086256-00b4-48e0-9091-d28c46fd61b4' \
-d 'agent_id=1234' \
-d 'dept_id_list=123%2C456' \
-d 'msgcontent=%7B%5C%22content%5C%22%3A%5C%22%E6%B6%88%E6%81%AF%E5%86%85%E5%AE%B9%5C%22%7D' \
-d 'msgtype=oa' \
-d 'to_all_user=false' \
-d 'userid_list=zhangsan%2Clisi'

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

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

req.msgtype="oa"
req.agent_id=1234
req.userid_list="zhangsan,lisi"
req.dept_id_list="123,456"
req.to_all_user=false
req.msgcontent="{\"content\":\"消息内容\"}"
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");
add_param(pRequest,"msgtype","oa");
add_param(pRequest,"agent_id","1234");
add_param(pRequest,"userid_list","zhangsan,lisi");
add_param(pRequest,"dept_id_list","123,456");
add_param(pRequest,"to_all_user","false");
add_param(pRequest,"msgcontent","{\"content\":\"消息内容\"}");
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', {
	'msgtype':'oa',
	'agent_id':'1234',
	'userid_list':'zhangsan,lisi',
	'dept_id_list':'123,456',
	'to_all_user':'false',
	'msgcontent':'{\"content\":\"消息内容\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

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

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.message.corpconversation.asyncsend (企业会话消息异步发送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ