上报直播间事件

project_id

是

String

项目ID，获取方法请参考获取项目ID。

room_id

是

String

剧本ID。

job_id

是

String

任务ID。

auth_key

否

String

鉴权Key。通过HmacSHA256生成的鉴权key

expires_time

否

Long

参数解释：

鉴权key过期时间。从1970年1月1日（UTC/GMT的午夜）开始所经过的毫秒数。

取值范围：

0-4102415999000

refresh_url

否

Boolean

是否刷新URL

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

X-App-UserId

否

String

第三方用户ID。不允许输入中文。

total

是

Integer

参数解释：

事件条目数。

取值范围：

1-1000

events

否

Array of LiveEvent objects

事件内容。

review_config

否

ReviewConfig object

内容审核配置

timestamp

是

Long

参数解释：

事件戳。从1970-01-01 00:00:00:000开始的毫秒数

取值范围：

0-4102415999000

type

否

Integer

参数解释：

事件类型。

• 1 弹幕信息

• 2 用户入场

• 3 用户点赞

• 4 用户送礼

• 5 用户订阅\关注

• 6 房间观看人数

取值范围：

0-100

content

否

String

事件内容。

事件类型不同，content内容也不同，定义如下所示：

• type=1 弹幕信息

  content定义：

  • user:用户，json

  • content: string,弹幕内容user定义：

  • userId：用户id，string

  • name：用户姓名，string

  • level：用户平台等级，int

  • badge：用户牌子名称，string

  • badgeLevel：牌子等级，int举例：

  {
    "timestamp": 1694481224245,
    "type": 1,
    "content": "{\"user\":{\"userId\":\"2027271526\",\"name\":\"***\",\"level\":17,\"badge\":\"\",\"badgeLevel\":0},\"content\":\"***\"}"
  }

• type=2 用户入场

  content定义：

  • user:用户，json举例：

  {
    "timestamp": 1694481227655,
    "type": 2,
    "content": "{\"user\":{\"userId\":\"2978899271\",\"name\":\"***\",\"level\":1,\"badge\":\"\",\"badgeLevel\":0}}"
  }

• type=3 用户点赞

  content定义：

  • user：用户，json举例：

  {
    "timestamp": 1694481227655,
    "type": 2,
    "content": "{\"user\":{\"userId\":\"2978899271\",\"name\":\"***\",\"level\":1,\"badge\":\"\",\"badgeLevel\":0}}"
  }

• type=4 用户送礼

  content定义：

  • user：用户，json

  • gift：礼物信息,jsongift定义：

  • giftName：礼物名称，string

  • giftNum：礼物数量，int

  • totalValue：此处礼物总价值，int

  • giftValue：单个礼物价值，int举例：

  {
    "timestamp": 1690531652862,
    "type": 4,
    "content": "{\"gift\":{\"giftName\":\"小星星\",\"giftNum\":10,\"totalValue\":10,\"giftValue\":3},\"user\":{\"userId\":\"douyin_95882940927\",\"name\":\"纯爱战士熙熙\",\"level\":2,\"badge\":\"\",\"badgeLevel\":0}}"
  }

• type=5 用户订阅

  暂未使用

• type=6 房间观看人数

  content定义：

  • numberOfViewers：房间观看人数，int举例：

  {
    "timestamp": 1694481236886,
    "type": 6,
    "content": "{\"numberOfViewers\":5466}"
  }

no_need_review

否

Boolean

免审核。 目前仅白名单用户可使用此参数，非白名单用户跟随系统策略审核。

X-Request-Id

String

请求ID。

live_event_report_url

String

刷新后的直播事件上传URL

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

200

成功。

400

请求传参异常，包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。