抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 服务端 API 介绍
  • 接口调用凭证
  • 登录
  • 直播间能力
  • 观众选择阵营(开发者提供)

    收藏
    我的收藏

    接口说明

    观众进入直播间打开小摇杆,在互动面板可以选择加入开发者在「用户快捷选队」中配置的阵营,平台服务器将用户的请求推送给开发者,开发者返回用户最终实际加入的阵营。

    接口要求

    性能要求:qps 至少要满足 200/s。
    时延要求:P99 <= 100ms。

    基本信息

    名称
    描述
    HTTP URL
    开发者在开发者控制台的「开发配置」中配置
    HTTP Method
    POST
    签名要求
    详见「查询观众阵营数据」API中对于签名方式的要求。
    开发者请务必校验数据签名,验证数据来源的合法性,否则存在被伪造数据攻击的危险,需自行担责

    请求头

    名称
    字段类型
    是否必填
    描述
    x-nonce-str
    string
    签名用的随机字符串
    x-timestamp
    int64
    发送消息的毫秒级时间戳
    x-roomid
    string
    房间Id
    x-msg-type
    string
    消息类型
    user_group_push:用户选择的阵营数据(与「查询观众阵营数据」API的消息类型不同)
    x-signature
    string
    请求签名,业务方接收后需要计算和校验签名,防伪造和篡改
    content-type
    string
    固定值:application/json

    签名方式

    同「查询观众阵营数据」API中对于签名方式的要求。

    请求参数

    Body
    名称
    字段类型
    是否必填
    描述
    app_id
    String
    小玩法app_id
    open_id
    String
    用户open_id
    room_id
    String
    房间Id
    group_id
    String
    用户选择的阵营ID
    avatar_url
    String
    用户头像
    nickname
    String
    用户昵称(不加密)

    响应参数

    请求响应都以http 200的形式返回,具体错误由响应字段中的错误码字段来标记。
    名称
    字段类型
    是否必填
    描述
    errcode
    Int64
    错误码,0代表成功。
    如果"用户已加入阵营"返回0,data返回用户最终实际加入的阵营数据。
    errmsg
    String
    错误描述,成功为 success
    data
    struct
    errcode为0时,该字段必传
    round_id
    Int64
    当前直播间,当前的对局id。如果一个对局已经结束,但是还没有开始新的对局,则返回已经结束的对局信息。如果从来没有开始过对局,则传 0。
    round_status
    Int
    当前直播间的对局状态。(1=已开始、2=已结束)
    group_id
    String
    用户在选择阵营操作后,实际加入的用户阵营id。如果用户没有成功加入阵营,该字段返回空字符串。

    响应示例

    •正常响应
    {"errcode": 0,"errmsg": "success","data": {"round_id": 12,"round_status": 1,"group_id": "test01"}}
    •异常响应
    {"errcode": 1,"errmsg": "参数不合法"}

    错误码

    HTTP 状态码
    错误码
    描述
    排查建议
    200
    40001
    参数错误
    房间id、小玩法app_id等入参解析失败,检查参数解析逻辑
    200
    4014034
    请求过于频繁
    提高接口的处理能力(必要时可联系平台进行熔断)
    200
    40004
    签名错误
    检查签名生成代码