livebroadcast

package
v3.6.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 23, 2023 License: Apache-2.0 Imports: 1 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddAssistantRequest 

type AddAssistantRequest struct {
	// 必填	房间ID
	RoomId int64 `json:"roomId"`
	// 必填	用户数组
	Users []*Assistant `json:"users"`
}

type AddGoodsRequest 

type AddGoodsRequest struct {
	// 必填	数组列表，可传入多个，里面填写 商品 ID
	Ids []int64 `json:"ids"`
	// 必填	房间ID
	RoomId int64 `json:"roomId"`
}

type AddRoleRequest 

type AddRoleRequest struct {
	// 必填	设置用户的角色
	// 取值[1-管理员，2-主播，3-运营者]，设置超级管理员将无效
	Role Role `json:"role"`
	// 必填	用户昵称
	Nickname string `json:"nickname"`
}

type AddSubAnchorRequest 

type AddSubAnchorRequest struct {
	// 必填	房间ID
	RoomId int64 `json:"roomId"`
	// 必填	用户微信号
	Username string `json:"username"`
}

type Assistant 

type Assistant struct {
	// 必填	用户微信号
	Username string `json:"username"`
	// 必填	用户昵称
	Nickname string `json:"nickname"`
}

type CreateRoomRequest 

type CreateRoomRequest struct {
	// 必填 直播间名字，最短3个汉字，最长17个汉字，1个汉字相当于2个字符
	Name string `json:"name"`
	// 必填 背景图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播间背景图，图片规则：建议像素1080*1920，大小不超过2M
	CoverImg string `json:"coverImg"`
	// 必填 直播计划开始时间（开播时间需要在当前时间的10分钟后 并且 开始时间不能在 6 个月后）
	StartTime int64 `json:"startTime"`
	// 必填 直播计划结束时间（开播时间和结束时间间隔不得短于30分钟，不得超过24小时）
	EndTime int64 `json:"endTime"`
	// 必填 主播昵称，最短2个汉字，最长15个汉字，1个汉字相当于2个字符
	AnchorName string `json:"anchorName"`
	// 必填 主播微信号，如果未实名认证，需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接：https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh
	AnchorWechat string `json:"anchorWechat"`
	// 非必填 主播副号微信号，如果未实名认证，需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接：https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh
	SubAnchorWechat string `json:"subAnchorWechat"`
	// 非必填 创建者微信号，不传入则此直播间所有成员可见。传入则此房间仅创建者、管理员、超管、直播间主播可见
	CreaterWechat string `json:"createrWechat"`
	// 必填 分享图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播间分享图，图片规则：建议像素800*640，大小不超过1M；
	ShareImg string `json:"shareImg"`
	// 必填 购物直播频道封面图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 购物直播频道封面图，图片规则：建议像素800*800，大小不超过100KB；
	FeedsImg string `json:"feedsImg"`
	// 非必填 是否开启官方收录 【1: 开启，0：关闭】，默认开启收录
	IsFeedsPublic uint8 `json:"isFeedsPublic"`
	// 必填 直播间类型 【1: 推流，0：手机直播】
	Type uint8 `json:"type"`
	// 必填 是否关闭点赞 【0：开启，1：关闭】（若关闭，观众端将隐藏点赞按钮，直播开始后不允许开启）
	CloseLike uint8 `json:"closeLike"`
	// 必填 是否关闭货架 【0：开启，1：关闭】（若关闭，观众端将隐藏商品货架，直播开始后不允许开启）
	CloseGoods uint8 `json:"closeGoods"`
	// 必填 是否关闭评论 【0：开启，1：关闭】（若关闭，观众端将隐藏评论入口，直播开始后不允许开启）
	CloseComment uint8 `json:"closeComment"`
	// 非必填 是否关闭回放 【0：开启，1：关闭】默认关闭回放（直播开始后允许开启）
	CloseReplay uint8 `json:"closeReplay"`
	// 非必填 是否关闭分享 【0：开启，1：关闭】默认开启分享（直播开始后不允许修改）
	CloseShare uint8 `json:"closeShare"`
	// 非必填 是否关闭客服 【0：开启，1：关闭】 默认关闭客服（直播开始后允许开启）
	CloseKf uint8 `json:"closeKf"`
}

type CreateRoomResponse 

type CreateRoomResponse struct {
	request.CommonError
	// 当主播微信号没有在 “小程序直播“ 小程序实名认证 返回该字段
	// "小程序直播" 小程序码
	QRCodeURL string `json:"qrcode_url"`
	//	房间ID
	RoomId int64 `json:"roomId"`
}

type DeleteRoleRequest 

type DeleteRoleRequest struct {
	// 必填	设置用户的角色
	// 取值[1-管理员，2-主播，3-运营者]，设置超级管理员将无效
	Role Role `json:"role"`
	// 必填	用户昵称
	Nickname string `json:"nickname"`
}

type DeleteRoomRequest 

type DeleteRoomRequest struct {
	//	房间ID
	Id int64 `json:"id"`
}

type DeleteSubAnchorRequest 

type DeleteSubAnchorRequest struct {
	// 必填	房间ID
	RoomId int64 `json:"roomId"`
}

type EditRoomRequest 

type EditRoomRequest struct {
	Id int64 `json:"id"` // 必填	直播间id
	// 必填 直播间名字，最短3个汉字，最长17个汉字，1个汉字相当于2个字符
	Name string `json:"name"`
	// 必填 背景图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播间背景图，图片规则：建议像素1080*1920，大小不超过2M
	CoverImg string `json:"coverImg"`
	// 必填 直播计划开始时间（开播时间需要在当前时间的10分钟后 并且 开始时间不能在 6 个月后）
	StartTime int64 `json:"startTime"`
	// 必填 直播计划结束时间（开播时间和结束时间间隔不得短于30分钟，不得超过24小时）
	EndTime int64 `json:"endTime"`
	// 必填 主播昵称，最短2个汉字，最长15个汉字，1个汉字相当于2个字符
	AnchorName string `json:"anchorName"`
	// 必填 主播微信号，如果未实名认证，需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接：https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh
	AnchorWechat string `json:"anchorWechat"`
	// 必填 分享图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；直播间分享图，图片规则：建议像素800*640，大小不超过1M；
	ShareImg string `json:"shareImg"`
	// 必填 购物直播频道封面图，填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html; 购物直播频道封面图，图片规则：建议像素800*800，大小不超过100KB；
	FeedsImg string `json:"feedsImg"`
	// 非必填 是否开启官方收录 【1: 开启，0：关闭】，默认开启收录
	IsFeedsPublic uint8 `json:"isFeedsPublic"`
	// 必填 是否关闭点赞 【0：开启，1：关闭】（若关闭，观众端将隐藏点赞按钮，直播开始后不允许开启）
	CloseLike uint8 `json:"closeLike"`
	// 必填 是否关闭货架 【0：开启，1：关闭】（若关闭，观众端将隐藏商品货架，直播开始后不允许开启）
	CloseGoods uint8 `json:"closeGoods"`
	// 必填 是否关闭评论 【0：开启，1：关闭】（若关闭，观众端将隐藏评论入口，直播开始后不允许开启）
	CloseComment uint8 `json:"closeComment"`
	// 非必填 是否关闭回放 【0：开启，1：关闭】默认关闭回放（直播开始后允许开启）
	CloseReplay uint8 `json:"closeReplay"`
	// 非必填 是否关闭分享 【0：开启，1：关闭】默认开启分享（直播开始后不允许修改）
	CloseShare uint8 `json:"closeShare"`
	// 非必填 是否关闭客服 【0：开启，1：关闭】 默认关闭客服（直播开始后允许开启）
	CloseKf uint8 `json:"closeKf"`
}

type GetAssistantListRequest 

type GetAssistantListRequest struct {
	// 必填	直播间id
	RoomId int64 `query:"roomId"`
}

type GetAssistantListResponse 

type GetAssistantListResponse struct {
	request.CommonError
	// 小助手列表
	List []struct {
		// 修改时间// 修改时间
		Timestamp int `json:"timestamp"`
		// 头像// 头像
		Headimg string `json:"headimg"`
		// 昵称// 昵称
		Nickname string `json:"nickname"`
		// 微信号// 微信号
		Alias string `json:"alias"`
		// openid// openid
		Openid string `json:"openid"`
	} `json:"list"`
	// 小助手个数// 小助手个数
	Count int `json:"count"`
	// 小助手最大个数// 小助手最大个数
	MaxCount int `json:"maxCount"`
}

type GetFollowersRequest 

type GetFollowersRequest struct {
	Limit     int `json:"limit"`      // 非必填	获取长期订阅用户的个数限制，默认200，最大2000
	PageBreak int `json:"page_break"` // 非必填	翻页标记，获取第一页时不带，第二页开始需带上上一页返回结果中的page_break
}

type GetFollowersResponse 

type GetFollowersResponse struct {
	request.CommonError
	Followers []struct {
		SubscribeTime int    `json:"subscribe_time"` // 长期订阅用户订阅时间
		RoomId        int    `json:"room_id"`        // 用户订阅时所处房间
		RoomStatus    int    `json:"room_status"`    // 用户订阅时房间状态
		Openid        string `json:"openid"`         // 长期订阅用户OpenId
	} `json:"followers"` //	长期订阅用户列表
	PageBreak int `json:"page_break"` // 翻页标记，获取下一页时带上该值
}

type GetLiveInfoRequest added in v3.2.1 

type GetLiveInfoRequest struct {
	// 必填 起始房间，0表示从第1个房间开始拉取
	Start int `json:"start"`
	// 必填 每次拉取的房间数量，建议100以内
	Limit int `json:"limit"`
}

type GetLiveInfoResponse added in v3.2.1 

type GetLiveInfoResponse struct {
	request.CommonError
	// 拉取房间总数
	Total int         `json:"total"`
	List  []*RoomInfo `json:"room_info"`
}

type GetPushUrlRequest added in v3.2.1 

type GetPushUrlRequest struct {
	// 必填	直播间id
	RoomId int64 `query:"roomId"`
}

type GetPushUrlResponse added in v3.2.1 

type GetPushUrlResponse struct {
	request.CommonError
	// 直播间推流地址
	PushAddr string `json:"pushAddr"`
}

type GetRoleListRequest added in v3.2.1 

type GetRoleListRequest struct {
	// 非必填	查询的用户角色，取值 [-1-所有成员， 0-超级管理员，1-管理员，2-主播，3-运营者]，默认-1
	Role Role `query:"role"`
	// 非必填	起始偏移量, 默认0
	Offset int `query:"offset"`
	// 非必填	查询个数，最大30，默认10
	Limit int `query:"limit"`
	// 非必填	搜索的微信号或昵称，不传则返回全部
	Keyword string `query:"keyword"`
}

type GetRoleListResponse added in v3.2.1 

type GetRoleListResponse struct {
	request.CommonError
	// 角色列表
	List []struct {
		// 微信用户头像url
		Headingimg string `json:"headingimg"`
		// 微信用户昵称
		Nickname string `json:"nickname"`
		// 微信openid
		Openid string `json:"openid"`
		// 具有的身份，[0-超级管理员，1-管理员，2-主播，3-运营者]
		RoleList []Role `json:"roleList"`
		// 更新时间戳
		UpdateTimestamp string `json:"updateTimestamp"`
		// 脱敏微信号
		Username string `json:"username"`
	} `json:"list"`
}

type GetSharedCodeRequest added in v3.4.0 

type GetSharedCodeRequest struct {
	//	房间ID
	RoomId int64 `query:"roomId"`
	// 自定义参数
	Params int64 `query:"params"`
}

type GetSharedCodeResponse added in v3.4.0 

type GetSharedCodeResponse struct {
	request.CommonError
	// 分享二维码地址
	CdnUrl string `json:"cdnUrl"`
	// 分享路径
	PagePath string `json:"pagePath"`
	// 分享海报地址
	PosterUrl string `json:"posterUrl"`
}

type GetSubAnchorRequest added in v3.4.0 

type GetSubAnchorRequest struct {
	//	房间ID
	RoomId int64 `query:"roomId"`
}

type GetSubAnchorResponse added in v3.4.0 

type GetSubAnchorResponse struct {
	request.CommonError
	Username string `json:"username"`
}

type GoodsAddInfo added in v3.5.0 

type GoodsAddInfo struct {
	// 必填 填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；图片规则：图片尺寸最大300像素*300像素；
	CoverImgUrl string `json:"coverImgUrl"`
	// 必填 商品名称，最长14个汉字，1个汉字相当于2个字符
	Name string `json:"name"`
	// 必填 价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必填） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必填）
	PriceType PriceType `json:"priceType"`
	// 必填 数字，最多保留两位小数，单位元
	Price float64 `json:"price"`
	// 非必填	数字，最多保留两位小数，单位元
	Price2 float64 `json:"price2"`
	// 必填 商品详情页的小程序路径，路径参数存在 url 的，该参数的值需要进行 encode 处理再填入
	Url string `json:"url"`
	// 非必填	当商品为第三方小程序的商品则填写为对应第三方小程序的appid，自身小程序商品则为”
	ThirdPartyAppid string `json:"thirdPartyAppid"`
}

type GoodsAddRequest added in v3.4.0 

type GoodsAddRequest struct {
	//	商品信息
	GoodsInfo *GoodsAddInfo `json:"goodsInfo"`
}

type GoodsAddResponse added in v3.4.0 

type GoodsAddResponse struct {
	request.CommonError
	// 商品ID
	GoodsId int64 `json:"goodsId"`
	// 审核单ID
	AuditId int64 `json:"auditId"`
}

type GoodsAuditRequest added in v3.5.0 

type GoodsAuditRequest struct {
	// 商品ID
	GoodsId int64 `json:"goodsId"`
}

type GoodsAuditResponse added in v3.5.0 

type GoodsAuditResponse struct {
	request.CommonError
	// 审核单ID
	AuditId int64 `json:"auditId"`
}

type GoodsDeleteRequest added in v3.5.0 

type GoodsDeleteRequest struct {
	// 商品ID
	GoodsId int64 `json:"goodsId"`
}

type GoodsDeleteResponse added in v3.5.0 

type GoodsDeleteResponse struct {
	request.CommonError
}

type GoodsInfoRequest added in v3.5.0 

type GoodsInfoRequest struct {
	// 商品ID
	GoodsIds []int64 `json:"goods_ids"`
}

type GoodsInfoResponse added in v3.5.0 

type GoodsInfoResponse struct {
	request.CommonError
	// 商品个数
	Total int64 `json:"total"`

	// 商品
	Goods []struct {
		// 商品ID
		GoodsId int64 `json:"goods_id"`
		// 商品名称
		Name string `json:"name"`
		// 商品图片url
		CoverImgUrl string `json:"cover_img_url"`
		// 商品详情页的小程序路径
		Url string `json:"url"`
		// 1:一口价，此时读price字段; 2:价格区间，此时price字段为左边界，price2字段为右边界; 3:折扣价，此时price字段为原价，price2字段为现价；
		PriceType uint8 `json:"priceType"`
		// 价格左区间，单位“元”
		Price float64 `json:"price"`
		// 价格右区间，单位“元”
		Price2 float64 `json:"price2"`
		// 0：未审核，1：审核中，2:审核通过，3审核失败
		AuditStatus uint8 `json:"audit_status"`
		// 1、2：表示是为 API 添加商品，否则是直播控制台添加的商品
		ThirdPartyTag uint8 `json:"third_party_tag"`
		// 当商品为第三方小程序的商品则为对应第三方小程序的appid，自身小程序商品则为”
		ThirdPartyAppid string `json:"thirdPartyAppid"`
	} `json:"goods"`
}

type GoodsListRequest added in v3.5.0 

type GoodsListRequest struct {
	// 必填	分页条数起点
	Offset int `query:"offset"`
	// 非必填 分页大小，默认30，不超过100
	Limit int `query:"limit"`
	// 必填	商品状态，0：未审核。1：审核中，2：审核通过，3：审核驳回
	Status uint8 `query:"status"`
}

type GoodsListResponse added in v3.5.0 

type GoodsListResponse struct {
	request.CommonError
	// 商品个数
	Total int64 `json:"total"`
	// 商品
	Goods []struct {
		// 商品ID
		GoodsId int64 `json:"goodsId"`
		// 商品图片url
		CoverImgUrl string `json:"coverImgUrl"`
		// 商品名称
		Name string `json:"name"`
		// 价格左区间，单位“元”
		Price float64 `json:"price"`
		// 价格右区间，单位“元”
		Price2 float64 `json:"price2"`
		// 商品详情页的小程序路径
		Url string `json:"url"`
		// 1:一口价，此时读price字段; 2:价格区间，此时price字段为左边界，price2字段为右边界; 3:折扣价，此时price字段为原价，price2字段为现价；
		PriceType uint8 `json:"priceType"`
		// 1、2：表示是为 API 添加商品，否则是直播控制台添加的商品
		ThirdPartyTag uint8 `json:"thirdPartyTag"`
		// 当商品为第三方小程序的商品则为对应第三方小程序的appid，自身小程序商品	则为”
		ThirdPartyAppid string `json:"thirdPartyAppid"`
	} `json:"goods"`
}

type GoodsPushRequest added in v3.5.0 

type GoodsPushRequest struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
}

type GoodsPushResponse added in v3.5.0 

type GoodsPushResponse struct {
	request.CommonError
}

type GoodsResetAuditRequest added in v3.5.0 

type GoodsResetAuditRequest struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
	// 必填 审核单ID
	AuditId int64 `json:"auditId"`
}

type GoodsResetAuditResponse added in v3.5.0 

type GoodsResetAuditResponse struct {
	request.CommonError
}

type GoodsSaleRequest added in v3.5.0 

type GoodsSaleRequest struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
	// 必填 审核单ID
	AuditId int64 `json:"auditId"`
	// 必填 上下架 【0：下架，1：上架】
	OnSale uint8 `json:"onSale"`
}

type GoodsSaleResponse added in v3.5.0 

type GoodsSaleResponse struct {
	request.CommonError
}

type GoodsSortRequest added in v3.5.0 

type GoodsSortRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`

	// 必填 房间ID
	Goods []*SortGoods `json:"goods"`
}

type GoodsSortResponse added in v3.5.0 

type GoodsSortResponse struct {
	request.CommonError
}

type GoodsUpdateInfo added in v3.5.0 

type GoodsUpdateInfo struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
	// 必填 填入mediaID（mediaID获取后，三天内有效）；图片mediaID的获取，请参考以下文档： https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html；图片规则：图片尺寸最大300像素*300像素；
	CoverImgUrl string `json:"coverImgUrl"`
	// 必填 商品名称，最长14个汉字，1个汉字相当于2个字符
	Name string `json:"name"`
	// 必填 价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必填） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必填）
	PriceType PriceType `json:"priceType"`
	// 必填 数字，最多保留两位小数，单位元
	Price float64 `json:"price"`
	// 非必填	数字，最多保留两位小数，单位元
	Price2 float64 `json:"price2"`
	// 必填 商品详情页的小程序路径，路径参数存在 url 的，该参数的值需要进行 encode 处理再填入
	Url string `json:"url"`
	// 非必填	当商品为第三方小程序的商品则填写为对应第三方小程序的appid，自身小程序商品则为”
	ThirdPartyAppid string `json:"thirdPartyAppid"`
}

type GoodsUpdateRequest added in v3.5.0 

type GoodsUpdateRequest struct {
	//	商品信息
	GoodsInfo *GoodsUpdateInfo `json:"goodsInfo"`
}

type GoodsUpdateResponse added in v3.5.0 

type GoodsUpdateResponse struct {
	request.CommonError
}

type GoodsVideoRequest added in v3.5.0 

type GoodsVideoRequest struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
}

type GoodsVideoResponse added in v3.5.0 

type GoodsVideoResponse struct {
	request.CommonError
	// 必填 讲解链接
	Url int64 `json:"url"`
}

type LiveBroadcast 

type LiveBroadcast struct {
	// contains filtered or unexported fields
}

func NewLiveBroadcast 

func NewLiveBroadcast(request *request.Request, conbineURI func(url string, req interface{}, withToken bool) (string, error)) *LiveBroadcast

func (*LiveBroadcast) AddAssistant 

func (cli *LiveBroadcast) AddAssistant(req *AddAssistantRequest) (*request.CommonError, error)

添加管理直播间小助手

func (*LiveBroadcast) AddGoods 

func (cli *LiveBroadcast) AddGoods(req *AddGoodsRequest) (*request.CommonError, error)

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

func (*LiveBroadcast) AddRole 

func (cli *LiveBroadcast) AddRole(req *AddRoleRequest) (*request.CommonError, error)

调用此接口设置小程序直播成员的管理员、运营者和主播角色

func (*LiveBroadcast) AddSubAnchor 

func (cli *LiveBroadcast) AddSubAnchor(req *AddSubAnchorRequest) (*request.CommonError, error)

添加主播副号

func (*LiveBroadcast) CreateRoom 

func (cli *LiveBroadcast) CreateRoom(req *CreateRoomRequest) (*CreateRoomResponse, error)

创建直播间

func (*LiveBroadcast) DeleteRole 

func (cli *LiveBroadcast) DeleteRole(req *DeleteRoleRequest) (*request.CommonError, error)

解除成员角色

func (*LiveBroadcast) DeleteRoom 

func (cli *LiveBroadcast) DeleteRoom(req *DeleteRoomRequest) (*request.CommonError, error)

删除直播间

func (*LiveBroadcast) DeleteSubAnchor 

func (cli *LiveBroadcast) DeleteSubAnchor(req *DeleteSubAnchorRequest) (*request.CommonError, error)

删除主播副号

func (*LiveBroadcast) EditRoom 

func (cli *LiveBroadcast) EditRoom(req *EditRoomRequest) (*request.CommonError, error)

编辑直播间

func (*LiveBroadcast) GetAssistantList 

func (cli *LiveBroadcast) GetAssistantList(req *GetAssistantListRequest) (*GetAssistantListResponse, error)

查询管理直播间小助手

func (*LiveBroadcast) GetFollowers 

func (cli *LiveBroadcast) GetFollowers(req *GetFollowersRequest) (*GetFollowersResponse, error)

获取长期订阅用户

func (*LiveBroadcast) GetLiveInfo added in v3.2.1 

func (cli *LiveBroadcast) GetLiveInfo(req *GetLiveInfoRequest) (*GetLiveInfoResponse, error)

获取直播间列表及直播间信息

func (*LiveBroadcast) GetPushUrl added in v3.2.1 

func (cli *LiveBroadcast) GetPushUrl(req *GetPushUrlRequest) (*GetPushUrlResponse, error)

获取直播间推流地址

func (*LiveBroadcast) GetRoleList added in v3.2.1 

func (cli *LiveBroadcast) GetRoleList(req *GetRoleListRequest) (*GetRoleListResponse, error)

查询小程序直播成员列表

func (*LiveBroadcast) GetSharedCode added in v3.4.0 

func (cli *LiveBroadcast) GetSharedCode(req *GetSharedCodeRequest) (*GetSharedCodeResponse, error)

获取直播间分享二维码

func (*LiveBroadcast) GetSubAnchor added in v3.4.0 

func (cli *LiveBroadcast) GetSubAnchor(req *GetSubAnchorRequest) (*GetSubAnchorResponse, error)

获取主播副号

func (*LiveBroadcast) GoodsAdd added in v3.4.0 

func (cli *LiveBroadcast) GoodsAdd(req *GoodsAddRequest) (*GoodsAddResponse, error)

商品添加并提审

func (*LiveBroadcast) GoodsAudit added in v3.5.0 

func (cli *LiveBroadcast) GoodsAudit(req *GoodsAuditRequest) (*GoodsAuditResponse, error)

重新提交审核

func (*LiveBroadcast) GoodsDelete added in v3.5.0 

func (cli *LiveBroadcast) GoodsDelete(req *GoodsDeleteRequest) (*GoodsDeleteResponse, error)

删除商品

func (*LiveBroadcast) GoodsInfo added in v3.5.0 

func (cli *LiveBroadcast) GoodsInfo(req *GoodsInfoRequest) (*GoodsInfoResponse, error)

获取商品状态

func (*LiveBroadcast) GoodsList added in v3.5.0 

func (cli *LiveBroadcast) GoodsList(req *GoodsListRequest) (*GoodsListResponse, error)

获取商品列表

func (*LiveBroadcast) GoodsPush added in v3.5.0 

func (cli *LiveBroadcast) GoodsPush(req *GoodsPushRequest) (*GoodsPushResponse, error)

推送商品

func (*LiveBroadcast) GoodsResetAudit added in v3.5.0 

func (cli *LiveBroadcast) GoodsResetAudit(req *GoodsResetAuditRequest) (*GoodsResetAuditResponse, error)

撤回商品审核

func (*LiveBroadcast) GoodsSale added in v3.5.0 

func (cli *LiveBroadcast) GoodsSale(req *GoodsSaleRequest) (*GoodsSaleResponse, error)

上下架商品

func (*LiveBroadcast) GoodsSort added in v3.5.0 

func (cli *LiveBroadcast) GoodsSort(req *GoodsSortRequest) (*GoodsSortResponse, error)

直播间商品排序

func (*LiveBroadcast) GoodsUpdate added in v3.5.0 

func (cli *LiveBroadcast) GoodsUpdate(req *GoodsUpdateRequest) (*GoodsUpdateResponse, error)

更新商品

func (*LiveBroadcast) GoodsVideo added in v3.5.0 

func (cli *LiveBroadcast) GoodsVideo(req *GoodsVideoRequest) (*GoodsVideoResponse, error)

更新商品

func (*LiveBroadcast) ModifyAssistant added in v3.5.0 

func (cli *LiveBroadcast) ModifyAssistant(req *ModifyAssistantRequest) (*ModifyAssistantResponse, error)

修改管理直播间小助手

func (*LiveBroadcast) ModifySubAnchor added in v3.5.0 

func (cli *LiveBroadcast) ModifySubAnchor(req *ModifySubAnchorRequest) (*ModifySubAnchorResponse, error)

修改主播副号

func (*LiveBroadcast) PushMessage added in v3.5.0 

func (cli *LiveBroadcast) PushMessage(req *PushMessageRequest) (*PushMessageResponse, error)

向长期订阅用户群发直播间开始事件

func (*LiveBroadcast) RemoveAssistant added in v3.5.0 

func (cli *LiveBroadcast) RemoveAssistant(req *RemoveAssistantRequest) (*RemoveAssistantResponse, error)

删除管理直播间小助手

func (*LiveBroadcast) UpdateComment added in v3.5.0 

func (cli *LiveBroadcast) UpdateComment(req *UpdateCommentRequest) (*UpdateCommentResponse, error)

开启/关闭直播间全局禁言

func (*LiveBroadcast) UpdateFeedPublic added in v3.5.0 

func (cli *LiveBroadcast) UpdateFeedPublic(req *UpdateFeedPublicRequest) (*UpdateFeedPublicResponse, error)

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

func (*LiveBroadcast) UpdateKF added in v3.5.0 

func (cli *LiveBroadcast) UpdateKF(req *UpdateKFRequest) (*UpdateKFResponse, error)

开启/关闭客服功能

func (*LiveBroadcast) UpdateReplay added in v3.5.0 

func (cli *LiveBroadcast) UpdateReplay(req *UpdateReplayRequest) (*UpdateReplayResponse, error)

开开启/关闭回放功能

type LiveRoomGoods added in v3.2.1 

type LiveRoomGoods struct {
	// 商品封面图链接
	CoverIMG string `json:"cover_img"`
	// 商品小程序路径
	URL string `json:"url"`
	// 商品名称
	Name string `json:"name"`
	// 商品价格（分）
	Price int64 `json:"price"`
	// 商品价格（参考价格类型）
	Price2 int64 `json:"price2"`
	// 价格类型，1：一口价（只需要传入price，price2不传） 2：价格区间（price字段为左边界，price2字段为右边界，price和price2必填） 3：显示折扣价（price字段为原价，price2字段为现价， price和price2必填）
	Price_type PriceType `json:"price_type"`
	// 商品id
	GoodsID int `json:"goods_id"`
	//第三方商品appid ,当前小程序商品则为空
	ThirdPartyAppID string `json:"third_party_appid"`
}

type LiveStatus added in v3.2.1 

type LiveStatus uint8

直播间状态 

const (
	LiveStatusLiving    LiveStatus // 直播中
	LiveStatusNotStated            // 未开始
	LiveStatusFinished             // 已结束
	LiveStatusBan                  // 禁播
	LiveStatusPause                // 暂停
	LiveStatusException            // 异常
	LiveStatusExpired              // 已过期
)

type LiveType added in v3.2.1 

type LiveType uint8
const (
	// 手机直播
	LiveTypePhone LiveType = iota
	// 推流
	LiveTypePushFlow
)

type ModifyAssistantRequest added in v3.5.0 

type ModifyAssistantRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	用户微信号
	Username string `json:"username"`
	// 必填	用户微信昵称
	Nickname string `json:"nickname"`
}

type ModifyAssistantResponse added in v3.5.0 

type ModifyAssistantResponse struct {
	request.CommonError
}

type ModifySubAnchorRequest added in v3.5.0 

type ModifySubAnchorRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	用户微信号
	Username string `json:"username"`
}

type ModifySubAnchorResponse added in v3.5.0 

type ModifySubAnchorResponse struct {
	request.CommonError
}

type PriceType added in v3.2.1 

type PriceType uint8
const (
	PriceTypeNormal   PriceType // 一口价
	PriceTypeRange              // 区间价格
	PriceTypeDiscount           // 折扣价格
)

type PushMessageRequest added in v3.5.0 

type PushMessageRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"room_id"`
	// 必填	接收该群发开播事件的订阅用户OpenId列表
	UserOpenid []string `json:"user_openid"`
}

type PushMessageResponse added in v3.5.0 

type PushMessageResponse struct {
	request.CommonError
	// 此次群发消息的标识ID，用于对应【长期订阅群发结果回调】的message_id
	MessageId string `json:"message_id"`
}

type RemoveAssistantRequest added in v3.5.0 

type RemoveAssistantRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"room_id"`
	// 必填	用户微信号
	Username string `json:"username"`
}

type RemoveAssistantResponse added in v3.5.0 

type RemoveAssistantResponse struct {
	request.CommonError
}

type Role 

type Role = int8
const (
	RoleALl Role = iota - 1
	// 超级管理员
	RoleRoot
	// 管理员
	RoleAdministrator
	// 主播
	RoleBroadcaster
	// 运营者
	RoleOperator
)

type RoomInfo added in v3.2.1 

type RoomInfo struct {
	// 直播间名称
	Name string `json:"name"`
	// 直播间ID
	RoomID int `json:"roomid"`
	// 直播间背景图链接
	CoverIMG string `json:"cover_img"`
	// 直播间分享图链接
	ShareIMG string `json:"share_img"`
	// 直播间状态
	LiveStatus LiveStatus `json:"live_status"`
	// 直播间开始时间
	StartTime int `json:"start_time"`
	// 直播计划结束时间
	EndTime int `json:"end_time"`
	// 主播名
	AnchorName string           `json:"anchor_name"`
	Goods      []*LiveRoomGoods `json:"goods"`
	// 直播类型
	LiveType LiveType `json:"live_type"`
	// 是否关闭点赞
	CloseLike int `json:"close_like"`
	// 是否关闭货架
	CloseGoods int `json:"close_goods"`
	// 是否关闭评论
	CloseComment int `json:"close_comment"`
	// 是否关闭客服
	CloseKF int `json:"close_kf"`
	// 是否关闭回放
	CloseReplay int `json:"close_replay"`
	// 是否开启官方收录
	IsFeedsPublic int `json:"is_feeds_public"`
	// 创建者openid
	CreatorOpenID string `json:"creater_openid"`
	// 官方收录封面
	FeedsIMG string `json:"feeds_img"`
}

type SortGoods added in v3.5.0 

type SortGoods struct {
	// 必填 商品ID
	GoodsId int64 `json:"goodsId"`
}

type UpdateCommentRequest added in v3.5.0 

type UpdateCommentRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	1-禁言，0-取消禁言
	BanComment uint8 `json:"banComment"`
}

type UpdateCommentResponse added in v3.5.0 

type UpdateCommentResponse struct {
	request.CommonError
}

type UpdateFeedPublicRequest added in v3.5.0 

type UpdateFeedPublicRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	是否开启官方收录 【1: 开启，0：关闭】
	IsFeedsPublic uint8 `json:"isFeedsPublic"`
}

type UpdateFeedPublicResponse added in v3.5.0 

type UpdateFeedPublicResponse struct {
	request.CommonError
}

type UpdateKFRequest added in v3.5.0 

type UpdateKFRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	是否关闭客服 【0：开启，1：关闭】
	CloseKf uint8 `json:"closeKf"`
}

type UpdateKFResponse added in v3.5.0 

type UpdateKFResponse struct {
	request.CommonError
}

type UpdateReplayRequest added in v3.5.0 

type UpdateReplayRequest struct {
	// 必填 房间ID
	RoomId int64 `json:"roomId"`
	// 必填	是否关闭回放 【0：开启，1：关闭】
	CloseReplay uint8 `json:"closeReplay"`
}

type UpdateReplayResponse added in v3.5.0 

type UpdateReplayResponse struct {
	request.CommonError
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.