livebroadcast.getSharedCode

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

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

获取直播间分享二维码

说明

小程序直播文档:https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html

对应接口 https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode

云调用使用说明

外链文档中可能只有 HTTP 形式的定义,对云调用方式,调用时参数与 HTTP 需求的参数一致,但是无需传入 access_token,同时所有的参数无论 get/post 都只需作为接口参数 JS 对象中的一个字段传入即可。

而对于 FormData 的请求,如果一个参数的类型是 Buffer,则其字段应传入有如下字段的对象:

属性类型默认值必填说明
contentTypestring数据类型,传入 MIME Type
valueBuffer文件 Buffer

示例

假设外链文档要求是 POST 方法,要求传入如下参数

属性类型位置说明
xxxstringURL 参数
yyynumberJSON body

则调用示例如下:

  1. cloud.openapi.livebroadcast.getSharedCode({
  2. xxx: '字符串',
  3. yyy: 100,
  4. })

假设外链文档要求是 POST FormData,要求传入如下参数

属性类型位置说明
xxxstringURL 参数
mediabufferFormData图片 buffer

则调用示例如下:

  1. cloud.openapi.livebroadcast.getSharedCode({
  2. xxx: '字符串',
  3. media: {
  4. contentType: 'image/png',
  5. value: Buffer
  6. },
  7. })