开放平台
取消
开放平台
中文
EN
取消
  • 第三方平台 API

    • # 设置第三方平台业务域名

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：modifyThirdpartyJumpDomain

    • 本接口用于配置第三方平台小程序业务域名。

    • 配置业务域名时，需要将校验文件放置在域名根目录下，例如wx.qq.com，并确保可以访问该文件。可以通过获取第三方小程序业务域名的校验文件接口获取检验文件。

    • 授权给第三方代开发的小程序，其业务域名只可以为在第三方平台账号中配置的小程序业务域名。即调用接口设置小程序业务域名之前可以调本接口先进行第三方平台小程序业务域名配置。

    • 使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/cgi-bin/component/modify_wxa_jump_domain?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 component_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    actionstring是操作类型。可选值请看下文
    wxa_jump_h5_domainstring否最多可以添加300个小程序业务域名，以;隔开。注意：域名不需带有http:// 等协议内容，也不能在域名末尾附加详细的 URI 地址，严格按照类似 www.qq.com 的写法。
    is_modify_published_togetherboolean否是否同时修改“全网发布版本的值”。（false：只改“测试版”；true：同时改“测试版”和“全网发布版”）省略时，默认为false。

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber返回码
    errmsgstring错误信息
    published_wxa_jump_h5_domainstring目前生效的 “全网发布版”第三方平台“小程序业务域名”。如果修改失败，该字段不会返回。如果没有已发布的第三方平台，该字段也不会返回。
    testing_wxa_jump_h5_domainstring目前生效的 “测试版”第三方平台“小程序业务域名”。如果修改失败，该字段不会返回
    invalid_wxa_jump_h5_domainstring未通过验证的域名。如果不存在未通过验证的域名，该字段不会返回。

    # 4. 注意事项

    # 其他说明

    # action 可选值

    可选值 说明
    add 添加
    delete 删除
    set 覆盖
    get 获取

    # 5. 代码示例

    # 5.1 POST 数据示例 1:

    请求示例

    {
  "action": "get"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
  "testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    # 5.2 POST 数据示例 2:

    请求示例

    {
  "action": "set",
  "is_modify_published_together": false,
  "wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
  "testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    # 5.3 POST 数据示例 3:

    请求示例

    {
  "action": "add",
  "is_modify_published_together": true,
  "wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
  "testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    # 5.4 POST 数据示例 4:

    请求示例

    {
  "action": "delete",
  "is_modify_published_together": false,
  "wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
  "testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试
    40039invalid url size不合法的 URL 长度
    40052invalid action nameaction值有误
    61028第三方平台未发布第三方平台未发布
    65316domain count reach limit 第三方平台业务域名配置已达300个第三方平台小程序业务域名最多300个，不能再新增了，只能删除旧的不使用的域名再新增。
    9410016存在无效域名。具体原因见errmsg（可能有多种原因）。

    # 7. 适用范围

    本接口支持「第三方平台」账号类型调用。其他账号类型如无特殊说明，均不可调用。