直播信息

我的收藏

获取 access_token

该接口用于获取开放能力接口的调用凭证 access_token。

使用详情可参考: getAccessToken。

access_token 有效期为 2 小时，需要定期刷新。

获取直播信息

主播使用直播伴侣或移动端云启动玩法后，直播伴侣/移动端云启动会传入 token 到玩法中，当玩法获取 token 后，传递给玩法的服务端。玩法服务端通过该接口，使用 token 获取直播间信息。

token 有效期为 30 分钟。

频率限制：单个 app_id 调用上限为 10 次/秒。

请求地址

POST https://webcast.bytedance.com/api/webcastmate/info

请求参数

•

请求Headers

字段	数据类型	必填	说明
X-Token	string	是	通过接口获取的 access_token
content-type	string	是	必须包含 application/json

•

请求Body

字段	数据类型	必填	说明
token	string	是	获取到的 token

返回值

字段	数据类型	说明
errcode	int	请求错误码，0表示成功，非0表示失败
errmsg	string	非0错误码时，携带额外的错误提示信息
data	struct	请求成功时的返回数据，room_id 为 int64 类型： `"ack_cfg": [ // 预留信息，sdk接入使用，开发者不用感知 ], "linker_info": { // 连屏数据预留信息，开发者目前不用感知 "linker_id": 0, "linker_status": 0, "master_status": 0 }， "info": { "room_id": 7214015683695250235, "anchor_open_id":" "_000oJIu6APhomK7KIBGqSYm5XYPxCJB_xxx", "avatar_url": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-avt-0015_973c31e8055f78a41d3f7de3def9821d.jpeg?from=3067671334", "nick_name": "xxx" }`

返回数据示例

•

请求

curl --location --request POST 'http://webcast.bytedance.com/api/webcastmate/info' \
--header 'X-Token: 080112184630394f5735585a344f74546645794b544b786f30413d3d' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token":"pJKr395h6O5x2ykBjgrBIxnuot8nn62djr70EocUFXtiN1s9VpsHHuEPdZYKHVJFzftyIOb8lj9i0lrLnUhQsK55pT8shfX98qGuUBO7PSKoIVRq6tWMRdsjPVw="
}'

•

正常返回

{
  "data": {
    "ack_cfg": [ // 预留信息，sdk接入使用，开发者不用感知
    ],
    "linker_info": { // 连屏数据预留信息，开发者目前不用感知
        "linker_id": 0,
        "linker_status": 0,
        "master_status": 0
    }，
    "info": {
        "room_id": 7214015683695250235,
        "anchor_open_id": "_000oJIu6APhomK7KIBGqSYm5XYPxCJB_xxx",
        "avatar_url": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-avt-0015_973c31e8055f78a41d3f7de3def9821d.jpeg?from=3067671334",
        "nick_name": "xxx"
    }
  }
}

•

错误返回

{
        "data": {
        },
        "errcode": 40001,
        "errmsg": "invalid params",
        "extra": {
                "now": 1717059693095
        },
        "status_code": 40001
}

•

错误码说明

可以优先使用status_code作为错误码，errcode也会保持继续下发

错误码	错误信息	描述
-1	system error	服务内部异常
40001	request params are invalid	参数有误
40002	you don't have permission	通常为小程序没有该项能力
40007	over frequency control	调用频率过高
40014	required param not found	缺少必要的参数
50036	token parse failed	token解析异常
50037	appid not match	x-token和token解析到的app_id不一致
50038	room not found	token解析到的room_id对应房间不存在
50039	token has expired	token已过期