me.chanjar.weixin.cp.api

接口 WxCpLivingService

所有已知实现类:

WxCpLivingServiceImpl

public interface WxCpLivingService

企业微信直播接口. 官方文档：https://work.weixin.qq.com/api/doc/90000/90135/93633

作者:

Wang_Wong created on 2021-12-21

方法概要

限定符和类型	方法和说明
WxCpLivingResult	deleteReplayData(@NonNull String livingId) 删除直播回放 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?
String	getLivingCode(@NonNull String openId, @NonNull String livingId) 获取微信观看直播凭证 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/get_living_code?
WxCpLivingInfo	getLivingInfo(@NonNull String livingId) 获取直播详情 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?
WxCpLivingShareInfo	getLivingShareInfo(@NonNull String wwShareCode) 获取跳转小程序商城的直播观众信息 通过此接口，开发者可获取跳转小程序商城的直播间(“推广产品”直播)观众id、邀请人id及对应直播间id，以打通卖货直播的“人货场”信息闭环。
WxCpLivingResult.LivingIdResult	getUserAllLivingId(@NonNull String userId, String cursor, Integer limit) 获取成员直播ID列表 通过此接口可以获取指定成员的所有直播ID 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_user_all_livingid?
WxCpWatchStat	getWatchStat(@NonNull String livingId, String nextKey) 获取直播观看明细 通过该接口可以获取所有观看直播的人员统计 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?
WxCpLivingResult	livingCancel(@NonNull String livingId) 取消预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/cancel?
String	livingCreate(WxCpLivingCreateRequest request) 创建预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/create?
WxCpLivingResult	livingModify(WxCpLivingModifyRequest request) 修改预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/modify?

方法详细资料

getLivingCode

String getLivingCode(@NonNull
                     @NonNull String openId,
                     @NonNull
                     @NonNull String livingId)
              throws WxErrorException

获取微信观看直播凭证 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/get_living_code?access_token=ACCESS_TOKEN

参数:

openId - 用户openid

livingId - 直播id

返回:

living_code 微信观看直播凭证

抛出:

WxErrorException - the wx error exception

getLivingInfo

WxCpLivingInfo getLivingInfo(@NonNull
                             @NonNull String livingId)
                      throws WxErrorException

获取直播详情 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID

参数:

livingId - 直播id

返回:

获取的直播详情 living info

抛出:

WxErrorException - the wx error exception

getWatchStat

WxCpWatchStat getWatchStat(@NonNull
                           @NonNull String livingId,
                           String nextKey)
                    throws WxErrorException

获取直播观看明细 通过该接口可以获取所有观看直播的人员统计

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?access_token=ACCESS_TOKEN

参数:

livingId - 直播id

nextKey - 上一次调用时返回的next_key，初次调用可以填”0”

返回:

watch stat

抛出:

WxErrorException - the wx error exception

getUserAllLivingId

WxCpLivingResult.LivingIdResult getUserAllLivingId(@NonNull
                                                   @NonNull String userId,
                                                   String cursor,
                                                   Integer limit)
                                            throws WxErrorException

获取成员直播ID列表 通过此接口可以获取指定成员的所有直播ID

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_user_all_livingid?access_token=ACCESS_TOKEN

参数:

userId - 企业成员的userid

cursor - 上一次调用时返回的next_cursor，第一次拉取可以不填

limit - 每次拉取的数据量，默认值和最大值都为100

返回:

user all living id

抛出:

WxErrorException - the wx error exception

getLivingShareInfo

WxCpLivingShareInfo getLivingShareInfo(@NonNull
                                       @NonNull String wwShareCode)
                                throws WxErrorException

获取跳转小程序商城的直播观众信息 通过此接口，开发者可获取跳转小程序商城的直播间(“推广产品”直播)观众id、邀请人id及对应直播间id，以打通卖货直播的“人货场”信息闭环。

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_living_share_info?access_token=ACCESS_TOKEN

参数:

wwShareCode - "推广产品"直播观众跳转小程序商城时会在小程序path中带上ww_share_code=xxxxx参数

返回:

living share info

抛出:

WxErrorException - the wx error exception

livingCreate

String livingCreate(WxCpLivingCreateRequest request)
             throws WxErrorException

创建预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/create?access_token=ACCESS_TOKEN

参数:

request - 创建预约直播请求参数.

返回:

livingId （直播id）

抛出:

WxErrorException - the wx error exception

livingModify

WxCpLivingResult livingModify(WxCpLivingModifyRequest request)
                       throws WxErrorException

修改预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/modify?access_token=ACCESS_TOKEN

参数:

request - 修改预约直播请求参数.

返回:

wx cp living result

抛出:

WxErrorException - the wx error exception

livingCancel

WxCpLivingResult livingCancel(@NonNull
                              @NonNull String livingId)
                       throws WxErrorException

取消预约直播 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/cancel?access_token=ACCESS_TOKEN

参数:

livingId - 直播id，仅允许取消预约状态下的直播id

返回:

wx cp living result

抛出:

WxErrorException - the wx error exception

deleteReplayData

WxCpLivingResult deleteReplayData(@NonNull
                                  @NonNull String livingId)
                           throws WxErrorException

删除直播回放 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?access_token=ACCESS_TOKEN

参数:

livingId - 直播id

返回:

wx cp living result

抛出:

WxErrorException - the wx error exception