虎牙开放平台文档

hyExt.backend.commonOperate

通用上行接口
端上直接请求服务器
引入版本 1.13.0
适用终端
虎牙直播主站
虎牙直播APP-iOS：8.1.0
虎牙直播APP-安卓：8.1.0
虎牙直播助手-iOS：4.12.0
虎牙直播助手-安卓：4.12.0
虎牙直播PC客户端-主播侧：4.21.4.0
虎牙直播PC客户端-观众侧：5.4.0.2

接口签名

declare namespace hyExt {
  module backend {
    /**
     * 通用上行接口
     * @param params 输入参数
     */
    function commonOperate(
      params:
        | ControlEntrancReq
        | ControlPanelLoadReq
        | ControlPanelShowReq
        | DeliverMsgToProfileReq
    ): Promise<ControlEntrancRsp | DeliverMsgRsp>
  }

  /**
   * 控制观众端小程序入口
   */
  type ControlEntrancReq = {
    /**
     * 控制观众端小程序入口
     */
    key: "controlEntrance"
    /**
     * 参数
     */
    param: ControlEntranceParam
  }

  /**
   * 控制观众端小程序入口参数
   */
  type ControlEntranceParam = {
    /**
     * 观众端小程序类型（多个用逗号分隔）；取值说明:
     * web_video_com 虎牙主站-面板;
     * app_panel     虎牙直播APP-面板;
     * pc_panel      PC观众端面板;
     */
    extTypes: string
    /**
     * 是否显示
     */
    visible: boolean
  }

  /**
   * 控制观众端小程序面板加载
   */
  type ControlPanelLoadReq = {
    /**
     * 控制观众端小程序面板加载
     */
    key: "controlPanelLoad"
    /**
     * 参数
     */
    param: ControlPanelLoadParam
  }

  /**
   * 控制观众端小程序面板加载参数
   */
  type ControlPanelLoadParam = {
    /**
     * 观众端小程序类型（多个用逗号分隔）；取值说明:
     * web_popup       虎牙主站-浮窗;
     * app_popup       虎牙直播APP-浮窗;
     * zs_anchor_popup 虎牙助手-浮窗;
     * pc_popup        PC观众端浮窗;
     */
    extTypes: string
    /**
     * 是否加载
     */
    visible: boolean
  }

  /**
   * 控制观众端小程序面板展示
   */
  type ControlPanelShowReq = {
    /**
     * 控制观众端小程序面板展示
     */
    key: "controlPanelShow"
    /**
     * 参数
     */
    param: ControlPanelShowParam
  }

  /**
   * 控制观众端小程序面板展示参数
   */
  type ControlPanelShowParam = {
    /**
     * 观众端小程序类型（多个用逗号分隔）；取值说明:
     * web_popup       虎牙主站-浮窗;
     * app_popup       虎牙直播APP-浮窗;
     * zs_anchor_popup 虎牙助手-浮窗;
     * pc_popup        PC观众端浮窗;
     */
    extTypes: string
    /**
     * 是否展示
     */
    visible: boolean
  }

  /**
   * 观众端上行消息到主播端
   */
  type DeliverMsgToProfileReq = {
    /**
     * 观众端上行消息到主播端
     */
    key: "message.deliverMsgToProfile"
    /**
     * 参数
     */
    param: DeliverMsgToProfileParam
  }

  /**
   * 上行消息到主播端参数
   */
  type DeliverMsgToProfileParam = {
    /**
     * 自定义事件标识（首字符为英文，最大128个可见字符，只支持数字，大小写英文，下划线，加号）
     */
    event: string
    /**
     * 自定义消息内容（大小不超过5K）
     */
    message: string
  }

  /**
   * 控制操作返回
   */
  type ControlEntrancRsp = {
    /**
     * 状态码, 0为成功
     */
    status: number
    /**
     * 描述
     */
    msg: string
  }

  /**
   * 上行消息返回信息
   */
  type DeliverMsgRsp = {
    /**
     * 上行消息返回状态码
     */
    res: DeliverMsgRspCode
    /**
     * 上行消息返回错误信息
     */
    message: string
  }
  /**
   * 观众端上行消息到主播端返回的状态码
   */
  enum DeliverMsgRspCode {
    /**
     * 发送失败/权限问题/频率超出
     */
    FAILED = 2,
    /**
     * 贵族表情拦截
     */
    INTERCEPT = 17,
    /**
     * 直播间封禁弹幕或者高危敏感词
     */
    SENSITIVE = 107,
    /**
     * 未绑定手机号
     */
    NOT_BIND_PHONE_NUMBER = 905,
  }
}

示例代码

hyExt.backend
  .commonOperate({
    key: "controlEntrance",
    param: {
      extTypes: "web_video_com",
      visible: true,
    },
  })
  .then((res) => {
    console.log("调用hyExt.backend.commonOperate成功", res)
  })
  .catch((err) => {
    console.log("调用hyExt.backend.commonOperate失败", err)
  })

hyExt.backend
  .commonOperate({
    key: "message.deliverMsgToProfile",
    {
      event: "huya_event",
      message: "huya_message"
    }
  }).then(resp => {
    /** 调用成功 */
  }).catch(err => {
    /** 调用失败 */
  })

hyExt.backend.commonOperate

接口签名

示例代码

相关链接