# 获取实时语音签名

调试工具

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

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

# 接口说明

# 接口英文名

getCloudBaseVoIPSign

# 功能描述

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

# 调用方式

# HTTPS 调用


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

# 云调用

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

  • 接口方法为: openapi.cloudbase.getVoIPSign

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

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

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token
group_id string 游戏房间的标识
timestamp number 生成这个随机字符串的 UNIX 时间戳(精确到秒)
nonce string 随机字符串,长度应小于 128

# 返回参数

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

# 调用示例

示例说明: 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"
} 

示例说明: 云函数调用示例

# 请求数据示例


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

# 错误码

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