GET
/
calls
List Calls
curl --request GET \
  --url https://{appid}.call-{region}.cometchat.io/v3/calls \
  --header 'apikey: <api-key>'
{
  "data": [
    {
      "sessionId": "v1.us.31780434a95d45.1692368168aefba73a1e5938ad7a02f8e61ea1c9a287a08aeb",
      "totalAudioMinutes": 0.31666666666666665,
      "totalVideoMinutes": 0,
      "totalDuration": "00:00:19",
      "hasRecording": false,
      "initiatedAt": 1692368168,
      "initiator": "superhero8",
      "mode": "call",
      "receiver": "sivamathewstestgroup",
      "receiverType": "group",
      "status": "ended",
      "totalDurationInMinutes": 0.31666666666666665,
      "totalParticipants": 2,
      "type": "audio",
      "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
      "startedAt": 1692368180,
      "endedAt": 1692368199,
      "participants": [
        {
          "uid": "superhero2",
          "totalAudioMinutes": 0.31666666666666665,
          "totalVideoMinutes": 0,
          "isJoined": true,
          "state": "ended",
          "totalDuration": 0.31666666666666665,
          "deviceId": "b7683aaf-090a-4204-8f84-7ddd652923aa@rtc.cometchat-staging.com/ucTKf4eq",
          "joinedAt": 1692368180,
          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
          "leftAt": 1692368199
        },
        {
          "uid": "superhero8",
          "totalAudioMinutes": 0.2833333333333333,
          "totalVideoMinutes": 0,
          "isJoined": true,
          "state": "ended",
          "totalDuration": 0.2833333333333333,
          "deviceId": "f55d46e5-2b1c-4b02-9072-382209a8753f@rtc.cometchat-staging.com/K-s6dB3N",
          "joinedAt": 1692368180,
          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
          "leftAt": 1692368197
        },
        {
          "uid": "superhero4",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        },
        {
          "uid": "superhero7",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        },
        {
          "uid": "superhero6",
          "totalAudioMinutes": 0,
          "totalVideoMinutes": 0,
          "isJoined": false,
          "state": "unanswered",
          "totalDuration": 0
        }
      ]
    },
    {
      "sessionId": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92",
      "totalAudioMinutes": 0.31666666666666665,
      "totalVideoMinutes": 0,
      "totalDuration": "00:00:19",
      "hasRecording": false,
      "initiatedAt": 1692368113,
      "initiator": "superhero8",
      "mode": "call",
      "receiver": "superhero2",
      "receiverType": "user",
      "status": "ended",
      "totalDurationInMinutes": 0.31666666666666665,
      "totalParticipants": 2,
      "type": "audio",
      "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
      "startedAt": 1692368127,
      "endedAt": 1692368146,
      "participants": [
        {
          "uid": "superhero8",
          "totalAudioMinutes": 0.26666666666666666,
          "totalVideoMinutes": 0,
          "totalDuration": 0.26666666666666666,
          "deviceId": "70ecae89-b71c-4bb3-8220-b7c99ec1658f@rtc.cometchat-staging.com/hsYWb5ul",
          "isJoined": true,
          "joinedAt": 1692368128,
          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
          "state": "ended",
          "leftAt": 1692368144
        },
        {
          "uid": "superhero2",
          "totalAudioMinutes": 0.23333333333333334,
          "totalVideoMinutes": 0,
          "totalDuration": 0.23333333333333334,
          "deviceId": "c9ed493e-8495-428d-b6ee-b32019cc57ce@rtc.cometchat-staging.com/CKT3xgR4",
          "isJoined": true,
          "joinedAt": 1692368132,
          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
          "state": "ended",
          "leftAt": 1692368146
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "total_pages": 1,
      "current_page": 1
    }
  }
}

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.

​
uid
string

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

Response

200 - application/json

Lists Calls

The response is of type object.