Get
/api/v1/channels.anonymousread
Fetch the messages in a public channel to an anonymous user. You must enable Accounts_AllowAnonymousRead setting in the workspace.
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Removed the fields and query parameters. |
| 1.2.0 | Added |
Query parameters
roomId
string
The room ID. It is required if the roomName is not provided.
Exampledlpfuijw7ej
roomName
string
The room name. It is required if the roomId is not provided.
Examplegeneral
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.
Responses
200
OK
Success
{
"messages": [
{
"_id": "xadufzmxzYQp4H9py",
"alias": "test",
"msg": "Example message",
"attachments": [],
"parseUrls": true,
"bot": {
"i": "MnQyfhWt5LqZotyfc"
},
"groupable": false,
"ts": "2018-10-05T01:10:47.524Z",
"u": {
"_id": "rocket.cat",
"username": "rocket.cat",
"name": "Rocket.Cat"
},
"rid": "GENERAL",
"_updatedAt": "2018-10-05T13:42:51.163Z",
"reactions": {
":grin:": {
"usernames": [
"marco.zoo"
]
}
},
"mentions": [],
"channels": [],
"starred": {
"_id": "KPkEYwKKBKZnEEPpt"
}
},
{
"_id": "id-1538701845987",
"rid": "GENERAL",
"msg": "This message was edited via API",
"alias": "Gruggy",
"emoji": ":smirk:",
"avatar": "http://res.guggy.com/logo_128.png",
"attachments": [
{
"collapsed": false,
"color": "#ff0000",
"text": "Yay for gruggy!",
"ts": "2016-12-09T16:53:06.761Z",
"message_link": "https://google.com",
"thumb_url": "http://res.guggy.com/logo_128.png",
"author_name": "Bradley Hilton",
"author_link": "https://rocket.chat/",
"author_icon": "https://avatars.githubusercontent.com/u/850391?v=3",
"title": "Attachment Example",
"title_link": "https://youtube.com",
"title_link_download": true,
"image_url": "http://res.guggy.com/logo_128.png",
"audio_url": "http://www.w3schools.com/tags/horse.mp3",
"video_url": "http://www.w3schools.com/tags/movie.mp4",
"fields": [
{
"short": true,
"title": "Test",
"value": "Testing out something or other"
},
{
"short": true,
"title": "Another Test",
"value": "Link something and this and that."
}
]
}
],
"ts": "2018-10-05T01:10:45.994Z",
"u": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test",
"name": "RocketChat Internal Admin Test"
},
"_updatedAt": "2018-10-05T01:10:47.064Z",
"editedBy": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test"
},
"editedAt": "2018-10-05T01:10:46.384Z",
"reactions": {
":smile:": {
"usernames": [
"rocketchat.internal.admin.test"
]
},
":squid:": {
"usernames": [
"rocketchat.internal.admin.test"
]
},
":bee:": {
"usernames": [
"rocketchat.internal.admin.test"
]
},
":ant:": {
"usernames": [
"rocketchat.internal.admin.test"
]
}
},
"mentions": [],
"channels": [],
"urls": []
}
],
"count": 2,
"offset": 0,
"total": 2,
"success": true
}object
messages
Array of object
object
_id
string
t
string
msg
string
groupable
boolean
blocks
Array of object
object
type
string
blockId
string
callId
string
appId
string
ts
string
u
object
_id
string
username
string
name
string
rid
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
attachments
Array of object (Attachment)
object
ts
string
Example1970-01-01T00:00:00.000Z
title
string
title_link
string
title_link_download
boolean
image_dimensions
object
width
integer
Example444
height
integer
Example360
image_preview
string
Example/9j/2wBDAAYEBQ...
image_url
string
Example/file-upload/PNTaE9SBQasdpAwk2/img_1.jpg
image_type
string
Exampleimage/jpeg
image_size
integer
Example26674
type
string
Examplefile
description
string
Example
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" or \"roomName\" param provided does not match any channel [error-room-not-found]",
"errorType": "error-room-not-found"
}object
success
boolean
error
string
errorType
string