按讚

「喜歡」可以添加到每個頻道中的消息中，也可以從中刪除。

當你呼叫 API 來添加或移除「喜歡」時，與喜歡相關的事件消息會發送給頻道中的所有參與者。

添加喜歡 API¶

為特定消息添加“喜歡”。

你不能對已經點讚的消息再次點讚。
你不能對通知消息點讚。

請求 URL¶

伺服器	URL
直播	`https://plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}`
沙盒	`https://sandbox-plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}`
HTTP 方法	`POST`

路徑參數¶

欄位	描述	類型	必需
gameIndex	Hive 遊戲索引	整數	是
channelId	頻道 ID	字串	是
messageId	訊息 ID	字串	是

標頭參數¶

欄位	描述	類型	必需
Authorization	API 呼叫的驗證令牌 (`Bearer`)	字串	是
Content-Type	請求數據的類型 (`application/json`)	字串	是

請求主體¶

欄位	描述	類型	必需
playerId	喜歡它的用戶的玩家ID	long	Y

回應主體¶

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

請求範例¶

curl --location 'https://plugin-chat.withhive.com/plugin/api/like/v1/games/1/channels/open:12345/messages/0196f733-4f33-7a63-a657-5b0e5e792472' \
--header 'Content-Type: application/json' --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--data '{"playerId":1}'

回應範例¶

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

移除喜歡¶

從消息中移除一個讚。

你只能移除自己添加的喜歡。

請求 URL¶

伺服器	URL
直播	`https://plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}/players/{playerId}`
沙盒	`https://sandbox-plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}/players/{playerId}`
HTTP 方法	`DELETE`

路徑參數¶

欄位	描述	類型	必填
gameIndex	Hive 遊戲索引	整數	是
channelId	頻道 ID	字串	是
messageId	訊息 ID	字串	是
playerId	移除讚的用戶的玩家 ID	長整數	是

標頭參數¶

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

回應主體¶

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

請求範例¶

curl --location --request DELETE 'https://plugin-chat.withhive.com/plugin/api/like/v1/games/1/channels/open:12345/messages/0196f733-4f33-7a63-a657-5b0e5e792472/players/1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

回應範例¶

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

回應代碼¶

除了常见的响应代码外，以下是特定于点赞功能的响应代码。

HTTP 狀態碼	代碼	訊息	描述
400	10000	找不到或已刪除的讚。	找不到讚的資訊
400	10001	找不到或已刪除的訊息。	找不到讚的訊息
400	10002	訊息已經有讚的資訊。	讚的資訊已經存在

API 回應包含喜好資訊¶

本節解釋了在channel message history API的回應中包含的類似信息。

回應主體 > 數據 > 內容 > 插件數據¶

如果頻道消息包含喜歡的信息，則like字段包含在頻道消息歷史 API 響應主體的**data > content > pluginData**中。

欄位	描述	類型
like	喜好資訊	物件

回應主體 > 數據 > 內容 > 插件數據 > 喜歡¶

字段	描述	类型
playerIds	喜欢该消息的用户的玩家ID	长整型数组

回應範例¶

{
  // ...omitted
        "content": [
            {
                "gameIndex": 1374,
                "from": 1,
                "messageId": "ggJ5Csh15J-mI3i5",
                "extraData": "",
                "pluginData": {
                    "like": {
                        "playerIds": [
                            1
                        ]
                    }
                },
                "to": "public:10",
                "message": "aaa",
                "langCode": "ko",
                "timestamp": "2025-07-17T00:56:17.156Z",
                "timestampMillis": 1752713777156
            }
        ]
  // ...omitted
}