Get Thread Messages

Get thread messages. It supports the Pagination parameters, alongside the Query and Fields parameters.

URLRequires AuthHTTP Method

/api/v1/chat.getThreadMessages

yes

GET

Query Parameters

ArgumentExampleRequiredDescription

tmid

7aDSXtjMA3KPLxLjt

Required

The id of the thread message.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/chat.getThreadMessages?tmid=gcGai9bRREqokjyPc

Example Result

{
    "messages": [
        {
            "_id": "GfhiiJjcjKFyYMuMY",
            "rid": "GENERAL",
            "tmid": "gcGai9bRREqokjyPc",
            "tshow": true,
            "msg": "This is a test reply, that is also sent to the channel!",
            "ts": "2019-04-08T13:20:22.238Z",
            "u": {
                "_id": "p4a8YxvLQEHmiBKTS",
                "username": "marcos.defendi",
                "name": "Marcos Defendi"
            },
            "_updatedAt": "2019-04-08T13:20:22.265Z",
            "urls": [],
            "mentions": [],
            "channels": [],
            "md": [
                {
                    "type": "PARAGRAPH",
                    "value": [
                        {
                            "type": "PLAIN_TEXT",
                            "value": "This is a test reply, that is also sent to the channel!"
                        }
                    ]
                }
            ]
        },
        {
            "_id": "DvkcMiup4twAouPYf",
            "rid": "GENERAL",
            "tmid": "gcGai9bRREqokjyPc",
            "msg": "This is also a test reply, not sent to channel.",
            "ts": "2019-04-08T13:25:25.228Z",
            "u": {
                "_id": "p4a8YxvLQEHmiBKTS",
                "username": "marcos.defendi",
                "name": "Marcos Defendi"
            },
            "_updatedAt": "2019-04-08T13:25:25.258Z",
            "urls": [],
            "mentions": [],
            "channels": [],
            "md": [
                {
                    "type": "PARAGRAPH",
                    "value": [
                        {
                            "type": "PLAIN_TEXT",
                            "value": "This is also a test reply, not sent to channel."
                        }
                    ]
                }
            ]
        }
        }
    ],
    "count": 2,
    "offset": 0,
    "total": 2,
    "success": true
}

Change Log

VersionDescription

1.2.0

Remove tlm field, which is not supported

1.1.0

Update Example Results - original message in thread is not returned.

1.0.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.