GetAvailableReactions

[POST] .../v1/chat/getavailablereactions

Returns the final list of reactions available in the chat. Use this method before rendering a reaction picker for one chat so the client can combine chat-specific reaction settings with server defaults. The request body is required and chat_id must identify the chat; public filters metadata exposes chat_id as the real request filter field. The response returns available reaction codes with sort order and access is scoped to the current request user's visibility of the chat. Missing body, missing chat_id, inaccessible chat, invalid chat scope, reaction settings errors and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
chat_id string Chat UUID. Required filter field.

Request Example

{
  "filters": [
    {
      "field": "chat_id",
      "operator": "Equal",
      "value": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of ChatAvailableReaction Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "reaction": "like",
      "sort_order": 1
    },
    {
      "reaction": "heart",
      "sort_order": 2
    }
  ]
}