Sync Thread List
- Print
- DarkLight
- PDF
Sync Thread List
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/chat.syncThreadsList
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
string
The room ID. It is required if the roomName is not provided.
Exampledlp
roomName
string
The room name. It is required if the roomId is not provided.
ExampleWDuJLFkjwk6L7LdFC
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
Example50
sort
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }
updatedSince
string
Date as an ISO string. When you provide the updatedSince query parameter, then the update and remove parameters in the response will contain only those updated and removed since this date and time.
Responses
200
OK
Example 1
{
"threads": {
"update": [
{
"_id": "J8Sqi5zPw62WgE4Md",
"rid": "GENERAL",
"msg": "test1",
"ts": "2019-04-16T18:16:00.614Z",
"u": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test",
"name": "RocketChat Internal Admin Test"
},
"_updatedAt": "2019-04-16T18:17:09.749Z",
"mentions": [],
"channels": [],
"replies": [
"rocketchat.internal.admin.test"
],
"tcount": 1,
"tlm": "2019-04-16T18:17:09.672Z"
},
{
"_id": "hbs2ZAjHH2JXrP7C7",
"rid": "GENERAL",
"msg": "another test",
"ts": "2019-04-16T18:13:20.403Z",
"u": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test",
"name": "RocketChat Internal Admin Test"
},
"_updatedAt": "2019-04-16T18:30:46.722Z",
"mentions": [],
"channels": [],
"replies": [
"rocketchat.internal.admin.test"
],
"tcount": 1,
"tlm": "2019-04-16T18:30:46.615Z"
}
],
"remove": [
{
"_id": "GXwCSs4cx6456WBJk",
"rid": "GENERAL",
"msg": "test",
"ts": "2019-04-16T18:13:39.217Z",
"u": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test",
"name": "RocketChat Internal Admin Test"
},
"_updatedAt": "2019-04-16T18:16:00.696Z",
"mentions": [],
"channels": [],
"replies": [
"rocketchat.internal.admin.test"
],
"tcount": 1,
"tlm": "2019-04-16T18:16:00.614Z",
"_deletedAt": "2019-04-16T18:16:13.508Z",
"__collection__": "message"
}
]
},
"success": true
}object
threads
object
update
Array of object
object
_id
string
rid
string
msg
string
ts
string
u
object
_id
string
username
string
name
string
_updatedAt
string
mentions
Array of object
object
channels
Array of object
object
replies
Array of string
string
tcount
integer
tlm
string
remove
Array of object
object
_id
string
rid
string
msg
string
ts
string
u
object
_id
string
username
string
name
string
_updatedAt
string
mentions
Array of object
object
channels
Array of object
object
replies
Array of string
string
tcount
integer
tlm
string
_deletedAt
string
__collection__
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"rid\" query param is missing. [error-room-id-param-not-provided]",
"errorType": "error-room-id-param-not-provided"
}Example 2
{
"success": false,
"error": "The required param \"updatedSince\" is missing. [error-updatedSince-param-invalid]",
"errorType": "error-updatedSince-param-invalid"
}Example 3
{
"success": false,
"error": "The \"updatedSince\" query parameter must be a valid date. [error-updatedSince-param-invalid]",
"errorType": "error-updatedSince-param-invalid"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?