Get Message Read Receipts
- Print
- DarkLight
- PDF
Get Message Read Receipts
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/chat.getMessageReadReceipts
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
messageId
stringRequired
The message id
ExampleByehQjC44FwMeiLbX
Responses
200
OK
Example 1
{
"receipts": [
{
"_id": "HksCYdTpCiM9DZ7Sa",
"roomId": "GENERAL",
"userId": "nvw6PBrXTejp4sfQt",
"messageId": "WyDsZzjk2wHogtWK2",
"ts": "2018-02-26T20:34:03.907Z",
"user": {
"username": "rocket.cat",
"name": "Rocket cat",
"_id": "nvw6PBrXTejp4sfQt"
}
}
],
"success": true
}object
receipts
Array of object
object
_id
string
roomId
string
userId
string
messageId
string
ts
string
user
object
username
string
name
string
_id
string
success
boolean
400
Bad Request
Example 1
{
"error": "The required 'messageId' param is missing.",
"success": false
}object
error
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?