glb_adm
01acfa3b40
Type checking / changes (push) Has been cancelled
Type checking / test (push) Has been cancelled
Type checking / typescript-summary (push) Has been cancelled
Node tests / changes (push) Has been cancelled
Node tests / test (push) Has been cancelled
Node tests / test-summary (push) Has been cancelled
Источник: https://github.com/nextcloud/spreed/archive/refs/tags/v22.0.12.tar.gz С этого коммита ветка официального Nextcloud Talk отрезана (решение владельца 2026-07-06). Все дальнейшие изменения — только наши; версии релизов: 22.0.12-f7.N.
89 lines
3.4 KiB
Markdown
89 lines
3.4 KiB
Markdown
# Reaction API
|
|
|
|
Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 24
|
|
|
|
## React to a message
|
|
|
|
* Required capability: `reactions`
|
|
* Federation capability: `federation-v1`
|
|
* Method: `POST`
|
|
* Endpoint: `/reaction/{token}/{messageId}`
|
|
* Data:
|
|
|
|
| field | type | Description |
|
|
|------------|--------|--------------------|
|
|
| `reaction` | string | the reaction emoji |
|
|
|
|
* Response:
|
|
- Status code:
|
|
+ `200 OK` Reaction already exists
|
|
+ `201 Created` User reacted with a new reaction
|
|
+ `400 Bad Request` In case of no reaction support, message out of reactions context or any other error
|
|
+ `404 Not Found` When the conversation or message to react could not be found for the participant
|
|
|
|
- Data:
|
|
Array with data of reactions:
|
|
|
|
| field | type | Description |
|
|
|--------------------|--------|----------------------------------------|
|
|
| `actorType` | string | `guests` or `users` |
|
|
| `actorId` | string | Actor id of the reacting participant |
|
|
| `actorDisplayName` | string | Display name of the reaction author |
|
|
| `timestamp` | int | Timestamp in seconds and UTC time zone |
|
|
|
|
## Delete a reaction
|
|
|
|
* Required capability: `reactions`
|
|
* Federation capability: `federation-v1`
|
|
* Method: `DELETE`
|
|
* Endpoint: `/reaction/{token}/{messageId}`
|
|
* Data:
|
|
|
|
| field | type | Description |
|
|
|------------|--------|--------------------|
|
|
| `reaction` | string | the reaction emoji |
|
|
|
|
* Response:
|
|
- Status code:
|
|
+ `201 Created`
|
|
+ `400 Bad Request` In case of no reaction support, message out of reactions context or any other error
|
|
+ `404 Not Found` When the conversation or message to react or reaction could not be found for the participant
|
|
|
|
- Data:
|
|
Array with data of reactions:
|
|
|
|
| field | type | Description |
|
|
|--------------------|--------|----------------------------------------|
|
|
| `actorType` | string | `guests` or `users` |
|
|
| `actorId` | string | Actor id of the reacting participant |
|
|
| `actorDisplayName` | string | Display name of the reaction author |
|
|
| `timestamp` | int | Timestamp in seconds and UTC time zone |
|
|
|
|
## Retrieve reactions of a message by type
|
|
|
|
* Required capability: `reactions`
|
|
* Federation capability: `federation-v1`
|
|
* Method: `GET`
|
|
* Endpoint: `/reaction/{token}/{messageId}`
|
|
* Data:
|
|
|
|
| field | type | Description |
|
|
|------------|--------|----------------------------------|
|
|
| `reaction` | string | **Optional:** the reaction emoji |
|
|
|
|
* Response:
|
|
- Status code:
|
|
+ `200 OK`
|
|
+ `400 Bad Request` In case of no reaction support, message out of reactions context or any other error
|
|
+ `404 Not Found` When the conversation or message to react could not be found for the participant
|
|
|
|
- Data:
|
|
Array with data of reactions:
|
|
|
|
| field | type | Description |
|
|
|--------------------|--------|----------------------------------------|
|
|
| `actorType` | string | `guests` or `users` |
|
|
| `actorId` | string | Actor id of the reacting participant |
|
|
| `actorDisplayName` | string | Display name of the reaction author |
|
|
| `timestamp` | int | Timestamp in seconds and UTC time zone |
|