Get Deleted Messages

Prev Next
Get
/api/v1/chat.getDeletedMessages

Get deleted messages from a specific date.

Changelog

Version Description
0.73.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. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

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.

since
stringRequired

A valid ISO date format from which you want to search the deleted messages.

Example2018-12-12T00:11:22.345Z
roomId
stringRequired

The room ID.

Example6GFJ3tbmHiyHbahmC
Responses
200

OK

Example 1
{
  "messages": [
    {
      "_id": "wKBW2YwrPahpag4zA"
    },
    {
      "_id": "SJXYBbageAo8bo7rX"
    },
    {
      "_id": "jEnjsxuoDJamGjbH2"
    }
  ],
  "count": 3,
  "offset": 0,
  "total": 3,
  "success": true
}
Expand All
object
messages
Array of object
object
_id
string
count
integer
offset
integer
total
integer
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "[The required \"roomId\" query param is missing.]",
  "errorType": "The required \"roomId\" query param is missing."
}
Example 2
{
  "success": false,
  "error": "[The required \"since\" query param is missing.]",
  "errorType": "The required \"since\" query param is missing."
}
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