Get Call - CometChat Docs

Get Call

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

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

fetch('https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}', 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}.call-{region}.cometchat.io/v3/calls/{sessionId}",
  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}.call-{region}.cometchat.io/v3/calls/{sessionId}"

	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}.call-{region}.cometchat.io/v3/calls/{sessionId}")

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": {
    "sessionId": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92",
    "totalAudioMinutes": 0.31666666666666665,
    "totalVideoMinutes": 0,
    "totalDuration": "00:00:19",
    "metaData": [],
    "hasRecording": false,
    "hasTranscription": true,
    "initiatedAt": 1692368113,
    "initiator": "cometchat-uid-1",
    "mode": "call",
    "receiver": "cometchat-uid-2",
    "receiverType": "user",
    "status": "ended",
    "tags": [],
    "totalDurationInMinutes": 0.31666666666666665,
    "totalParticipants": 2,
    "type": "audio",
    "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
    "startedAt": 1692368127,
    "endedAt": 1692368146,
    "participants": [
      {
        "uid": "cometchat-uid-2",
        "totalAudioMinutes": 0.23333333333333334,
        "totalVideoMinutes": 0,
        "totalDuration": 0.23333333333333334,
        "deviceId": "c9ed493e-8495-428d-b6ee-b32019cc57ce@rtc.cometchat.io/CKT3xgR4",
        "isJoined": true,
        "joinedAt": 1692368132,
        "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
        "state": "ended",
        "leftAt": 1692368146
      },
      {
        "uid": "cometchat-uid-1",
        "totalAudioMinutes": 0.26666666666666666,
        "totalVideoMinutes": 0,
        "totalDuration": 0.26666666666666666,
        "deviceId": "70ecae89-b71c-4bb3-8220-b7c99ec1658f@rtc.cometchat.io/hsYWb5ul",
        "isJoined": true,
        "joinedAt": 1692368128,
        "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
        "state": "ended",
        "leftAt": 1692368144
      }
    ],
    "transcriptions": [
      {
        "roomName": "v1.us.{appId}.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat.io",
        "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"
      }
    ]
  }
}

GET

calls

{sessionId}

Get Call

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

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

fetch('https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}', 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}.call-{region}.cometchat.io/v3/calls/{sessionId}",
  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}.call-{region}.cometchat.io/v3/calls/{sessionId}"

	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}.call-{region}.cometchat.io/v3/calls/{sessionId}")

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": {
    "sessionId": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92",
    "totalAudioMinutes": 0.31666666666666665,
    "totalVideoMinutes": 0,
    "totalDuration": "00:00:19",
    "metaData": [],
    "hasRecording": false,
    "hasTranscription": true,
    "initiatedAt": 1692368113,
    "initiator": "cometchat-uid-1",
    "mode": "call",
    "receiver": "cometchat-uid-2",
    "receiverType": "user",
    "status": "ended",
    "tags": [],
    "totalDurationInMinutes": 0.31666666666666665,
    "totalParticipants": 2,
    "type": "audio",
    "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
    "startedAt": 1692368127,
    "endedAt": 1692368146,
    "participants": [
      {
        "uid": "cometchat-uid-2",
        "totalAudioMinutes": 0.23333333333333334,
        "totalVideoMinutes": 0,
        "totalDuration": 0.23333333333333334,
        "deviceId": "c9ed493e-8495-428d-b6ee-b32019cc57ce@rtc.cometchat.io/CKT3xgR4",
        "isJoined": true,
        "joinedAt": 1692368132,
        "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
        "state": "ended",
        "leftAt": 1692368146
      },
      {
        "uid": "cometchat-uid-1",
        "totalAudioMinutes": 0.26666666666666666,
        "totalVideoMinutes": 0,
        "totalDuration": 0.26666666666666666,
        "deviceId": "70ecae89-b71c-4bb3-8220-b7c99ec1658f@rtc.cometchat.io/hsYWb5ul",
        "isJoined": true,
        "joinedAt": 1692368128,
        "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
        "state": "ended",
        "leftAt": 1692368144
      }
    ],
    "transcriptions": [
      {
        "roomName": "v1.us.{appId}.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat.io",
        "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"
      }
    ]
  }
}

Retrieve detailed information about a specific call using its session ID. This endpoint returns complete call data including all participants, their individual metrics, and recording and transcription information. The transcriptions array carries at most the 5 most recent transcriptions of the call. Use Get Call Transcriptions for the full, paginated list.

When to Use

Scenario	Description
Call details page	Display comprehensive information about a completed call
Recording access	Get the recording URL for playback or download
Participant analytics	View individual participant metrics (join time, duration, etc.)
Debugging	Investigate issues with a specific call session

Example Request

curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls/v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92" \
  -H "apikey: YOUR_REST_API_KEY"

Response Details

The response includes:

Call metadata: Type, mode, status, duration, timestamps
Participants array: Each participant’s UID, device ID, join/leave times, and individual audio/video minutes
Recordings array: Recording IDs, URLs, duration, and timestamps (if hasRecording is true)

The sessionId is returned when a call is initiated via the SDK or can be found in the List Calls response.

Participant States

Each participant in the response has a state field:

State	Description
`ongoing`	Participant is currently in the call
`ended`	Participant left the call normally
`unanswered`	Participant didn’t answer the call
`rejected`	Participant rejected the call

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

sessionId

string

required

Call to Retreive

Query Parameters

hideParticipants

boolean

Pass true to leave the participants array out of 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 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 the response. Only the exact value true omits it; any other value is ignored.

Response

200 - application/json

Rereives Call Details

data

object

Response data

Show child attributes

​When to Use

​Example Request

​Response Details

​Participant States

Authorizations

Headers

Path Parameters

Query Parameters

Response

When to Use

Example Request

Response Details

Participant States