Skip to main content
GET
/
calls
/
{sessionId}
Get Call
curl --request GET \
  --url https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId} \
  --header 'apikey: <api-key>'
"{\n    \"data\": [\n        {\n            \"sessionId\": \"v1.eu.2574867aa2e6e417.17158459999d7fa95b1b4faea599f11eb5ecf07611b0b335c3\",\n            \"totalAudioMinutes\": 0,\n            \"totalVideoMinutes\": 0,\n            \"totalDuration\": \"00:00:00\",\n            \"hasRecording\": false,\n            \"initiatedAt\": 1715845999,\n            \"initiator\": \"cometchat-uid-1\",\n            \"mode\": \"call\",\n            \"receiver\": \"cometchat-uid-2\",\n            \"receiverType\": \"user\",\n            \"status\": \"initiated\",\n            \"totalDurationInMinutes\": 0,\n            \"totalParticipants\": 0,\n            \"type\": \"audio\",\n            \"participants\": [\n                {\n                    \"uid\": \"cometchat-uid-1\",\n                    \"totalAudioMinutes\": 0,\n                    \"totalVideoMinutes\": 0,\n                    \"isJoined\": false,\n                    \"totalDurationInMinutes\": 0,\n                    \"name\": \"Andrew Joseph\",\n                    \"avatar\": \"https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp\"\n                },\n                {\n                    \"uid\": \"cometchat-uid-2\",\n                    \"totalAudioMinutes\": 0,\n                    \"totalVideoMinutes\": 0,\n                    \"isJoined\": false,\n                    \"state\": \"unanswered\",\n                    \"totalDurationInMinutes\": 0,\n                    \"name\": \"George Alan\",\n                    \"avatar\": \"https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp\"\n                }\n            ],\n            \"data\": {\n                \"entities\": {\n                    \"initiator\": {\n                        \"entity\": {\n                            \"uid\": \"cometchat-uid-1\",\n                            \"name\": \"Andrew Joseph\",\n                            \"avatar\": \"https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp\"\n                        }\n                    },\n                    \"receiver\": {\n                        \"entity\": {\n                            \"uid\": \"cometchat-uid-2\",\n                            \"name\": \"George Alan\",\n                            \"avatar\": \"https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp\"\n                        }\n                    }\n                }\n            }\n        }\n    ]\n}"
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 information.

​
When to Use

ScenarioDescription
Call details pageDisplay comprehensive information about a completed call
Recording accessGet the recording URL for playback or download
Participant analyticsView individual participant metrics (join time, duration, etc.)
DebuggingInvestigate 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:
StateDescription
ongoingParticipant is currently in the call
endedParticipant left the call normally
unansweredParticipant didn’t answer the call
rejectedParticipant rejected the call

Authorizations

​
apikey
string
header
required

Headers

​
onBehalfOf
string

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

Path Parameters

​
sessionId
string
required

Call to Retrieve

Response

200

​
data
object[]