Skip to content

Mention

This feature allows you to mention a specific user in a channel message and send them a notification.

The operation of the 'mention' feature is as follows:

  • There is no independent API dedicated to the mention feature; instead, mention information is included in the response data of existing APIs.
  • Mentioned users receive a separate push notification (remote push, SDK required).

API response including mention information

This section explains the mention information included in the response of the channel message history API.

Response body > data > content > pluginData

If a channel message has mention information, the mentions field is included in data > content > pluginData of the channel message history API response body.

Field Description Type
mentions Mention info object array

Response body > data > content > pluginData > mentions

Field Description Type
playerId Player ID of the mentioned user long

Response sample

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