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

dingtalk.corp.chatbot.addchatbotinstance (向群添加机器人接口)

企业应用，向自己的企业群，添加已安装的企业机器人

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
chatbot_id	String	必须	teacher	机器人id，由钉钉事先分配
open_conversation_id	String	必须	cid3UpldCu6k9m0BocWGiElVw	创建群时返回的openConvsationId
name	String	可选	马老师	机器人名字(如果为空，默认是机器人安装时的名字)
icon_media_id	String	可选	@dsa8d87y7c8d8c	机器人头像(如果为空，默认是机器人安装时的头像)

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
result ChatbotInstanceVo result └ chatbot_user_id String 3UpldCu6k9m0BocWGiElVw== 机器人实例userId └ webhook String https://oapi.dingtalk.com/robot/send?access_token=dfa11e0a1bc80a40c5c2731ba923f944c4fa93d883cc30fd5c3fad3b732c 机器人发消息时的地址 └ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String ok errorMsg └ success Boolean true success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpChatbotAddchatbotinstanceRequest req = new CorpChatbotAddchatbotinstanceRequest();
req.setChatbotId("teacher");
req.setOpenConversationId("cid3UpldCu6k9m0BocWGiElVw");
req.setName("马老师");
req.setIconMediaId("@dsa8d87y7c8d8c");
CorpChatbotAddchatbotinstanceResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpChatbotAddchatbotinstanceRequest req = new CorpChatbotAddchatbotinstanceRequest();
req.ChatbotId = "teacher";
req.OpenConversationId = "cid3UpldCu6k9m0BocWGiElVw";
req.Name = "马老师";
req.IconMediaId = "@dsa8d87y7c8d8c";
CorpChatbotAddchatbotinstanceResponse 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 CorpChatbotAddchatbotinstanceRequest;
$req->setChatbotId("teacher");
$req->setOpenConversationId("cid3UpldCu6k9m0BocWGiElVw");
$req->setName("马老师");
$req->setIconMediaId("@dsa8d87y7c8d8c");
$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.chatbot.addchatbotinstance' \
-d 'partner_id=apidoc' \
-d 'session=d0d97105-af5b-4e95-9ccd-fcfe215f23fb' \
-d 'timestamp=2025-05-09+21%3A11%3A30' \
-d 'v=2.0' \
-d 'chatbot_id=teacher' \
-d 'icon_media_id=%40dsa8d87y7c8d8c' \
-d 'name=%E9%A9%AC%E8%80%81%E5%B8%88' \
-d 'open_conversation_id=cid3UpldCu6k9m0BocWGiElVw'

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

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

req.chatbot_id="teacher"
req.open_conversation_id="cid3UpldCu6k9m0BocWGiElVw"
req.name="马老师"
req.icon_media_id="@dsa8d87y7c8d8c"
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.chatbot.addchatbotinstance");
add_param(pRequest,"chatbot_id","teacher");
add_param(pRequest,"open_conversation_id","cid3UpldCu6k9m0BocWGiElVw");
add_param(pRequest,"name","马老师");
add_param(pRequest,"icon_media_id","@dsa8d87y7c8d8c");
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.chatbot.addchatbotinstance', {
	'chatbot_id':'teacher',
	'open_conversation_id':'cid3UpldCu6k9m0BocWGiElVw',
	'name':'马老师',
	'icon_media_id':'@dsa8d87y7c8d8c'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_chatbot_addchatbotinstance_response>
    <result>
        <result>
            <chatbot_user_id>3UpldCu6k9m0BocWGiElVw==</chatbot_user_id>
            <webhook>https://oapi.dingtalk.com/robot/send?access_token=dfa11e0a1bc80a40c5c2731ba923f944c4fa93d883cc30fd5c3fad3b732c</webhook>
        </result>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>ok</error_msg>
        <success>true</success>
    </result>
</dingtalk_corp_chatbot_addchatbotinstance_response>

{
    "dingtalk_corp_chatbot_addchatbotinstance_response":{
        "result":{
            "result":{
                "chatbot_user_id":"3UpldCu6k9m0BocWGiElVw==",
                "webhook":"https:\/\/oapi.dingtalk.com\/robot\/send?access_token=dfa11e0a1bc80a40c5c2731ba923f944c4fa93d883cc30fd5c3fad3b732c"
            },
            "ding_open_errcode":0,
            "error_msg":"ok",
            "success":true
        }
    }
}

异常示例

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.chatbot.addchatbotinstance (向群添加机器人接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ