Get Thread Messages

Print
Dark
Light
PDF

Get Thread Messages

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/chat.getThreadMessages

Get thread messages.

Changelog

Version	Description
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

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

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 }

query

This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" }}

fields

string

This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }

tmid

stringRequired

The thread message ID.

Example7aDSXtjMA3KPLxLjt

Responses

200

Example 1

{
  "messages": [
    {
      "_id": "gcGai9bRREqokjyPc",
      "rid": "GENERAL",
      "msg": "Test",
      "ts": "2019-04-08T13:15:52.017Z",
      "u": {
        "_id": "p4a8YxvLQEHmiBKTS",
        "username": "marc.dev",
        "name": "Marc Dev"
      },
      "_updatedAt": "2019-04-08T14:40:27.789Z",
      "mentions": [],
      "channels": [],
      "replies": [
        "p4a8YxvLQEHmiBKTS"
      ],
      "tcount": 5,
      "tlm": "2019-04-08T14:40:27.724Z"
    },
    {
      "_id": "GfhiiJjcjKFyYMuMY",
      "rid": "GENERAL",
      "tmid": "gcGai9bRREqokjyPc",
      "msg": "This is a test!",
      "ts": "2019-04-08T13:20:22.238Z",
      "u": {
        "_id": "p4a8YxvLQEHmiBKTS",
        "username": "marc.dev",
        "name": "Marc Dev"
      },
      "_updatedAt": "2019-04-08T13:20:22.265Z",
      "mentions": [],
      "channels": []
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}

Expand All

object

messages

Array of object

object

_id

string

rid

string

msg

string

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

tmid

string

count

integer

offset

integer

total

integer

success

boolean

400

Bad Request

Example 1

{
  "success": false,
  "error": "The required \"tmid\" query param is missing. [error-invalid-params]",
  "errorType": "error-invalid-params"
}

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?

What's Next

Ignore User