# 获取实时语音签名

调试诊断

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

接口英文名:getCloudBaseVoIPSign

该接口用于获取实时语音签名

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:cloudbase.getVoIPSign

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
group_idstring游戏房间的标识
timestampnumber生成这个随机字符串的 UNIX 时间戳(精确到秒)
noncestring随机字符串,长度应小于 128

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
signaturestring签名

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 HTTPS请求示例

请求示例

// POST https://api.weixin.qq.com/wxa/getvoipsign?openid=OPENID&access_token=TOKEN // url支持指定openid

{ "group_id": "xxx", "nonce": "yyy", "timestamp": 12312312312 }

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "signature": "xxxx"
}

# 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.cloudbase.getVoIPSign({ "nonce": 'yyy', "timestamp": 12312312312, "groupId": 'xxx' }) return result } catch (err) { return err } }

返回示例

{
  "errCode": 0,
  "errMsg": "openapi.cloudbase.getVoIPSign:ok",
  "signature": "xxxx"
}

# 6. 错误码

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

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序公众号服务号小游戏
  • ✔:该账号可调用此接口
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;