Sync Thread Messages

It supports the Query, Fields and sort.
URL
Requires Auth
HTTP Method
/api/v1/chat.syncThreadMessages
yes
GET
Query Parameters
One of roomId or roomName is required.
Argument
Example
Required
Description
tmid
hbs2ZAjHH2JXrP7C7
Required
Thread's message ID
updatedSince
2017-11-25T15:08:17.248Z
Required
Date as ISO string
When you provide the updatedSince query parameter in the URL then the update and remove in the response will contain only those updated and removed since this date and time.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     http://localhost:3000/api/v1/chat.syncThreadMessages?tmid=hbs2ZAjHH2JXrP7C7&updatedSince=2019-02-25T15:08:17.248Z
Copied!
Example Result
1
{
2
    "messages": {
3
        "update": [
4
            {
5
                "_id": "8BciMkvotHLpmpDEG",
6
                "rid": "GENERAL",
7
                "tmid": "hbs2ZAjHH2JXrP7C7",
8
                "msg": "test",
9
                "ts": "2019-04-16T18:30:46.615Z",
10
                "u": {
11
                    "_id": "rocketchat.internal.admin.test",
12
                    "username": "rocketchat.internal.admin.test",
13
                    "name": "RocketChat Internal Admin Test"
14
                },
15
                "_updatedAt": "2019-04-16T18:30:46.669Z",
16
                "mentions": [],
17
                "channels": []
18
            }
19
        ],
20
        "remove": []
21
    },
22
    "success": true
23
}
Copied!
Change Log
Version
Description
1.0.0
Added

Sync Thread List

Sync Messages

Last modified 1yr ago

Export as PDF

Copy link

Edit on GitHub

Contents