Skip to content
This repository was archived by the owner on Mar 17, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@
- pinMessage
- postMessage
- react
- reportMessage
- search
- starMessage
- sendMessage
Expand Down
1 change: 1 addition & 0 deletions contributing/documentation/documentation-map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ Here you can also find what articles are incomplete and missing.
- pinMessage
- postMessage
- react
- reportMessage
- search
- starMessage
- sendMessage
Expand Down
1 change: 1 addition & 0 deletions developer-guides/rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](chat/pinmessage/) |
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](chat/postmessage/) |
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](chat/react/) |
| `/api/v1/chat.reportMessage` | Reports a message. | [Link](chat/reportmessage/) |
| `/api/v1/chat.search` | Search for messages in a channel. | [Link](chat/search/) |
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](chat/starmessage/) |
| `/api/v1/chat.sendMessage` | Send new chat message. | [Link](chat/sendmessage/) |
Expand Down
1 change: 1 addition & 0 deletions developer-guides/rest-api/chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](pinmessage/) |
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](postmessage/) |
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](react/) |
| `/api/v1/chat.reportMessage` | Reports a message. | [Link](reportmessage/) |
| `/api/v1/chat.search` | Search for messages in a channel. | [Link](search/) |
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](starmessage/) |
| `/api/v1/chat.sendMessage` | Send new chat message. | [Link](sendmessage/) |
Expand Down
38 changes: 38 additions & 0 deletions developer-guides/rest-api/chat/reportmessage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Chat Report Message

Reports a message.

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `/api/v1/chat.reportMessage` | `yes` | `POST` |

## Payload

| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `messageId` | `7aDSXtjMA3KPLxLjt` | Required | The message id to report. |
| `description` | `test` | Required | The description of report. |

## Example Call

```bash
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type:application/json" \
http://localhost:3000/api/v1/chat.reportMessage \
-d '{ "messageId": "7aDSXtjMA3KPLxLjt", "description": "test" }'
```

## Example Result

```json
{
"success": true
}
```

## Change Log

| Version | Description |
| :--- | :--- |
| 0.64.0 | Added |