虎牙开放平台文档

开放API协议说明

通用业务状态码说明

业务状态码	备注
200	成功
407	鉴权失败
602	调用失败
其他	失败

查询粉丝勋章信息

接口调用说明

请求方式: POST（json）
请求地址：https://open-apiext.huya.com/api/queryFansBadgeInfo?appId=xxx&roomId=xxx&extUuid=xxx&iat=xxx&exp=xxx&sToken=xxx

接口调用限制说明

主播需要安装该小程序
用户若设置了隐私权限不对外展示粉丝勋章，就算用户本身是拥有主播的粉丝勋章接口也会返回暂未拥有

url query参数说明

参数名称	类型	备注
appId	string	开发者的appId
iat	int	jwt签发时间（unix时间戳），即生成sToken的当前unix时间戳
exp	int	jwt过期时间（unix时间戳），通常exp=iat+600，注意不少于当前时间且不超过当前时间60分钟
extUuid	string	小程序ID
roomId	long	主播房间号
sToken	string	jwt鉴权生成的token

POST数据说明

参数名称	类型	备注
无需名称	json list	用户unionId列表

响应数据说明

{
    "code": 200,
    "message": "成功",
    "data": {
        "用户unionId": {
            "userUnionId": string类型，用户unionId,
            "profileUnionId": string类型，主播unionId,
            "roomId": long类型，主播房间号,
            "isSetFansBadgePrivacy": bool类型， 用户是否设置了隐私权限不对外展示粉丝勋章, true-已设置 false-没有设置
            "hasFansBadge": bool类型，是否具有该主播的粉丝勋章， true-拥有 false-没有，如果用户本来有粉丝勋章但是设置了隐私权限不对外展示，也会返回false
            "badgeLevel": int类型，勋章等级
        }
    }
}

curl示例

请求

curl --location --request POST 'https://open-apiext.huya.com/api/queryFansBadgeInfo?appId=xxx&roomId=xxx&extUuid=xxx&iat=1556188391&exp=1556188991&sToken=xxx' 
--header 'Content-Type: application/json' 
--data-raw '["unHTnNDQClkUfzxmMClUOw2d2Hxzt6AWKU"]'

响应

{
    "code": 200,
    "message": "成功",
    "data": {
        "unHTnNDQClkUfzxmMClUOw2d2Hxzt6AWKU": {
            "userUnionId": "unHTnNDQClkUfzxmMClUOw2d2Hxzt6AWKU",
            "profileUnionId": "unC/Tjerc5Brq8uWRGqRoWe4Q+0UBaGuIQ",
            "roomId": 12323,
            "isSetFansBadgePrivacy": false,
            "hasFansBadge": true
            "badgeLevel": 1
        }
    }
}

开放API