文档中心 > API类目 > miniapp开放API

taobao.miniapp.template.offlineapp (下线实例化应用)

对指定的实例化小程序进行下线,需要指定clients和app_version

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
clients String [] 必须 taobao,tmall
  • 最大列表长度:999
  • 要下线的投放端,目前可投放: taobao(淘宝),tmall(天猫)
    app_id String 必须 123 要下线的小程序app_id
    app_version String 必须 0.0.1 要下线的小程序版本号
    template_id String 必须 123 模板id

    响应参数

    名称 类型 示例值 描述
    app_id String 123 下线的appId
    offline_results MiniappInstanceAppOfflineDto [] {} 各端的下线结果
    • └ client
    • String
    • taobao
    • 端信息
    • └ fail_msg
    • String
    • taobao端上没有该版本
    • 错误信息
    • └ success
    • Boolean
    • true
    • 是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    MiniappTemplateOfflineappRequest req = new MiniappTemplateOfflineappRequest();
    req.setClients("taobao,tmall");
    req.setAppId("123");
    req.setAppVersion("0.0.1");
    req.setTemplateId("123");
    MiniappTemplateOfflineappResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <miniapp_template_offlineapp_response>
        <app_id>123</app_id>
        <offline_results>
            <miniapp_instance_app_offline_dto>
                <client>taobao</client>
                <fail_msg>taobao端上没有该版本</fail_msg>
                <success>true</success>
            </miniapp_instance_app_offline_dto>
        </offline_results>
    </miniapp_template_offlineapp_response>

    异常示例

    • 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>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部