いいね

「いいね」は、チャンネル内の各メッセージに追加したり削除したりできます。

APIを呼び出して「いいね」を追加または削除すると、いいねに関連するイベントメッセージがチャンネル内のすべての参加者に送信されます。

いいねAPI¶

特定のメッセージに「いいね」を追加します。

すでに「いいね」をしたメッセージには「いいね」を追加できません。
通知メッセージには「いいね」を追加できません。

リクエストURL¶

サーバー	URL
LIVE	`https://plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}`
SANDBOX	`https://sandbox-plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}`
HTTP METHOD	`POST`

パスパラメータ¶

フィールド	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y
messageId	メッセージID	文字列	Y

ヘッダーパラメータ¶

フィールド	説明	タイプ	必須
Authorization	API呼び出しの認証トークン（`Bearer`）	文字列	Y
Content-Type	リクエストデータのタイプ（`application/json`）	文字列	Y

リクエストボディ¶

フィールド	説明	タイプ	必須
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."
}

{ #remove-like }のように削除する¶

メッセージからいいねを削除します。

自分が追加したいいねのみ削除できます。

リクエストURL¶

サーバー	URL
LIVE	`https://plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}/players/{playerId}`
SANDBOX	`https://sandbox-plugin-chat.withhive.com/plugin/api/like/v1/games/{gameIndex}/channels/{channelId}/messages/{messageId}/players/{playerId}`
HTTP METHOD	`DELETE`

パスパラメータ¶

フィールド	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y
messageId	メッセージID	文字列	Y
playerId	いいねを削除するユーザーのプレイヤーID	長整数	Y

ヘッダーパラメータ¶

フィールド	説明	種類	必須
Authorization	API呼び出しの認証トークン（`Bearer`）	文字列	Y

応答本文¶

フィールド	説明	タイプ
コード	レスポンスコード	整数
メッセージ	結果メッセージ	文字列

リクエストサンプル¶

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レスポンスにいいね情報を含む¶

このセクションでは、チャンネルメッセージ履歴APIのレスポンスに含まれる情報について説明します。

レスポンスボディ > データ > コンテンツ > プラグインデータ¶

チャンネルメッセージにいいね情報が含まれている場合、likeフィールドはチャンネルメッセージ履歴APIレスポンスボディの**data > content > pluginData**に含まれます。

フィールド	説明	タイプ
like	いいね情報	オブジェクト

レスポンスボディ > データ > コンテンツ > プラグインデータ > いいね¶

フィールド	説明	タイプ
playerIds	メッセージを気に入ったユーザーのプレイヤーID	long array

応答サンプル¶

{
  // ...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
}