# cloudbase.getVoIPSign

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

获取实时语音签名

调用方式:

# HTTPS 调用

# 请求地址

POST https://api.weixin.qq.com/wxa/getvoipsign?openid=OPENID&access_token=TOKEN

# 请求参数

属性 类型 默认值 必填 说明
openid string 用户唯一标识符
access_token / cloudbase_access_token string 接口调用凭证
group_id string 游戏房间的标识
nonce string 随机字符串,长度应小于 128
timestamp string 生成这个随机字符串的 UNIX 时间戳(精确到秒)

# 返回值

# Object

返回的 JSON 数据包

属性 类型 说明
errcode string 错误码
errmsg string 错误信息
signature string 签名

# 请求数据示例

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

# 返回数据示例

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

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.cloudbase.getVoIPSign

需在 config.json 中配置 cloudbase.getVoIPSign API 的权限,详情

# 请求参数

属性 类型 默认值 必填 说明
openid string 用户唯一标识符
groupId string 游戏房间的标识
nonce string 随机字符串,长度应小于 128
timestamp string 生成这个随机字符串的 UNIX 时间戳(精确到秒)

# 返回值

# Object

返回的 JSON 数据包

属性 类型 说明
errCode string 错误码
errMsg string 错误信息
signature string 签名

# 异常

# Object

抛出的异常

属性 类型 说明
errCode string 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

# 请求数据示例

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