List Calls

lists all the calls that are available in the app. It can include participants, recordings and transcriptions property in the response (if present).

GET /calls

List Calls

cURL

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

200

{
  "data": [
    {
      "sessionId": "v1.us.31780434a95d45.1692368168aefba73a1e5938ad7a02f8e61ea1c9a287a08aeb",
      "totalAudioMinutes": 0.31666666666666665,
      "totalVideoMinutes": 0,
      "totalDuration": "00:00:19",
      "hasRecording": false,
      "hasTranscription": true,
      "initiatedAt": 1692368168,
      "initiator": "cometchat-uid-1",
      "mode": "call",
      "receiver": "cometchat-guid-1",
      "receiverType": "group",
      "status": "ended",
      "totalDurationInMinutes": 0.31666666666666665,
      "totalParticipants": 2,
      "type": "audio",
      "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
      "startedAt": 1692368180,
      "endedAt": 1692368199,
      "participants": [
        {
          "uid": "cometchat-uid-2",
          "totalAudioMinutes": 0.31666666666666665,
          "totalVideoMinutes": 0,
          "isJoined": true,
          "state": "ended",
          "totalDuration": 0.31666666666666665,
          "deviceId": "[e-mail]/ucTKf4eq",
          "joinedAt": 1692368180,
          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
          "leftAt": 1692368199
        },
        {
          "uid": "cometchat-uid-1",
          "totalAudioMinutes": 0.2833333333333333,
          "totalVideoMinutes": 0,
          "isJoined": true,
          "state": "ended",
          "totalDuration": 0.2833333333333333,
          "deviceId": "[e-mail]/K-s6dB3N",
          "joinedAt": 1692368180,
          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
          "leftAt": 1692368197
        },
        {
          "uid": "cometchat-uid-4",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        },
        {
          "uid": "cometchat-uid-3",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        },
        {
          "uid": "cometchat-uid-5",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        }
      ],
      "transcriptions": [
        {
          "roomName": "v1.us.{appId}[e-mail]",
          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
          "tid": "c4b2f9e1-3d57-4e08-b6a9-1f2c7d5e8a34",
          "startTime": 1692368180,
          "endTime": 1692368199,
          "transcriptDate": "2023-08-18T14:16:20.000Z",
          "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:16:20.000Z_c4b2f9e1-3d57-4e08-b6a9-1f2c7d5e8a34.json"
        }
      ]
    },
    {
      "sessionId": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92",
      "totalAudioMinutes": 0.31666666666666665,
      "totalVideoMinutes": 0,
      "totalDuration": "00:00:19",
      "hasRecording": false,
      "hasTranscription": true,
      "initiatedAt": 1692368113,
      "initiator": "cometchat-uid-1",
      "mode": "call",
      "receiver": "cometchat-uid-2",
      "receiverType": "user",
      "status": "ended",
      "totalDurationInMinutes": 0.31666666666666665,
      "totalParticipants": 2,
      "type": "audio",
      "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
      "startedAt": 1692368127,
      "endedAt": 1692368146,
      "participants": [
        {
          "uid": "cometchat-uid-1",
          "totalAudioMinutes": 0.26666666666666666,
          "totalVideoMinutes": 0,
          "totalDuration": 0.26666666666666666,
          "deviceId": "[e-mail]/hsYWb5ul",
          "isJoined": true,
          "joinedAt": 1692368128,
          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
          "state": "ended",
          "leftAt": 1692368144
        },
        {
          "uid": "cometchat-uid-2",
          "totalAudioMinutes": 0.23333333333333334,
          "totalVideoMinutes": 0,
          "totalDuration": 0.23333333333333334,
          "deviceId": "[e-mail]/CKT3xgR4",
          "isJoined": true,
          "joinedAt": 1692368132,
          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
          "state": "ended",
          "leftAt": 1692368146
        }
      ],
      "transcriptions": [
        {
          "roomName": "v1.us.{appId}[e-mail]",
          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
          "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10",
          "startTime": 1692368127,
          "endTime": 1692368146,
          "transcriptDate": "2023-08-18T14:15:27.000Z",
          "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "total_pages": 1,
      "current_page": 1
    }
  }
}

Retrieve a paginated list of all calls in your application. Use query parameters to filter by call type, status, date range, and more.

The transcriptions array carries at most the 5 most recent transcriptions of each call. Use Get Call Transcriptions for the full, paginated list.

Common Use Cases

Use Case	Query Parameters
Get all video calls	type=video
Get ongoing calls	status=ongoing
Get calls with recordings	hasRecording=true
Get calls with transcriptions	hasTranscription=true
Get calls for a specific user	uid=user123
Get group calls only	receiverType=group
Get calls from a specific date	startedAt=1692368000

Example Request

curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls?type=video&status=ended&hasRecording=true" \
  -H "apikey: YOUR_REST_API_KEY"

Filtering Tips

• Combine multiple filters to narrow results (e.g., type=video&status=ended)
• Use startedAt and endedAt for date range queries (Unix timestamps)
• Filter by participantsCount to find calls with specific attendance
• Use uid to get all calls involving a specific user

Results are paginated. Check the meta.pagination object in the response for total count and page information.

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.

Query Parameters

type · enum<string>

It includes the type of the call, possible values: audio & video

Available options: audio, video

mode · enum<string>

It represents the mode of call, possible values: call, meet & presenter.

Available options: call, meet, presenter

participantsCount · integer

This query parameter allows you to filter the list of calls based on the number of participants involved in each call. For example, participantsCount=5 will return calls that had exactly 5 participants.

startedAt · integer

It represents when the call was started. It's 10 digit unix timestamp.

status · enum<string>

It indicates the status of the call. Possible values are unanswered, rejected, ongoing, ended.

Available options: rejected, ongoing, ended

receiverType · enum<string>

It indicates if it was 1-1 call of group call. Possible values: user & group.

Available options: user, group

endedAt · integer

It represents when the call was ended.

hasRecording · boolean

It's a boolean field indicating if the call has recording present or not.

hasTranscription · boolean

It's a boolean field indicating if the call has transcription present or not.

uid · string

It fetches only those calls in which the passed uid is a part of.

hideParticipants · boolean

Pass true to leave the participants array out of each call in the response. Only the exact value true omits it; any other value is ignored.

hideRecording · boolean

Pass true to leave the recordings array out of each call in the response. Only the exact value true omits it; any other value is ignored.

hideTranscription · boolean

Pass true to leave the transcriptions array out of each call in the response. Only the exact value true omits it; any other value is ignored.

Response

200 - application/json

Lists Calls

data · object[]

Show child attributes

meta · object

Show child attributes