List User Messages

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

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

fetch('https://{appId}.api-{region}.cometchat.io/v3/users/{uid}/messages', 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/users/{uid}/messages",
  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/users/{uid}/messages"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "1776",
      "conversationId": "cometchat-uid-2_user_cometchat-uid-3",
      "sender": "cometchat-uid-2",
      "receiverType": "user",
      "receiver": "cometchat-uid-3",
      "category": "call",
      "type": "audio",
      "data": {
        "action": "initiated",
        "entities": {
          "by": {
            "entity": {
              "uid": "cometchat-uid-2",
              "name": "George Alan",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
              "status": "offline"
            },
            "entityType": "user"
          },
          "on": {
            "entity": {
              "data": {
                "entities": {
                  "sender": {
                    "entity": {
                      "uid": "cometchat-uid-2",
                      "name": "George Alan",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
                      "status": "offline"
                    },
                    "entityType": "user"
                  },
                  "receiver": {
                    "entity": {
                      "uid": "cometchat-uid-3",
                      "name": "Nancy Grace",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
                      "status": "offline",
                      "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
                    },
                    "entityType": "user"
                  }
                },
                "metadata": {
                  "key": {
                    "one": "two"
                  }
                }
              },
              "type": "audio",
              "sender": "cometchat-uid-2",
              "status": "initiated",
              "joinedAt": 1646995097,
              "receiver": "cometchat-uid-3",
              "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba",
              "wsChannel": {
                "secret": "083c2a7f660150e42c2bf07a17231e90980b290d",
                "service": "19757e59e8b9669.call",
                "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba"
              },
              "initiatedAt": 1646995097,
              "receiverType": "user",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "call"
          },
          "for": {
            "entity": {
              "uid": "cometchat-uid-3",
              "name": "Nancy Grace",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
              "status": "offline",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "user"
          }
        }
      },
      "sentAt": 1646995097,
      "updatedAt": 1646995097
    },
    {
      "id": "1777",
      "conversationId": "cometchat-uid-2_user_cometchat-uid-3",
      "sender": "cometchat-uid-3",
      "receiverType": "user",
      "receiver": "cometchat-uid-2",
      "category": "call",
      "type": "video",
      "data": {
        "action": "ongoing",
        "entities": {
          "by": {
            "entity": {
              "uid": "cometchat-uid-3",
              "name": "Nancy Grace",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
              "status": "offline"
            },
            "entityType": "user"
          },
          "on": {
            "entity": {
              "data": {
                "entities": {
                  "sender": {
                    "entity": {
                      "uid": "cometchat-uid-2",
                      "name": "George Alan",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
                      "status": "offline"
                    },
                    "entityType": "user"
                  },
                  "receiver": {
                    "entity": {
                      "uid": "cometchat-uid-3",
                      "name": "Nancy Grace",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
                      "status": "offline",
                      "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
                    },
                    "entityType": "user"
                  }
                },
                "metadata": {
                  "key": {
                    "one": "two"
                  }
                }
              },
              "type": "video",
              "sender": "cometchat-uid-2",
              "status": "ongoing",
              "joinedAt": 1646995512,
              "receiver": "cometchat-uid-3",
              "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba",
              "startedAt": 1646995512,
              "wsChannel": {
                "secret": "083c2a7f660150e42c2bf07a17231e90980b290d",
                "service": "19757e59e8b9669.call",
                "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba"
              },
              "initiatedAt": 1646995097,
              "receiverType": "user",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "call"
          },
          "for": {
            "entity": {
              "uid": "cometchat-uid-2",
              "name": "George Alan",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
              "status": "offline",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "user"
          }
        }
      },
      "sentAt": 1646995512,
      "updatedAt": 1646995512
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 2,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    },
    "cursor": {
      "id": 1786,
      "affix": "prepend"
    }
  }
}

GET

users

{uid}

messages

List User Messages

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

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

fetch('https://{appId}.api-{region}.cometchat.io/v3/users/{uid}/messages', 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/users/{uid}/messages",
  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/users/{uid}/messages"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "1776",
      "conversationId": "cometchat-uid-2_user_cometchat-uid-3",
      "sender": "cometchat-uid-2",
      "receiverType": "user",
      "receiver": "cometchat-uid-3",
      "category": "call",
      "type": "audio",
      "data": {
        "action": "initiated",
        "entities": {
          "by": {
            "entity": {
              "uid": "cometchat-uid-2",
              "name": "George Alan",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
              "status": "offline"
            },
            "entityType": "user"
          },
          "on": {
            "entity": {
              "data": {
                "entities": {
                  "sender": {
                    "entity": {
                      "uid": "cometchat-uid-2",
                      "name": "George Alan",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
                      "status": "offline"
                    },
                    "entityType": "user"
                  },
                  "receiver": {
                    "entity": {
                      "uid": "cometchat-uid-3",
                      "name": "Nancy Grace",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
                      "status": "offline",
                      "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
                    },
                    "entityType": "user"
                  }
                },
                "metadata": {
                  "key": {
                    "one": "two"
                  }
                }
              },
              "type": "audio",
              "sender": "cometchat-uid-2",
              "status": "initiated",
              "joinedAt": 1646995097,
              "receiver": "cometchat-uid-3",
              "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba",
              "wsChannel": {
                "secret": "083c2a7f660150e42c2bf07a17231e90980b290d",
                "service": "19757e59e8b9669.call",
                "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba"
              },
              "initiatedAt": 1646995097,
              "receiverType": "user",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "call"
          },
          "for": {
            "entity": {
              "uid": "cometchat-uid-3",
              "name": "Nancy Grace",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
              "status": "offline",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "user"
          }
        }
      },
      "sentAt": 1646995097,
      "updatedAt": 1646995097
    },
    {
      "id": "1777",
      "conversationId": "cometchat-uid-2_user_cometchat-uid-3",
      "sender": "cometchat-uid-3",
      "receiverType": "user",
      "receiver": "cometchat-uid-2",
      "category": "call",
      "type": "video",
      "data": {
        "action": "ongoing",
        "entities": {
          "by": {
            "entity": {
              "uid": "cometchat-uid-3",
              "name": "Nancy Grace",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
              "status": "offline"
            },
            "entityType": "user"
          },
          "on": {
            "entity": {
              "data": {
                "entities": {
                  "sender": {
                    "entity": {
                      "uid": "cometchat-uid-2",
                      "name": "George Alan",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
                      "status": "offline"
                    },
                    "entityType": "user"
                  },
                  "receiver": {
                    "entity": {
                      "uid": "cometchat-uid-3",
                      "name": "Nancy Grace",
                      "role": "default",
                      "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
                      "status": "offline",
                      "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
                    },
                    "entityType": "user"
                  }
                },
                "metadata": {
                  "key": {
                    "one": "two"
                  }
                }
              },
              "type": "video",
              "sender": "cometchat-uid-2",
              "status": "ongoing",
              "joinedAt": 1646995512,
              "receiver": "cometchat-uid-3",
              "sessionid": "16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba",
              "startedAt": 1646995512,
              "wsChannel": {
                "secret": "083c2a7f660150e42c2bf07a17231e90980b290d",
                "service": "19757e59e8b9669.call",
                "identity": "[19757e59e8b9669]16469950973f7f6a1ea6d5166db11c929cdbde6a61902e10ba"
              },
              "initiatedAt": 1646995097,
              "receiverType": "user",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "call"
          },
          "for": {
            "entity": {
              "uid": "cometchat-uid-2",
              "name": "George Alan",
              "role": "default",
              "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp",
              "status": "offline",
              "conversationId": "cometchat-uid-2_user_cometchat-uid-3"
            },
            "entityType": "user"
          }
        }
      },
      "sentAt": 1646995512,
      "updatedAt": 1646995512
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 2,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    },
    "cursor": {
      "id": 1786,
      "affix": "prepend"
    }
  }
}

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

uid

string

required

An UID of a user.

Query Parameters

searchKey

string

searches for occurence of message.

hasAttachments

boolean

Fetches messages that include attachments.

attachmentTypes

enum<string>

Displays messages according to the type of attachment. Supported types include: image, video, audio, and file.

Available options:

image,

video,

audio,

file

hasMentions

boolean

Fetches messages that include mentions.

hasLinks

boolean

Fetches messages that include links.

mentionedUids

boolean

Fetches messages that include the mentioned comma-separated UIDs.

unread

boolean

displays all the unread messages of the user.

undelivered

boolean

displays all the messages those are undelivered.

count

boolean

displays the count of messages as per group/user

hideReplies

boolean

Shows only messages skipping the replies in the message thread.

affix

enum<string>

Determines whether to pull the messages either before or after any message id. Possible values are append(after) and prepend(before).

Available options:

append,

prepend

string

Retrieves all those messages after the passed id.

Response

200 - application/json

Get User Messages

data

any[]

Chat APIs

Management APIs (Multi-Tenancy)

List User Messages

Authorizations

Headers

Path Parameters

Query Parameters

Response