使用者

本指南解释了如何使用 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 遊戲索引	整數	Y
playerId	玩家 ID	長整數	Y

標頭參數¶

欄位	描述	類型	必需
授權	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	頻道創建時間 (UnixTimestamp 毫秒)	長整數

請求範例¶

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 遊戲索引	字串	Y
playerId	阻擋用戶的玩家 ID	長整數	Y
blockPlayerId	被阻擋用戶的玩家 ID	長整數	Y

標頭參數¶

欄位	描述	類型	必需
Authorization	用於 API 調用的身份驗證令牌 (`Bearer`)	字串	Y

回應主體¶

欄位	描述	類型
代碼	回應代碼	整數
訊息	結果訊息	字串

請求範例¶

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	長整數	是

標頭參數¶

欄位	描述	類型	必需
授權	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`)	字串	是

回應主體¶

欄位	描述	類型
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."
}