用户

本指南解释了如何使用 API 来查看用户加入的频道、查看用户黑名单、阻止用户和解除阻止用户。

获取用户加入的频道 API¶

检索用户参与的频道列表，排除1:1频道（ONE_ON_ONE）。

请求 URL¶

服务器	URL
线上	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/channels`
沙盒	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/channels`
HTTP 方法	`GET`

路径参数¶

字段	描述	类型	必需
gameIndex	Hive 游戏索引	整数	是
playerId	玩家ID	长整型	是

头部参数¶

字段	描述	类型	必需
Authorization	API 调用的认证令牌（`Bearer`）	字符串	Y

响应主体¶

字段	描述	类型
code	响应代码	整数
message	结果消息	字符串
data	响应数据	对象

响应体 > 数据¶

字段	描述	类型
gameIndex	Hive 游戏索引	整数
playerId	玩家ID	长整型
channels	渠道列表	对象数组

响应主体 > 数据 > 渠道¶

字段	描述	类型
channelId	渠道ID	字符串
type	渠道类型（`PRIVATE`，`PUBLIC`，`GROUP`）	字符串
gameIndex	Hive 游戏索引	整数
owner	渠道拥有者	字符串
channelName	渠道名称	字符串
memberCount	当前渠道成员数量	整数
maxMemberCount	渠道成员的最大数量	整数
chatHistoryAllowed	是否可以查看消息历史	布尔值
regTime	渠道创建时间（`UTC+0`，`yyyy-MM-dd'T'HH:mm:ss.SSSZ` 格式）	字符串
regTimeMillis	渠道创建时间（Unix时间戳毫秒）	长整型

请求示例¶

curl --request GET 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/channels' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg'

响应示例¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "gameIndex": 1,
    "playerId": 1001,
    "channels": [
      {
        "channelId": "guild:12345",
        "type": "GROUP",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "Guild chat room",
        "memberCount": 1,
        "maxMemberCount": 50,
        "chatHistoryAllowed": true,
        "regTime": "2023-12-19T15:01:01.004Z",
        "regTimeMillis": 1731306364351
      },
      {
        "channelId": "open:67890",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "SYSTEM",
        "channelName": "Open chat room",
        "memberCount": 2,
        "maxMemberCount": 100,
        "chatHistoryAllowed": true,
        "regTime": "2023-12-20T10:15:30.123Z",
        "regTimeMillis": 1731302348750
      }
      // ... channels
    ]
  }
}

阻止用户 API¶

阻止用户限制实时消息的发送和接收。

在屏蔽用户后，频道和消息的行为如下变化：

您仍然可以收到来自被阻止用户的 1:1 频道 (ONE_ON_ONE) 邀请。
- 这是为了避免通知被阻止的用户他们已被阻止。
您将不会收到关于被阻止用户的**聊天消息**或**事件消息**，例如频道的进入和退出。
您无法向被阻止用户发送消息。

请求 URL¶

服务器	URL
直播	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/block/{blockPlayerId}`
沙盒	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/block/{blockPlayerId}`
HTTP 方法	`POST`

路径参数¶

字段	描述	类型	必需
gameIndex	Hive 游戏索引	字符串	是
playerId	阻止用户的玩家ID	长整型	是
blockPlayerId	被阻止用户的玩家ID	长整型	是

头部参数¶

字段	描述	类型	必需
Authorization	API 调用的认证令牌 (`Bearer`)	字符串	Y

响应主体¶

字段	描述	类型
code	响应代码	整数
message	结果消息	字符串

请求示例¶

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/block/1002' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg'

响应示例¶

{
  "code": 0,
  "message": "Success."
}

获取用户黑名单¶

检索特定用户阻止的用户列表。

请求 URL¶

服务器	URL
直播	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/blocks`
沙盒	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/blocks`
HTTP 方法	`GET`

路径参数¶

字段	描述	类型	必需
gameIndex	Hive 游戏索引	字符串	是
playerId	阻止用户的玩家ID	长整型	是

头部参数¶

字段	描述	类型	必需
Authorization	API 调用的认证令牌 (`Bearer`)	字符串	Y

响应体¶

字段	描述	类型
code	响应代码	整数
message	结果消息	字符串
data	响应数据	对象

响应主体 > 数据¶

字段	描述	类型
gameIndex	Hive 游戏索引	整数
playerId	阻止用户的玩家ID	长整型
blockedUsers	被阻止用户信息列表	对象数组

响应体 > 数据 > 被阻止的用户¶

字段	描述	类型
blockedPlayerId	被阻止用户的玩家ID	long
blockedTime	被阻止时间（`UTC+0`，`yyyy-MM-dd'T'HH:mm:ss.SSSZ` 格式）	string
blockedTimeMillis	被阻止时间（Unix时间戳毫秒）	long

请求示例¶

curl  --request GET 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/blocks' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg'

响应示例¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "gameIndex": 1,
    "playerId": 1001,
    "blockedUsers": [
      {
        "blockedPlayerId": 1002,
        "blockedTime": "2023-12-20T10:15:30.123Z",
        "blockedTimeMillis": 1739329550811
      },
      {
        "blockedPlayerId": 1003,
        "blockedTime": "2023-12-21T08:45:12.456Z",
        "blockedTimeMillis": 1739329553137
      }
      // ... block list
    ]
  }
}

解锁用户¶

解除对被阻止用户的阻止。

请求 URL¶

服务器	URL
直播	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/block/{blockedPlayerId}`
沙盒	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/users/{playerId}/block/{blockedPlayerId}`
HTTP 方法	`DELETE`

路径参数¶

字段	描述	类型	必需
gameIndex	Hive 游戏索引	字符串	是
playerId	玩家ID	长整型	是
blockedPlayerId	要解除封锁的用户的玩家ID	长整型	是

头部参数¶

字段	描述	类型	必需
授权	API 调用的身份验证令牌 (`Bearer`)	字符串	Y

响应主体¶

字段	描述	类型
code	响应代码	整数
message	结果消息	字符串

请求示例¶

curl --request DELETE 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/block/1002' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg'

响应示例¶

{
  "code": 0,
  "message": "Success."
}