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

dingtalk.oapi.microapp.custom.update (定制应用更新接口)

定制应用更新接口

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
agent_id	Number	必须	100000	定制应用Id
omp_link	String	可选	https://dingtalk.com	管理后台地址
homepage_link	String	可选	https://dingtalk.com	移动端首页地址
pc_homepage_link	String	可选	https://dingtalk.com	PC端首页地址
ip_white_list	String	必须	1.1.1.1,2.2.2.3	出口IP白名单
icon	String	可选	@xxx	微应用图标
desc	String	必须	应用描述	应用描述
name	String	必须	名称	应用名称
app_corp_id	String	必须	dingxxx	应用所属企业corpId
top_related_corp_id	String	必须	dingyyy	应用所属组织的顶级关联组织corpId

响应参数

名称	类型	示例值	描述
errmsg	String	ok	错误文案
errcode	Number	0	错误码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/microapp/custom/update");
OapiMicroappCustomUpdateRequest req = new OapiMicroappCustomUpdateRequest();
req.setAgentId(100000L);
req.setOmpLink("https://dingtalk.com");
req.setHomepageLink("https://dingtalk.com");
req.setPcHomepageLink("https://dingtalk.com");
req.setIpWhiteList("1.1.1.1,2.2.2.3");
req.setIcon("@xxx");
req.setDesc("应用描述");
req.setName("名称");
req.setAppCorpId("dingxxx");
req.setTopRelatedCorpId("dingyyy");
OapiMicroappCustomUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/microapp/custom/update");
OapiMicroappCustomUpdateRequest req = new OapiMicroappCustomUpdateRequest();
req.AgentId = 100000L;
req.OmpLink = "https://dingtalk.com";
req.HomepageLink = "https://dingtalk.com";
req.PcHomepageLink = "https://dingtalk.com";
req.IpWhiteList = "1.1.1.1,2.2.2.3";
req.Icon = "@xxx";
req.Desc = "应用描述";
req.Name = "名称";
req.AppCorpId = "dingxxx";
req.TopRelatedCorpId = "dingyyy";
OapiMicroappCustomUpdateResponse 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 OapiMicroappCustomUpdateRequest;
$req->setAgentId("100000");
$req->setOmpLink("https://dingtalk.com");
$req->setHomepageLink("https://dingtalk.com");
$req->setPcHomepageLink("https://dingtalk.com");
$req->setIpWhiteList("1.1.1.1,2.2.2.3");
$req->setIcon("@xxx");
$req->setDesc("应用描述");
$req->setName("名称");
$req->setAppCorpId("dingxxx");
$req->setTopRelatedCorpId("dingyyy");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/microapp/custom/update");

curl -X POST "https://oapi.dingtalk.com/topapi/microapp/custom/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d09d6df9-1f6d-4ac0-93ac-6e1ed64436cf' \
-d 'agent_id=100000' \
-d 'app_corp_id=dingxxx' \
-d 'desc=%E5%BA%94%E7%94%A8%E6%8F%8F%E8%BF%B0' \
-d 'homepage_link=https%3A%2F%2Fdingtalk.com' \
-d 'icon=%40xxx' \
-d 'ip_white_list=1.1.1.1%2C2.2.2.3' \
-d 'name=%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=dingyyy'

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

req=dingtalk.api.OapiMicroappCustomUpdateRequest("https://oapi.dingtalk.com/topapi/microapp/custom/update")

req.agent_id=100000
req.omp_link="https://dingtalk.com"
req.homepage_link="https://dingtalk.com"
req.pc_homepage_link="https://dingtalk.com"
req.ip_white_list="1.1.1.1,2.2.2.3"
req.icon="@xxx"
req.desc="应用描述"
req.name="名称"
req.app_corp_id="dingxxx"
req.top_related_corp_id="dingyyy"
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.update");
add_param(pRequest,"agent_id","100000");
add_param(pRequest,"omp_link","https://dingtalk.com");
add_param(pRequest,"homepage_link","https://dingtalk.com");
add_param(pRequest,"pc_homepage_link","https://dingtalk.com");
add_param(pRequest,"ip_white_list","1.1.1.1,2.2.2.3");
add_param(pRequest,"icon","@xxx");
add_param(pRequest,"desc","应用描述");
add_param(pRequest,"name","名称");
add_param(pRequest,"app_corp_id","dingxxx");
add_param(pRequest,"top_related_corp_id","dingyyy");
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.update', {
	'agent_id':'100000',
	'omp_link':'https://dingtalk.com',
	'homepage_link':'https://dingtalk.com',
	'pc_homepage_link':'https://dingtalk.com',
	'ip_white_list':'1.1.1.1,2.2.2.3',
	'icon':'@xxx',
	'desc':'应用描述',
	'name':'名称',
	'app_corp_id':'dingxxx',
	'top_related_corp_id':'dingyyy'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

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

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.microapp.custom.update (定制应用更新接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ