设置第三方平台业务域名

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

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

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

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

请求地址

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

请求参数说明

参数 类型 必填 说明
access_token string 第三方平台令牌 component_access_token
action string 操作类型。可选值请看下文
is_modify_published_together bool 是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。
wxa_jump_h5_domain string 最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。

action 可选值

可选值 说明
add 添加
delete 删除 ,删除不存在的域名,不会报错,返回码是0。
set 覆盖
get 获取 ,action=get时,会同时返回测试版和全网发布版的“小程序业务域名”值。

POST 数据示例 1:

{
  "action": "get"
}

POST 数据示例 2:

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

POST 数据示例 3:

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

POST 数据示例 4:

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

返回参数说明

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

返回结果示例:

{
  "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"
}

返回码说明

返回码 说明
-1 系统繁忙
61028 调接口时 "is_modify_published_together" = true,但是没有已发布的第三方
65316 域名个数超出200个的限制
9410016 存在无效域名。具体原因见errmsg(可能有多种原因)。
40052 action值有误
其他错误码 请查看全局错误码