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

    • # 配置小程序服务器域名

    调试诊断

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

    接口英文名：modifyServerDomain

    • 授权给第三方的小程序，其服务器域名只可以为在第三方平台账号中配置的小程序服务器域名，当小程序通过第三方平台发布代码上线后，小程序原先自己配置的服务器域名将被删除，只保留第三方平台的域名，所以第三方平台在代替小程序发布代码之前，需要调用接口为小程序添加第三方平台自身的域名。
    • 使用过程中如遇到问题，可在开放平台服务商专区发帖交流

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxa/modify_domain?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：18

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    actionstring是操作类型
    requestdomainarray是request 合法域名；当 action 是 get 时不需要此字段
    wsrequestdomainarray是socket 合法域名；当 action 是 get 时不需要此字段
    uploaddomainarray是uploadFile 合法域名；当 action 是 get 时不需要此字段
    downloaddomainarray是downloadFile 合法域名；当 action 是 get 时不需要此字段
    udpdomainarray是udp 合法域名；当 action 是 get 时不需要此字段
    tcpdomainarray是tcp 合法域名；当 action 是 get 时不需要此字段

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber返回码
    errmsgstring错误信息
    requestdomainarrayrequest 合法域名
    wsrequestdomainarraysocket 合法域名
    uploaddomainarrayuploadFile 合法域名
    downloaddomainarraydownloadFile 合法域名
    udpdomainarrayudp 合法域名
    tcpdomainarraytcp 合法域名
    invalid_requestdomainarrayrequest 不合法域名
    invalid_wsrequestdomainarraysocket 不合法域名
    invalid_uploaddomainarrayuploadFile 不合法域名
    invalid_downloaddomainarraydownloadFile 不合法域名
    invalid_udpdomainarrayudp 不合法域名
    invalid_tcpdomainarraytcp 不合法域名
    no_icp_domainarray没有经过icp备案的域名

    # 4. 注意事项

    • 需要先将域名登记到第三方平台的小程序服务器域名中，才可以调用接口进行配置。
    • Request域名、Socket域名、Uploadfile域名、Download域名、Udp域名、tcp的设置数量均最大支持200个
    • 每月可提交修改申请50次
    • 代调用接口为小程序配置服务器域名时可以配置端口，如 https://myserver.com:8080，但是配置后只能向 https://myserver.com:8080 发起请求。如果向 https://myserver.com、https://myserver.com:9091 等 URL 请求则会失败。
    • 域名必须经过 ICP 备案
    • 不支持填写ip地址，要用域名
    • api.weixin.qq.com 不能被配置为服务器域名
    • 注意传参时action值，add添加，set是覆盖，不要弄混导致覆盖之前已配置成功的域名

    # 其他说明

    # action 操作类型可选值

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

    # 5. 代码示例

    请求示例

    {
  "action": "add",
  "requestdomain": [
    "https://www.qq.com",
    "https://www.qq.com"
  ],
  "wsrequestdomain": [
    "wss://www.qq.com",
    "wss://www.qq.com"
  ],
  "uploaddomain": [
    "https://www.qq.com",
    "https://www.qq.com"
  ],
  "downloaddomain": [
    "https://www.qq.com",
    "https://www.qq.com"
  ],
  "udpdomain": [
    "udp://melody.weixin.melody.com"
  ],
  "tcpdomain": [
    "tcp://melody.weixin.melody.com"
  ]
}

    返回示例

    "errcode": 85303,
    "errmsg": "no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains. Besides, please confirm all domains have ICP licenses",
    "requestdomain": [],
    "wsrequestdomain": [],
    "uploaddomain": [],
    "downloaddomain": [],
    "udpdomain": [],
    "tcpdomain": [],
    "invalid_requestdomain": [],
    "invalid_wsrequestdomain": [
        "wss://melody.weixin.melody44.com"
    ],
    "invalid_uploaddomain": [
        "https://melody.weixin.melody33.com"
    ],
    "invalid_downloaddomain": [],
    "invalid_udpdomain": [
        "udp://melody.weixin.melody22.com"
    ],
    "invalid_tcpdomain": [
        "tcp://melody.weixin.melody22.com"
    ],
    "no_icp_domain": [
        "https://melody.weixin.melody.com:443"
    ]

    # 6. 错误码

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

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40014invalid access_token不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
    85015该账号不是小程序账号该账号不是小程序账号
    85017no domain to modify after filtered please confirm the domain has been set in miniprogram or open域名输入为空，或者没有新增域名，请确认小程序已经添加了域名或该域名是否没有在第三方平台添加
    85018域名没有在第三方平台设置
    85301no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains；存在 “不符合域名规则的域名”导致无修改。
    85302o domain to modify after filtered, please confirm all domains have ICP licenses；存在 “ 缺少ICP备案的域名”导致无修改
    85303no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains. Besides, please confirm all domains have ICP licenses；同时存在“不符合域名规则的域名”以及“ 缺少ICP备案的域名”导致无修改。

    # 7. 适用范围

    本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。