cn.felord.reactive.api

Interface LivingApi

public interface LivingApi

直播API

Since:

2024/11/23

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<WeComResponse>	cancel(LivingId livingId) 取消预约直播
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	create(LivingCreateRequest request) 创建预约直播
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteReplayData(LivingId livingId) 删除直播回放
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	getLivingCode(LivingCodeRequest request) 获取微信观看直播凭证
io.reactivex.rxjava3.core.Single<GenericResponse<LivingInfo>>	getLivingInfo(String livingid) 获取直播详情
io.reactivex.rxjava3.core.Single<LivingShareInfoResponse>	getLivingShareInfo(WwShareCode wwShareCode) 获取跳转小程序商城的直播观众信息
io.reactivex.rxjava3.core.Single<UserLivingsResponse>	getUserAllLivingid(UserLivingsRequest request) 获取成员直播ID列表
io.reactivex.rxjava3.core.Single<WatchStatResponse>	getWatchStat(WatchStatRequest request) 获取直播观看明细
io.reactivex.rxjava3.core.Single<WeComResponse>	modify(LivingUpdateRequest request) 修改预约直播

Method Detail

create

@POST(value="living/create")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> create(@Body
                                                                                              LivingCreateRequest request)

创建预约直播

权限说明：

• 发起人必须在应用可见范围内，「上课直播/直播」应用默认全员可见
• 系统应用「上课直播/直播」默认可使用直播接口
• 自建应用需要配置在“可调用接口的应用”里
• 第三方服务商创建应用的时候，需要开启“直播接口权限”

Parameters:

request - the request

Returns:

the generic response

modify

@POST(value="living/modify")
io.reactivex.rxjava3.core.Single<WeComResponse> modify(@Body
                                                                                    LivingUpdateRequest request)

修改预约直播

权限说明：

• 仅允许修改当前应用创建的直播。

Parameters:

request - the request

Returns:

the we com response

cancel

@POST(value="living/cancel")
io.reactivex.rxjava3.core.Single<WeComResponse> cancel(@Body
                                                                                    LivingId livingId)

取消预约直播

权限说明：

• 仅允许取消当前应用创建的直播。

Parameters:

livingId - the living id

Returns:

the we com response

deleteReplayData

@POST(value="living/delete_replay_data")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteReplayData(@Body
                                                                                                          LivingId livingId)

删除直播回放

权限说明：

• 仅允许删除当前应用的直播回放。

Parameters:

livingId - the living id

Returns:

the we com response

getLivingCode

@POST(value="living/get_living_code")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> getLivingCode(@Body
                                                                                                              LivingCodeRequest request)

获取微信观看直播凭证

权限说明：

• 非直播系统应用仅允许获取当前应用创建的微信观看直播凭证。
• 直播系统应用可以调用该企业任意直播的微信观看直播凭证。

Parameters:

request - the request

Returns:

the generic response

getUserAllLivingid

@POST(value="living/get_user_all_livingid")
io.reactivex.rxjava3.core.Single<UserLivingsResponse> getUserAllLivingid(@Body
                                                                                                                     UserLivingsRequest request)

获取成员直播ID列表

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

权限说明：

• 「上课直播/直播」应用有获取用户的所有直播
• 自建应用和第三方应用只能获取本应用创建的直播

Parameters:

request - the request

Returns:

the user all livingid

getLivingInfo

@GET(value="living/get_living_info")
io.reactivex.rxjava3.core.Single<GenericResponse<LivingInfo>> getLivingInfo(@Query(value="livingid")
                                                                                                                 String livingid)

获取直播详情

权限说明：

• 「上课直播/直播」应用有获取用户的所有直播
• 自建应用和第三方应用只能获取本应用创建的直播

Parameters:

livingid - the livingid

Returns:

the living info

getWatchStat

@POST(value="living/get_watch_stat")
io.reactivex.rxjava3.core.Single<WatchStatResponse> getWatchStat(@Body
                                                                                                      WatchStatRequest request)

获取直播观看明细

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

权限说明：

• 「上课直播/直播」应用有获取用户的所有直播
• 自建应用和第三方应用只能获取本应用创建的直播

Parameters:

request - the request

Returns:

the user all livingid

getLivingShareInfo

@POST(value="living/get_living_share_info")
io.reactivex.rxjava3.core.Single<LivingShareInfoResponse> getLivingShareInfo(@Body
                                                                                                                         WwShareCode wwShareCode)

获取跳转小程序商城的直播观众信息

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

权限说明：

• 系统应用「直播」默认可使用此接口
• 自建应用需要配置在“可调用接口的应用”里
• 第三方服务商创建应用的时候，需要开启“直播接口权限”
• 跳转的小程序需要与企业有绑定关系

Parameters:

wwShareCode - the wwShareCode

Returns:

the user all livingid