WeChat.MiniProgram.Live.Room (wechat v0.6.2)

小程序 - 直播间管理

Link to this section Summary

Types

是否开启禁言 【0:开启,1:关闭】

是否关闭客服 【0:开启,1:关闭】

是否关闭回放 【0:开启,1:关闭】

是否开启官方收录 【1: 开启,0:关闭】

上下架 【0:下架,1:上架】

Functions

添加管理直播间小助手 - 官方文档

查询管理直播间小助手 - 官方文档

获取直播间推流地址 - 官方文档

开启/关闭直播间全局禁言 - 官方文档

Link to this section Types

Link to this type

is_ban_comment()

Specs

is_ban_comment() :: boolean() | 0 | 1

是否开启禁言 【0:开启,1:关闭】

Link to this type

is_close_kf()

Specs

is_close_kf() :: boolean() | 0 | 1

是否关闭客服 【0:开启,1:关闭】

Link to this type

is_close_replay()

Specs

is_close_replay() :: boolean() | 0 | 1

是否关闭回放 【0:开启,1:关闭】

Link to this type

is_feeds_public()

Specs

is_feeds_public() :: boolean() | 0 | 1

是否开启官方收录 【1: 开启,0:关闭】

Link to this type

is_on_sale()

Specs

is_on_sale() :: boolean() | 0 | 1

上下架 【0:下架,1:上架】

Specs

limit() :: 1..100

Specs

room_id() :: integer()

Specs

start() :: integer()

Specs

user() :: %{username: WeChat.User.username(), nickname: WeChat.User.nickname()}

Specs

users() :: [user()]

Link to this section Functions

Link to this function

add_assistant(client, room_id, users)

Specs

add_assistant(WeChat.client(), room_id(), users()) :: WeChat.response()

添加管理直播间小助手 - 官方文档

Link to this function

add_goods(client, room_id, goods_ids)

Specs

直播间导入商品 - 官方文档

调用此接口往指定直播间导入已入库的商品

Link to this function

add_subanchor(client, room_id, username)

Specs

添加主播副号 - 官方文档

Link to this function

create_room(client, data)

Specs

create_room(WeChat.client(), data :: map()) :: WeChat.response()

创建直播间 - 官方文档

该接口可直接创建直播间,创建成功后直播间将在直播间列表展示

Link to this function

delete_room(client, room_id)

Specs

delete_room(WeChat.client(), room_id()) :: WeChat.response()

删除直播间 - 官方文档

Link to this function

delete_subanchor(client, room_id)

Specs

delete_subanchor(WeChat.client(), room_id()) :: WeChat.response()

删除主播副号 - 官方文档

Link to this function

edit_room(client, data)

Specs

edit_room(WeChat.client(), data :: map()) :: WeChat.response()

编辑直播间 - 官方文档

Link to this function

get_assistant_list(client, room_id)

Specs

get_assistant_list(WeChat.client(), room_id()) :: WeChat.response()

查询管理直播间小助手 - 官方文档

Link to this function

get_live_info(client, start \\ 0, limit \\ 10)

Specs

get_live_info(WeChat.client(), start(), limit()) :: WeChat.response()

获取直播房间列表 - 官方文档

该接口可获取直播房间列表

Link to this function

get_push_url(client, room_id)

Specs

get_push_url(WeChat.client(), room_id()) :: WeChat.response()

获取直播间推流地址 - 官方文档

Link to this function

get_replay(client, room_id, start \\ 0, limit \\ 10)

Specs

get_replay(WeChat.client(), room_id(), start(), limit()) :: WeChat.response()

获取直播间回放 - 官方文档

该接口可在直播结束后拿到回放源视频

Link to this function

get_shared_code(client, room_id, params \\ %{})

Specs

get_shared_code(WeChat.client(), room_id(), params :: map()) ::
  WeChat.response()

获取直播间分享二维码 - 官方文档

Link to this function

get_subanchor(client, room_id)

Specs

get_subanchor(WeChat.client(), room_id()) :: WeChat.response()

获取主播副号 - 官方文档

Link to this function

goods_delete(client, room_id, goods_id)

Specs

删除直播间商品 - 官方文档

Link to this function

goods_get_video(client, room_id, goods_id)

Specs

下载商品讲解视频 - 官方文档

Link to this function

goods_onsale(client, room_id, goods_id, is_on_sale)

Specs

上下架直播间商品 - 官方文档

Link to this function

goods_push(client, room_id, goods_id)

Specs

推送商品 - 官方文档

Link to this function

goods_sort(client, room_id, goods_ids)

Specs

直播间商品排序 - 官方文档

Link to this function

modify_assistant(client, room_id, username, nickname)

Specs

修改管理直播间小助手 - 官方文档

Link to this function

modify_subanchor(client, room_id, username)

Specs

修改主播副号 - 官方文档

Link to this function

remove_assistant(client, room_id, username)

Specs

删除管理直播间小助手 - 官方文档

Link to this function

update_comment(client, room_id, is_ban_comment)

Specs

update_comment(WeChat.client(), room_id(), is_ban_comment()) ::
  WeChat.response()

开启/关闭直播间全局禁言 - 官方文档

Link to this function

update_feed_public(client, room_id, is_feeds_public)

Specs

update_feed_public(WeChat.client(), room_id(), is_feeds_public()) ::
  WeChat.response()

开启/关闭直播间官方收录 - 官方文档

Link to this function

update_kf(client, room_id, is_close_kf)

Specs

开启/关闭客服功能 - 官方文档

Link to this function

update_replay(client, room_id, is_close_replay)

Specs

开启/关闭回放功能 - 官方文档