get-channel-history.md

Get Channel History

Retrieves the history of a channel.

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

Query Parameters

This endpoint supports the Pagination parameters.

Key	Example Value	Description
roomId* or roomName*	ByehQjC44FwMeiLbX or general	The channel ID or name. You must enter at least one of these parameters.
latest	2016-09-30T13:42:25.304Z	The end of time range of messages to retrieve. The default value is the current date and time.
oldest	2016-05-30T13:42:25.304Z	The start of the time range of messages to retrieve
inclusive	true	Whether messages which land on the latest and oldest dates should be included. The default value is false.
unreads	false	Whether the number of unread messages should be included. The default value is false.
showThreadMessages	true	Whether thread messages should be included in the response.

Example Call

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

Example Response

{
  "messages": [
    {
      "_id": "AkzpHAvZpdnuchw2a",
      "rid": "ByehQjC44FwMeiLbX",
      "msg": "hi",
      "ts": "2016-12-09T12:50:51.555Z",
      "u": {
        "_id": "y65tAmHs93aDChMWu",
        "username": "testing"
      },
      "_updatedAt": "2016-12-09T12:50:51.562Z"
    },
    {
      "_id": "vkLMxcctR4MuTxreF",
      "t": "uj",
      "rid": "ByehQjC44FwMeiLbX",
      "ts": "2016-12-08T15:41:37.730Z",
      "msg": "testing2",
      "u": {
        "_id": "bRtgdhzM6PD9F8pSx",
        "username": "testing2"
      },
      "groupable": false,
      "_updatedAt": "2016-12-08T16:03:25.235Z"
    },
    {
      "_id": "bfRW658nEyEBg75rc",
      "t": "uj",
      "rid": "ByehQjC44FwMeiLbX",
      "ts": "2016-12-07T15:47:49.099Z",
      "msg": "testing",
      "u": {
        "_id": "nSYqWzZ4GsKTX4dyK",
        "username": "testing1"
      },
      "groupable": false,
      "_updatedAt": "2016-12-07T15:47:49.099Z"
    },
    {
      "_id": "pbuFiGadhRZTKouhB",
      "t": "uj",
      "rid": "ByehQjC44FwMeiLbX",
      "ts": "2016-12-06T17:57:38.635Z",
      "msg": "testing",
      "u": {
        "_id": "y65tAmHs93aDChMWu",
        "username": "testing"
      },
      "groupable": false,
      "_updatedAt": "2016-12-06T17:57:38.635Z"
    }
  ],
  "success": true
}

Change Log

Version	Description
0.75.0	Added offset property
0.47.0	Added