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

dingtalk.corp.message.corpconversation.asyncsendbycode (通过用户授权码异步向企业会话发送消息)

通过用户授权码异步向企业会话发送消息

公共参数

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
msgtype	String	必须	oa		消息类型,如text、file、oa等，具体见文档
agent_id	Number	必须	1234		微应用的id
user_id_list	String []	可选	zhangsan,lisi	最大列表长度：20	接收者的用户userid列表
dept_id_list	Number []	可选	123,456	最大列表长度：20	接收者的部门id列表
to_all_user	Boolean	可选	false	默认值：false	是否发送给企业全部用户
msgcontent	Json	必须	{"message_url": "http://dingtalk.com","head": {"bgcolor": "FFBBBBBB","text": "头部标题"},"body": {"title": "正文标题","form": [{"key": "姓名:","value": "张三"},{"key": "爱好:","value": "打球、听音乐"}],"rich": {"num": "15.6","unit": "元"},"content": "大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本","image": "@lADOADmaWMzazQKA","file_count": "3","author": "李四 "}}		与msgtype对应的消息体，具体见文档
code	String	必须	7dsf78d78sf87sd		用户操作产生的授权码

响应参数

名称	类型	示例值	描述
result	DingOpenResult	{}	result
└ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String "ok" errorMsg └ success Boolean true success └ task_id Number 123 异步发送任务的id

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpMessageCorpconversationAsyncsendbycodeRequest req = new CorpMessageCorpconversationAsyncsendbycodeRequest();
req.setMsgtype("oa");
req.setAgentId(1234L);
req.setUserIdList("zhangsan,lisi");
req.setDeptIdList("123,456");
req.setToAllUser(false);
req.setMsgcontentString("{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}");
req.setCode("7dsf78d78sf87sd");
CorpMessageCorpconversationAsyncsendbycodeResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpMessageCorpconversationAsyncsendbycodeRequest req = new CorpMessageCorpconversationAsyncsendbycodeRequest();
req.Msgtype = "oa";
req.AgentId = 1234L;
req.UserIdList = "zhangsan,lisi";
req.DeptIdList = "123,456";
req.ToAllUser = false;
req.Msgcontent = "{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}";
req.Code = "7dsf78d78sf87sd";
CorpMessageCorpconversationAsyncsendbycodeResponse 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_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new CorpMessageCorpconversationAsyncsendbycodeRequest;
$req->setMsgtype("oa");
$req->setAgentId("1234");
$req->setUserIdList("zhangsan,lisi");
$req->setDeptIdList("123,456");
$req->setToAllUser("false");
$req->setMsgcontent("{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}");
$req->setCode("7dsf78d78sf87sd");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.corp.message.corpconversation.asyncsendbycode' \
-d 'partner_id=apidoc' \
-d 'session=0cfea9e2-e764-4b12-b1f3-90dd43db2162' \
-d 'timestamp=2025-04-24+15%3A26%3A35' \
-d 'v=2.0' \
-d 'agent_id=1234' \
-d 'code=7dsf78d78sf87sd' \
-d 'dept_id_list=123%2C456' \
-d 'msgcontent=%7B%5C%22message_url%5C%22%3A+%5C%22http%3A%2F%2Fdingtalk.com%5C%22%2C%5C%22head%5C%22%3A+%7B%5C%22bgcolor%5C%22%3A+%5C%22FFBBBBBB%5C%22%2C%5C%22text%5C%22%3A+%5C%22%E5%A4%B4%E9%83%A8%E6%A0%87%E9%A2%98%5C%22%7D%2C%5C%22body%5C%22%3A+%7B%5C%22title%5C%22%3A+%5C%22%E6%AD%A3%E6%96%87%E6%A0%87%E9%A2%98%5C%22%2C%5C%22form%5C%22%3A+%5B%7B%5C%22key%5C%22%3A+%5C%22%E5%A7%93%E5%90%8D%3A%5C%22%2C%5C%22value%5C%22%3A+%5C%22%E5%BC%A0%E4%B8%89%5C%22%7D%2C%7B%5C%22key%5C%22%3A+%5C%22%E7%88%B1%E5%A5%BD%3A%5C%22%2C%5C%22value%5C%22%3A+%5C%22%E6%89%93%E7%90%83%E3%80%81%E5%90%AC%E9%9F%B3%E4%B9%90%5C%22%7D%5D%2C%5C%22rich%5C%22%3A+%7B%5C%22num%5C%22%3A+%5C%2215.6%5C%22%2C%5C%22unit%5C%22%3A+%5C%22%E5%85%83%5C%22%7D%2C%5C%22content%5C%22%3A+%5C%22%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%E5%A4%A7%E6%AE%B5%E6%96%87%E6%9C%AC%5C%22%2C%5C%22image%5C%22%3A+%5C%22%40lADOADmaWMzazQKA%5C%22%2C%5C%22file_count%5C%22%3A+%5C%223%5C%22%2C%5C%22author%5C%22%3A+%5C%22%E6%9D%8E%E5%9B%9B+%5C%22%7D%7D' \
-d 'msgtype=oa' \
-d 'to_all_user=false' \
-d 'user_id_list=zhangsan%2Clisi'

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

req=dingtalk.api.CorpMessageCorpconversationAsyncsendbycodeRequest("https://eco.taobao.com/router/rest")

req.msgtype="oa"
req.agent_id=1234
req.user_id_list="zhangsan,lisi"
req.dept_id_list="123,456"
req.to_all_user=false
req.msgcontent="{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}"
req.code="7dsf78d78sf87sd"
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.corp.message.corpconversation.asyncsendbycode");
add_param(pRequest,"msgtype","oa");
add_param(pRequest,"agent_id","1234");
add_param(pRequest,"user_id_list","zhangsan,lisi");
add_param(pRequest,"dept_id_list","123,456");
add_param(pRequest,"to_all_user","false");
add_param(pRequest,"msgcontent","{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}");
add_param(pRequest,"code","7dsf78d78sf87sd");
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.corp.message.corpconversation.asyncsendbycode', {
	'msgtype':'oa',
	'agent_id':'1234',
	'user_id_list':'zhangsan,lisi',
	'dept_id_list':'123,456',
	'to_all_user':'false',
	'msgcontent':'{\"message_url\": \"http://dingtalk.com\",\"head\": {\"bgcolor\": \"FFBBBBBB\",\"text\": \"头部标题\"},\"body\": {\"title\": \"正文标题\",\"form\": [{\"key\": \"姓名:\",\"value\": \"张三\"},{\"key\": \"爱好:\",\"value\": \"打球、听音乐\"}],\"rich\": {\"num\": \"15.6\",\"unit\": \"元\"},\"content\": \"大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本\",\"image\": \"@lADOADmaWMzazQKA\",\"file_count\": \"3\",\"author\": \"李四 \"}}',
	'code':'7dsf78d78sf87sd'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_message_corpconversation_asyncsendbycode_response>
    <result>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>&quot;ok&quot;</error_msg>
        <success>true</success>
        <task_id>123</task_id>
    </result>
</dingtalk_corp_message_corpconversation_asyncsendbycode_response>

{
    "dingtalk_corp_message_corpconversation_asyncsendbycode_response":{
        "result":{
            "ding_open_errcode":0,
            "error_msg":"\"ok\"",
            "success":true,
            "task_id":123
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

钉钉API

dingtalk.corp.message.corpconversation.asyncsendbycode (通过用户授权码异步向企业会话发送消息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈