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

生成小程序预览二维码

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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());

    响应示例

    • 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

    FAQ

    返回
    顶部