You need to enable JavaScript to run this app.
导航
评论发送回调
最近更新时间:2025.03.21 10:45:22首次发布时间:2022.11.30 12:02:27
我的收藏
有用
有用
无用
无用

作用

当用户在直播间内发送评论时,企业直播会对所设置的接口地址进行回调通知。

说明

机器人发送评论不会触发该回调。

配置方式

将接收回调通知的接口地址提供给企业直播技术支持。

详情

设置回调的接口地址后,当用户在直播间内发送评论时,企业直播会将直播间 ID、评论信息以及发送评论的用户信息以 POST 方式提交给您自定义的回调接口。
请求示例如下所示:

POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
    "Data": [
        {
            "ChatId": 167326370108****,
            "CreateTime": 1741182118,
            "TextContent": "你好",
            "User": {
                "Nickname": "观众 A",
                "UserId": 174882290297****,
                "ExternalId": "38749145636****"
            },
            "IsDelete": false,
            "LikeCount": 0,
            "IsPresenter": false,
            "reviewStatus": 0,
            "ActivityID": 1825754765124****,
            "SubAccountName": "admin@bytedance.com"
        }
    ]
}

超时重试

回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。

Body

参数

类型

说明

Data

Array of CommentCallbackParam

数据列表。

CommentCallbackParam

参数

类型

说明

ChatId

Long

评论 ID。

CreateTime

Long

评论的发送时间。Unix 时间戳,单位为秒。

TextContent

String

评论内容。

User

User

发送评论的用户信息。

IsPresenter

Boolean

是否是主持人发送的评论。取值如下:

  • true:是
  • false:否

ActivityID

Long

直播间 ID。

SubAccountName

String

创建直播间的账号。参数值 admin@bytedance.com 表示直播间为主账号创建。

IsDelete

Boolean

评论是否被删除。取值如下:

  • true:是
  • false:否

LikeCount

Integer

评论点赞数量。

reviewStatus

Integer

评论审核状态。取值如下:

  • 0:无需审核。
  • 1:待审核。
  • 2:审核通过。
  • 3:审核不通过。

User

参数

类型

说明

Nickname

String

用户昵称。

UserId

Long

用户 ID。

ExternalId

String

关联用户 ID,即用户在第三方平台的唯一标识。
您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。
用户通过不同方式登录直播间,关联用户 ID 的取值如下所示。

  • 微信:观众在企业直播微信服务号的 OpenID。
  • 企业微信:绑定企业直播的企业内部成员 OpenID。
  • 自定义:自定义登录时通过 UserId 传入的值。详见自定义登录
  • OAuth 2.0:您自有账号系统中用户 ID 对应的字段。
  • 飞书:绑定企业直播的飞书企业成员 Open ID。
  • 手机号:观众通过手机号注册企业直播后生成的 passport_id。
  • 白名单:观众输入的白名单校验信息。

说明

  • 如果您集成了观播 SDK,且 SDK 的鉴权模式为自定义模式,关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 UserIdStr(观众 ID)。
  • 仅当 IsPresenter 取值为 false 时,该参数有值。