get-all-user-mentions-in-channel.md

Get All User Mentions in Channel

HTTP Method	URL	Requires Auth
GET	/api/v1/channels.getAllUserMentionsByChannel	yes

Query Parameters

This endpoint supports the #pagination parameters.

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID.

Example Call

{% code overflow="wrap" %}

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     https://localhost:3000/api/v1/channels.getAllUserMentionsByChannel?roomId=ByehQjC44FwMeiLbX

{% endcode %}

Example Response

{
    "mentions": [
        {
            "_id": "Gptx3mc6TjSv5tLWb",
            "rid": "GENERAL",
            "msg": "@rocket.cat",
            "ts": "2018-03-12T14:59:14.166Z",
            "u": {
                "_id": "47cRd58HnWwpqxhaZ",
                "username": "test",
                "name": "test"
            },
            "mentions": [
                {
                    "_id": "47cRd58HnWwpqxhaZ",
                    "username": "rocket.cat"
                }
            ],
            "channels": [],
            "_updatedAt": "2018-03-12T14:59:14.171Z"
        },
        {
            "_id": "rwerwfjuii6TjSv5tLWb",
            "rid": "GENERAL",
            "msg": "@rocket.cat",
            "ts": "2018-03-12T14:59:14.166Z",
            "u": {
                "_id": "47cRd58HnWwpqxhaZ",
                "username": "test",
                "name": "test"
            },
            "mentions": [
                {
                    "_id": "47cRd58HnWwpqxhaZ",
                    "username": "rocket.cat"
                }
            ],
            "channels": [],
            "_updatedAt": "2018-03-12T14:59:14.171Z"
        }
    ],
    "count": 2,
    "offset": 10,
    "total": 2,
    "success": true
}

Change Log

Version	Description
0.63.0	Added