List all reactions

List all reactions for a CometChat message by message ID with REST API to review emoji reactions and reacting users.

GET /messages/{id}/reactions

List all reactions

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions \
  --header 'apikey: <api-key>'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/reactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "1",
      "messageId": "2",
      "reaction": ":reaction",
      "uid": "superhero1",
      "reactedAt": 1700210335,
      "reactedBy": {
        "uid": "superhero1",
        "name": "Iron Man",
        "status": "offline",
        "role": "default",
        "createdAt": 1698934972
      }
    },
    {
      "id": "2",
      "messageId": "2",
      "reaction": "😅",
      "uid": "superhero1",
      "reactedAt": 1700210456,
      "reactedBy": {
        "uid": "superhero1",
        "name": "Iron Man",
        "status": "offline",
        "role": "default",
        "createdAt": 1698934972
      }
    },
    {
      "id": "5",
      "messageId": "2",
      "reaction": "😒",
      "uid": "superhero2",
      "reactedAt": 1700230866,
      "reactedBy": {
        "uid": "superhero2",
        "name": "Captain America",
        "status": "offline",
        "role": "default",
        "createdAt": 1698934987,
        "conversationId": "superhero1_user_superhero2"
      }
    }
  ],
  "meta": {
    "current": {
      "limit": 100,
      "count": 3
    },
    "next": {
      "affix": "append",
      "id": "5"
    }
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Headers

onBehalfOf · string

UID of the user on whose behalf the action is performed.

Path Parameters

id · string · required

Id of the message whose reactions are to be fetched.

Response

200 - application/json

List Reactions

data · object[]

Show child attributes

meta · object

Show child attributes