Get
/api/v1/chat.getDiscussions
Gets the discussions in a room.
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Returns 403 with errorType: error-forbidden instead of 400 when the request is refused. |
| 2.4.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
stringRequired
The room ID.
Example6GFJ3tbmHiyHbahmC
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
Example50
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 }. Refer to the official documentation to learn more.
text
string
Filter the thread list by search term.
Responses
200
OK
Example 1
{
"messages": [
{
"_id": "652dc4dda2f73c7460e18df8",
"t": "discussion-created",
"rid": "6GFJ3tbmHiyHbahmC",
"ts": "2023-10-16T23:18:53.926Z",
"msg": "test discuss",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"groupable": false,
"drid": "652dc4dda2f73c7460e18df6",
"_updatedAt": "2023-10-16T23:19:18.992Z",
"dcount": 2,
"dlm": "2023-10-16T23:19:18.748Z"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
messages
Array of object
object
_id
string
t
string
rid
string
ts
string
msg
string
u
object
_id
string
username
string
name
string
groupable
boolean
drid
string
_updatedAt
string
dcount
integer
dlm
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" query param is missing. [error-invalid-params]",
"errorType": "error-invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"success": false,
"error": "You must be logged in to do this."
}object
success
boolean
error
string
403
Forbidden
Incorrect room ID
{
"success": false,
"error": "error-not-allowed",
"errorType": "error-forbidden"
}object
success
boolean
error
string
errorType
string