Get Channel History
- Print
- DarkLight
- PDF
Get Channel History
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/channels.history
Retrieves the history of a channel.
Changelog
| Version | Description |
|---|---|
| 0.75.0 | Added offset property |
| 0.47.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.
Exampledlpfuijw7ej
roomName
string
The room name. It is required if the roomId is not provided.
Examplegeneral
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}
count
integer
The number of items to return.
Example50
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
latest
string
The end of time range of messages to retrieve. The default value is the current date and time.
Example2016-09-30T13:42:25.304Z
oldest
string
The start of the time range of messages to retrieve
Example2016-05-30T13:42:25.304Z
inclusive
boolean
Whether messages which land on the latest and oldest dates should be included. The default value is false.
ExampleTrue
showThreadMessages
boolean
Whether thread messages should be included in the response
ExampleTrue
unreads
boolean
Whether the number of unread messages should be included. The default value is false.
ExampleFalse
Responses
200
OK
Example
{
"messages": [
{
"_id": "AkzpHAvZpdnuchw2a",
"rid": "ByehQjC44FwMeiLbX",
"msg": "hi",
"ts": "2016-12-09T12:50:51Z",
"u": {
"_id": "y65tAmHs93aDChMWu",
"username": "testing"
},
"_updatedAt": "2016-12-09T12:50:51Z"
},
{
"_id": "vkLMxcctR4MuTxreF",
"t": "uj",
"rid": "ByehQjC44FwMeiLbX",
"ts": "2016-12-08T03:41:37Z",
"msg": "testing2",
"u": {
"_id": "bRtgdhzM6PD9F8pSx",
"username": "testing2"
},
"groupable": false,
"_updatedAt": "2016-12-08T04:03:25Z"
},
{
"_id": "bfRW658nEyEBg75rc",
"t": "uj",
"rid": "ByehQjC44FwMeiLbX",
"ts": "2016-12-07T03:47:49Z",
"msg": "testing",
"u": {
"_id": "nSYqWzZ4GsKTX4dyK",
"username": "testing1"
},
"groupable": false,
"_updatedAt": "2016-12-07T03:47:49Z"
},
{
"_id": "pbuFiGadhRZTKouhB",
"t": "uj",
"rid": "ByehQjC44FwMeiLbX",
"ts": "2016-12-06T05:57:38Z",
"msg": "testing",
"u": {
"_id": "y65tAmHs93aDChMWu",
"username": "testing"
},
"groupable": false,
"_updatedAt": "2016-12-06T05:57:38Z"
}
],
"success": true
}object
files
Array of object
object
_id
string
name
string
size
integer
type
string
rid
string
userId
string
store
string
_updatedAt
string
identify
object
format
string
size
object
width
integer
height
integer
complete
boolean
etag
string
path
string
progress
integer
token
string
uploadedAt
string
uploading
boolean
url
string
typeGroup
string
user
object
_id
string
username
string
name
string
count
integer
offset
integer
total
integer
success
boolean
Was this article helpful?