小程序
取消
开发
中文
EN
取消
  • 指南

    • # 查询域名配置

    调试诊断

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

    接口英文名：getDomainInfo

    该接口用于查询小程序域名配置信息。

    # 1. 调用方式

    # HTTPS 调用

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

    支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    actionstring否查询配置域名的类型, 可选值如下： 1. getbizdomain 返回业务域名 2. getserverdomain 返回服务器域名 3. 不指明返回全部

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    requestdomainarrayrequest合法域名列表
    wsrequestdomainarraysocket合法域名列表
    uploaddomainarrayuploadFile合法域名列表
    downloaddomainarraydownloadFile合法域名列表
    udpdomainarrayudp合法域名列表
    bizdomainarray业务域名列表

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS请求示例

    请求示例

    {
  "action": "getserverdomain"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "requestdomain": [
    "https://www.example.com"
  ],
  "wsrequestdomain": [
    "wss://www.qq.com"
  ],
  "uploaddomain": [],
  "downloaddomain": [
    "https://www.qq.com"
  ],
  "udpdomain": [
    "udp://www.example.com"
  ]
}

    # 5.2 云函数调用示例

    请求示例

    const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.operation.getDomainInfo({
        "action": ''
      })
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.operation.getDomainInfo({
        "errcode": 0,
        "errmsg": 'ok',
        "requestdomain": [
          "https://www.example.com"
        ],
        "wsrequestdomain": [
          "wss://www.qq.com"
        ],
        "uploaddomain": [],
        "downloaddomain": [
          "https://www.qq.com"
        ],
        "udpdomain": [
          "udp://www.example.com"
        ],
        "bizdomain": [
          "https://www.qq.com"
        ]
      })
    return result
  } catch (err) {
    return err
  }
}

    # 6. 错误码

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

    错误码错误描述解决方案
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序小游戏
    ✔ ✔
    • ✔：该账号可调用此接口
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；