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

dingtalk.oapi.mpdev.previewbuild.create (创建钉钉小程序预览任务)

生成小程序预览二维码

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
plugin_package_key	String	必须	5000000000100101/1600589239142.tar		插件预览包地址
sub_packages	OpenSubPackageVo []	可选		最大列表长度：999	分包数据
└ package_key String 必须 2021001117653027/1600677859426.tar 包地址 └ path String 必须 main 分包路径 └ type String 必须 MAIN 包类型，主包or分包
plugin_refs	PluginReference []	可选		最大列表长度：999	静态插件信息
└ plugin_version String 必须 * 版本号 └ plugin_id String 必须 5000000000100101 插件ID
corpid	String	可选	1234		scheme中corpId值
ignore_webview_domain_check	Boolean	可选	true		忽略web-view安全域名检查
ignore_http_req_permission	Boolean	可选	true		忽略http安全域名检查
query	String	可选	a=2&b=2		scheme query参数
page	String	可选	pages/index/index?a=1		scheme page参数
main_page	String	必须	pages/index/index		包默认主页
enable_tabbar	String	必须	YES		开启tabBar
package_key	String	必须	5000000000100023/1600602347697.tar		预览上传包地址
miniapp_id	String	必须	5000000000101080		小程序ID
build_script_version	String	可选	6.2.3		SDK构建脚本版本
channel	String	可选	1234		远程调试的channel
tyroid	String	可选	1234		远程调试tyroid
is_remote_debug	Boolean	可选	true		远程调试模式
is_remote_x	Boolean	可选	true		remoteX远程调试模式

响应参数

名称	类型	示例值	描述
result	BuildResultVo		返回内容
└ build_info String 1 构建信息 └ build_id String 1234 构建ID └ result_url String xxx 结果url地址 └ log_url String 构建日志地址构建日志地址 └ finished Boolean true 构建完成 └ task_id String 44150 构建任务ID
errcode	Number	1002	错误码
errmsg	String	错误文案	错误文案
success	Boolean	true	成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/mpdev/previewbuild/create");
OapiMpdevPreviewbuildCreateRequest req = new OapiMpdevPreviewbuildCreateRequest();
req.setPluginPackageKey("5000000000100101/1600589239142.tar");
List<OpenSubPackageVo> list2 = new ArrayList<OpenSubPackageVo>();
OpenSubPackageVo obj3 = new OpenSubPackageVo();
list2.add(obj3);
obj3.setPackageKey("2021001117653027/1600677859426.tar");
obj3.setPath("main");
obj3.setType("MAIN");
req.setSubPackages(list2);
List<PluginReference> list5 = new ArrayList<PluginReference>();
PluginReference obj6 = new PluginReference();
list5.add(obj6);
obj6.setPluginVersion("*");
obj6.setPluginId("5000000000100101");
req.setPluginRefs(list5);
req.setCorpid("1234");
req.setIgnoreWebviewDomainCheck(true);
req.setIgnoreHttpReqPermission(true);
req.setQuery("a=2&b=2");
req.setPage("pages/index/index?a=1");
req.setMainPage("pages/index/index");
req.setEnableTabbar("YES");
req.setPackageKey("5000000000100023/1600602347697.tar");
req.setMiniappId("5000000000101080");
req.setBuildScriptVersion("6.2.3");
req.setChannel("1234");
req.setTyroid("1234");
req.setIsRemoteDebug(true);
req.setIsRemoteX(true);
OapiMpdevPreviewbuildCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/mpdev/previewbuild/create");
OapiMpdevPreviewbuildCreateRequest req = new OapiMpdevPreviewbuildCreateRequest();
req.PluginPackageKey = "5000000000100101/1600589239142.tar";
List<OapiMpdevPreviewbuildCreateRequest.OpenSubPackageVoDomain> list2 = new List<OapiMpdevPreviewbuildCreateRequest.OpenSubPackageVoDomain>();
OapiMpdevPreviewbuildCreateRequest.OpenSubPackageVoDomain obj3 = new OapiMpdevPreviewbuildCreateRequest.OpenSubPackageVoDomain();
list2.Add(obj3);
obj3.PackageKey = "2021001117653027/1600677859426.tar";
obj3.Path = "main";
obj3.Type = "MAIN";
req.SubPackages_ = list2;
List<OapiMpdevPreviewbuildCreateRequest.PluginReferenceDomain> list5 = new List<OapiMpdevPreviewbuildCreateRequest.PluginReferenceDomain>();
OapiMpdevPreviewbuildCreateRequest.PluginReferenceDomain obj6 = new OapiMpdevPreviewbuildCreateRequest.PluginReferenceDomain();
list5.Add(obj6);
obj6.PluginVersion = "*";
obj6.PluginId = "5000000000100101";
req.PluginRefs_ = list5;
req.Corpid = "1234";
req.IgnoreWebviewDomainCheck = true;
req.IgnoreHttpReqPermission = true;
req.Query = "a=2&b=2";
req.Page = "pages/index/index?a=1";
req.MainPage = "pages/index/index";
req.EnableTabbar = "YES";
req.PackageKey = "5000000000100023/1600602347697.tar";
req.MiniappId = "5000000000101080";
req.BuildScriptVersion = "6.2.3";
req.Channel = "1234";
req.Tyroid = "1234";
req.IsRemoteDebug = true;
req.IsRemoteX = true;
OapiMpdevPreviewbuildCreateResponse 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 OapiMpdevPreviewbuildCreateRequest;
$req->setPluginPackageKey("5000000000100101/1600589239142.tar");
$sub_packages = new OpenSubPackageVo;
$sub_packages->package_key="2021001117653027/1600677859426.tar";
$sub_packages->path="main";
$sub_packages->type="MAIN";
$req->setSubPackages(array($sub_packages));
$plugin_refs = new PluginReference;
$plugin_refs->plugin_version="*";
$plugin_refs->plugin_id="5000000000100101";
$req->setPluginRefs(array($plugin_refs));
$req->setCorpid("1234");
$req->setIgnoreWebviewDomainCheck("true");
$req->setIgnoreHttpReqPermission("true");
$req->setQuery("a=2&b=2");
$req->setPage("pages/index/index?a=1");
$req->setMainPage("pages/index/index");
$req->setEnableTabbar("YES");
$req->setPackageKey("5000000000100023/1600602347697.tar");
$req->setMiniappId("5000000000101080");
$req->setBuildScriptVersion("6.2.3");
$req->setChannel("1234");
$req->setTyroid("1234");
$req->setIsRemoteDebug("true");
$req->setIsRemoteX("true");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/mpdev/previewbuild/create");

curl -X POST "https://oapi.dingtalk.com/topapi/mpdev/previewbuild/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=386c525f-330b-4daa-9fab-cde7ccfd04aa' \
-d 'build_script_version=6.2.3' \
-d 'channel=1234' \
-d 'corpid=1234' \
-d 'enable_tabbar=YES' \
-d 'ignore_http_req_permission=true' \
-d 'ignore_webview_domain_check=true' \
-d 'is_remote_debug=true' \
-d 'is_remote_x=true' \
-d 'main_page=pages%2Findex%2Findex' \
-d 'miniapp_id=5000000000101080' \
-d 'package_key=5000000000100023%2F1600602347697.tar' \
-d 'page=pages%2Findex%2Findex%3Fa%3D1' \
-d 'plugin_package_key=5000000000100101%2F1600589239142.tar' \
-d 'plugin_refs=null' \
-d 'query=a%3D2%26b%3D2' \
-d 'sub_packages=null' \
-d 'tyroid=1234'

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

req=dingtalk.api.OapiMpdevPreviewbuildCreateRequest("https://oapi.dingtalk.com/topapi/mpdev/previewbuild/create")

req.plugin_package_key="5000000000100101/1600589239142.tar"
req.sub_packages=""
req.plugin_refs=""
req.corpid="1234"
req.ignore_webview_domain_check=true
req.ignore_http_req_permission=true
req.query="a=2&b=2"
req.page="pages/index/index?a=1"
req.main_page="pages/index/index"
req.enable_tabbar="YES"
req.package_key="5000000000100023/1600602347697.tar"
req.miniapp_id="5000000000101080"
req.build_script_version="6.2.3"
req.channel="1234"
req.tyroid="1234"
req.is_remote_debug=true
req.is_remote_x=true
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.mpdev.previewbuild.create");
add_param(pRequest,"plugin_package_key","5000000000100101/1600589239142.tar");
add_param(pRequest,"sub_packages","数据结构JSON示例");
add_param(pRequest,"plugin_refs","数据结构JSON示例");
add_param(pRequest,"corpid","1234");
add_param(pRequest,"ignore_webview_domain_check","true");
add_param(pRequest,"ignore_http_req_permission","true");
add_param(pRequest,"query","a=2&b=2");
add_param(pRequest,"page","pages/index/index?a=1");
add_param(pRequest,"main_page","pages/index/index");
add_param(pRequest,"enable_tabbar","YES");
add_param(pRequest,"package_key","5000000000100023/1600602347697.tar");
add_param(pRequest,"miniapp_id","5000000000101080");
add_param(pRequest,"build_script_version","6.2.3");
add_param(pRequest,"channel","1234");
add_param(pRequest,"tyroid","1234");
add_param(pRequest,"is_remote_debug","true");
add_param(pRequest,"is_remote_x","true");
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.mpdev.previewbuild.create', {
	'plugin_package_key':'5000000000100101/1600589239142.tar',
	'sub_packages':'数据结构JSON示例',
	'plugin_refs':'数据结构JSON示例',
	'corpid':'1234',
	'ignore_webview_domain_check':'true',
	'ignore_http_req_permission':'true',
	'query':'a=2&b=2',
	'page':'pages/index/index?a=1',
	'main_page':'pages/index/index',
	'enable_tabbar':'YES',
	'package_key':'5000000000100023/1600602347697.tar',
	'miniapp_id':'5000000000101080',
	'build_script_version':'6.2.3',
	'channel':'1234',
	'tyroid':'1234',
	'is_remote_debug':'true',
	'is_remote_x':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "build_info":"1",
        "build_id":"1234",
        "result_url":"xxx",
        "log_url":"构建日志地址",
        "finished":true,
        "task_id":"44150"
    },
    "errcode":1002,
    "errmsg":"错误文案",
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.mpdev.previewbuild.create (创建钉钉小程序预览任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈