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

dingtalk.oapi.microapp.custom.create (定制应用创建接口)

定制应用创建接口

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
omp_link	String	可选	https://dingtalk.com		管理后台地址
pc_homepage_link	String	可选	https://dingtalk.com		PC端地址
homepage_link	String	可选	https://dingtalk.com		移动端地址
ip_white_list	String	可选	“1.1.1.1,2.2.2.2”		“1.1.1.1,2.2.2.2”
icon	String	可选	@mediaId		微应用图标, /media/upload生成
desc	String	必须	微应用描述		微应用描述
name	String	必须	微应用名称		微应用名称
app_corp_id	String	必须	ding2df95b61b5ec2f0e		定制应用所属企业
top_related_corp_id	String	必须	ding2df95b61b5ec2f0e		定制应用所属企业的顶级管理组织，通过该组织判断调用接口的白名单
develop_type	Number	可选	0	默认值：0	微应用类型0 H5 1小程序

响应参数

名称	类型	示例值	描述
result	CustomAppCreateResponseVo	{}	定制应用
└ custom_secret String xxxx 定制应用secret └ custom_key String yyyyy 定制应用key └ agent_id Number 1111 定制应用id
errmsg	String	ok	错误描述文案
errcode	Number	0	错误码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
OapiMicroappCustomCreateRequest req = new OapiMicroappCustomCreateRequest();
req.setOmpLink("https://dingtalk.com");
req.setPcHomepageLink("https://dingtalk.com");
req.setHomepageLink("https://dingtalk.com");
req.setIpWhiteList("“1.1.1.1,2.2.2.2”");
req.setIcon("@mediaId");
req.setDesc("微应用描述");
req.setName("微应用名称");
req.setAppCorpId("ding2df95b61b5ec2f0e");
req.setTopRelatedCorpId("ding2df95b61b5ec2f0e");
req.setDevelopType(0L);
OapiMicroappCustomCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
OapiMicroappCustomCreateRequest req = new OapiMicroappCustomCreateRequest();
req.OmpLink = "https://dingtalk.com";
req.PcHomepageLink = "https://dingtalk.com";
req.HomepageLink = "https://dingtalk.com";
req.IpWhiteList = "“1.1.1.1,2.2.2.2”";
req.Icon = "@mediaId";
req.Desc = "微应用描述";
req.Name = "微应用名称";
req.AppCorpId = "ding2df95b61b5ec2f0e";
req.TopRelatedCorpId = "ding2df95b61b5ec2f0e";
req.DevelopType = 0L;
OapiMicroappCustomCreateResponse 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 OapiMicroappCustomCreateRequest;
$req->setOmpLink("https://dingtalk.com");
$req->setPcHomepageLink("https://dingtalk.com");
$req->setHomepageLink("https://dingtalk.com");
$req->setIpWhiteList("“1.1.1.1,2.2.2.2”");
$req->setIcon("@mediaId");
$req->setDesc("微应用描述");
$req->setName("微应用名称");
$req->setAppCorpId("ding2df95b61b5ec2f0e");
$req->setTopRelatedCorpId("ding2df95b61b5ec2f0e");
$req->setDevelopType("0");
$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.oapi.microapp.custom.create' \
-d 'partner_id=apidoc' \
-d 'session=ea654574-1817-407b-be47-954f7f020cb7' \
-d 'timestamp=2025-05-09+21%3A56%3A59' \
-d 'v=2.0' \
-d 'app_corp_id=ding2df95b61b5ec2f0e' \
-d 'desc=%E5%BE%AE%E5%BA%94%E7%94%A8%E6%8F%8F%E8%BF%B0' \
-d 'develop_type=0' \
-d 'homepage_link=https%3A%2F%2Fdingtalk.com' \
-d 'icon=%40mediaId' \
-d 'ip_white_list=%E2%80%9C1.1.1.1%2C2.2.2.2%E2%80%9D' \
-d 'name=%E5%BE%AE%E5%BA%94%E7%94%A8%E5%90%8D%E7%A7%B0' \
-d 'omp_link=https%3A%2F%2Fdingtalk.com' \
-d 'pc_homepage_link=https%3A%2F%2Fdingtalk.com' \
-d 'top_related_corp_id=ding2df95b61b5ec2f0e'

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

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

req.omp_link="https://dingtalk.com"
req.pc_homepage_link="https://dingtalk.com"
req.homepage_link="https://dingtalk.com"
req.ip_white_list="“1.1.1.1,2.2.2.2”"
req.icon="@mediaId"
req.desc="微应用描述"
req.name="微应用名称"
req.app_corp_id="ding2df95b61b5ec2f0e"
req.top_related_corp_id="ding2df95b61b5ec2f0e"
req.develop_type=0
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.microapp.custom.create");
add_param(pRequest,"omp_link","https://dingtalk.com");
add_param(pRequest,"pc_homepage_link","https://dingtalk.com");
add_param(pRequest,"homepage_link","https://dingtalk.com");
add_param(pRequest,"ip_white_list","“1.1.1.1,2.2.2.2”");
add_param(pRequest,"icon","@mediaId");
add_param(pRequest,"desc","微应用描述");
add_param(pRequest,"name","微应用名称");
add_param(pRequest,"app_corp_id","ding2df95b61b5ec2f0e");
add_param(pRequest,"top_related_corp_id","ding2df95b61b5ec2f0e");
add_param(pRequest,"develop_type","0");
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.microapp.custom.create', {
	'omp_link':'https://dingtalk.com',
	'pc_homepage_link':'https://dingtalk.com',
	'homepage_link':'https://dingtalk.com',
	'ip_white_list':'“1.1.1.1,2.2.2.2”',
	'icon':'@mediaId',
	'desc':'微应用描述',
	'name':'微应用名称',
	'app_corp_id':'ding2df95b61b5ec2f0e',
	'top_related_corp_id':'ding2df95b61b5ec2f0e',
	'develop_type':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_oapi_microapp_custom_create_response>
    <result>
        <custom_secret>xxxx</custom_secret>
        <custom_key>yyyyy</custom_key>
        <agent_id>1111</agent_id>
    </result>
    <errmsg>ok</errmsg>
    <errcode>0</errcode>
</dingtalk_oapi_microapp_custom_create_response>

{
    "dingtalk_oapi_microapp_custom_create_response":{
        "result":{
            "custom_secret":"xxxx",
            "custom_key":"yyyyy",
            "agent_id":1111
        },
        "errmsg":"ok",
        "errcode":0
    }
}

异常示例

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.oapi.microapp.custom.create (定制应用创建接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ