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

dingtalk.oapi.chatbot.install (ISV给企业安装机器人)

企业安装微应用后，ISV可通过本接口给企业上架一个企业机器人。目前灰度几个ISV，机器人应用会白名单处理

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
chatbot_vo	ChatbotVo	必须			安装的机器人信息
└ icon String 必须 @dsa8d87y7c8d8c 机器人头像mediaId └ name_modify Number 必须 0 向群添加机器人时是否可改名字：0-不可必，1-可改 └ chatbot_id String 必须 gitLab 机器人id(钉钉分配) └ breif String 必须基于ROR的开源代码托管软件机器人简介 └ function Number 必须 3 INCOMING = 1,OUTGOING = 2,INOUT = 3 └ outgoing_url String 必须 http:xxx 机器人回调URL └ authority Number 必须 0 0-正常，1-只服务端可管理 └ preview_media_id String 必须 @dsa8d87y7c8d8c 机器人预览图 └ bot_type Number 必须 2 2-企业对内机器人，3-企业对外机器人 └ mobile_switch Number 必须 1 手机端是否能添加机器人：0-移动端不能加，1-移动端能添加 └ description String 必须优秀的代码托管服务，将接收到项目变更实时通知机器详细介绍 └ name String 必须项目通知机器人的名字 └ icon_mdify Number 必须 0 向群添加机器人时是否可改头像：0-不可必，1-可改 └ outgoing_token String 必须 1220ba9606120714e5eb2285e992680a6 机器人消息回调时在header中添加的token,用于对钉钉鉴权 └ oto_support Number 可选 0 是否支持单聊：0-不要单聊，1需要单聊

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
└ errcode Number -1 dingOpenErrcode └ errmsg String 系统繁忙 errorMsg └ success Boolean true success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chatbot/install");
OapiChatbotInstallRequest req = new OapiChatbotInstallRequest();
ChatbotVo obj1 = new ChatbotVo();
obj1.setIcon("@dsa8d87y7c8d8c");
obj1.setNameModify(0L);
obj1.setChatbotId("gitLab");
obj1.setBreif("基于ROR的开源代码托管软件");
obj1.setFunction(3L);
obj1.setOutgoingUrl("http:xxx");
obj1.setAuthority(0L);
obj1.setPreviewMediaId("@dsa8d87y7c8d8c");
obj1.setBotType(2L);
obj1.setMobileSwitch(1L);
obj1.setDescription("优秀的代码托管服务，将接收到项目变更实时通知");
obj1.setName("项目通知");
obj1.setIconMdify(0L);
obj1.setOutgoingToken("1220ba9606120714e5eb2285e992680a6");
obj1.setOtoSupport(0L);
req.setChatbotVo(obj1);
OapiChatbotInstallResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chatbot/install");
OapiChatbotInstallRequest req = new OapiChatbotInstallRequest();
OapiChatbotInstallRequest.ChatbotVoDomain obj1 = new OapiChatbotInstallRequest.ChatbotVoDomain();
obj1.Icon = "@dsa8d87y7c8d8c";
obj1.NameModify = 0L;
obj1.ChatbotId = "gitLab";
obj1.Breif = "基于ROR的开源代码托管软件";
obj1.Function = 3L;
obj1.OutgoingUrl = "http:xxx";
obj1.Authority = 0L;
obj1.PreviewMediaId = "@dsa8d87y7c8d8c";
obj1.BotType = 2L;
obj1.MobileSwitch = 1L;
obj1.Description = "优秀的代码托管服务，将接收到项目变更实时通知";
obj1.Name = "项目通知";
obj1.IconMdify = 0L;
obj1.OutgoingToken = "1220ba9606120714e5eb2285e992680a6";
obj1.OtoSupport = 0L;
req.ChatbotVo_ = obj1;
OapiChatbotInstallResponse 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 OapiChatbotInstallRequest;
$chatbot_vo = new ChatbotVo;
$chatbot_vo->icon="@dsa8d87y7c8d8c";
$chatbot_vo->name_modify="0";
$chatbot_vo->chatbot_id="gitLab";
$chatbot_vo->breif="基于ROR的开源代码托管软件";
$chatbot_vo->function="3";
$chatbot_vo->outgoing_url="http:xxx";
$chatbot_vo->authority="0";
$chatbot_vo->preview_media_id="@dsa8d87y7c8d8c";
$chatbot_vo->bot_type="2";
$chatbot_vo->mobile_switch="1";
$chatbot_vo->description="优秀的代码托管服务，将接收到项目变更实时通知";
$chatbot_vo->name="项目通知";
$chatbot_vo->icon_mdify="0";
$chatbot_vo->outgoing_token="1220ba9606120714e5eb2285e992680a6";
$chatbot_vo->oto_support="0";
$req->setChatbotVo($chatbot_vo);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/chatbot/install");

curl -X POST "https://oapi.dingtalk.com/topapi/chatbot/install" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=095effdb-95b4-4144-82fe-b219bd64720f' \
-d 'chatbot_vo=null'

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

req=dingtalk.api.OapiChatbotInstallRequest("https://oapi.dingtalk.com/topapi/chatbot/install")

req.chatbot_vo=""
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.chatbot.install");
add_param(pRequest,"chatbot_vo","数据结构JSON示例");
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.chatbot.install', {
	'chatbot_vo':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "errcode":-1,
        "errmsg":"系统繁忙",
        "success":true
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.chatbot.install (ISV给企业安装机器人)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ