Fetch All Calls - API

Retrieves a paginated list of SIP calls associated with the authenticated user. Supports filters like room, session, call ID, gateway, rule, type, and search by sipCallTo or sipCallFrom.

HTTP method and endpoint

GET

|

https://api.videosdk.live/v2/sip/call

Headers Parameters

Authorization

REQUIRED

values : YOUR_TOKEN_WITHOUT_ANY_PREFIX

This will be a JWT token generate using VideoSDK ApiKey and Secret.

Note that the token will not include any prefix such as "Basic " or "Bearer ". Just pass a token as value.

You can generate a new token by refering this Guide: Generate Auth token

Query Parameters

roomId

OPTIONAL

Filter calls by specific room ID.

sessionId

OPTIONAL

Filter calls by session ID.

id

OPTIONAL

Filter calls by unique call ID.

gatewayId

OPTIONAL

Filter calls by SIP Gateway ID.

ruleId

OPTIONAL

Filter calls by Routing Rule ID.

type

OPTIONAL

Filter by call type (e.g., outbound, inbound).

search

OPTIONAL

Search by sipCallTo or sipCallFrom (case-insensitive).

startDate

OPTIONAL

Filter calls created on or after this date (timestamp in ms).

endDate

OPTIONAL

Filter calls created on or before this date (timestamp in ms). Entire end day is included.

page

OPTIONAL

Page number for pagination. Defaults to 1.

perPage

OPTIONAL

Number of items per page. Defaults to 10.

Response Parameters

statusCode

HTTP status code (200 on success).

pageInfo.currentPage

Current page number.

pageInfo.perPage

Number of records per page.

pageInfo.lastPage

Last available page number.

pageInfo.total

Total number of calls matching filters.

data[].callId

Unique ID of the call.

data[].type

Call type (inbound or outbound).

data[].gatewayId

Gateway ID associated with the call.

data[].gatewayName

Name of the associated gateway.

data[].ruleId

Routing Rule ID associated with the call.

data[].ruleName

Name of the associated routing rule.

data[].roomId

Room ID linked to the call.

data[].to

Destination number (sipCallTo).

data[].from

Source number (sipCallFrom).

data[].status

Current status of the call.

data[].timelog

Array of status change logs with timestamps.

data[].start

Start timestamp of the call.

data[].end

End timestamp of the call.

GET

|

https://api.videosdk.live/v2/sip/call

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "GET",
	headers: {
		"Authorization": "$YOUR_TOKEN",
	},
};
const url= `https://api.videosdk.live/v2/sip/call?roomId=room_123456&sessionId=sess_123456&id=call_123456789&gatewayId=gw_123456789&ruleId=rule_123456&type=outbound&search=+1415&startDate=1755820800000&endDate=1755907199999&page=1&perPage=10`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "statusCode": 200,
  "pageInfo": {
    "currentPage": 1,
    "perPage": 10,
    "lastPage": 5,
    "total": 45
  },
  "data": [
    {
      "_id": "64f89a7c1a23b4",
      "callId": "call_123456789",
      "type": "outbound",
      "gatewayId": "gw_123456789",
      "gatewayName": "US Gateway",
      "ruleId": "rule_123456",
      "ruleName": "Default Routing Rule",
      "roomId": "room_123456",
      "to": "+14155550123",
      "from": "+14155559876",
      "status": "COMPLETED",
      "timelog": [
        {
          "status": "INITIATED",
          "timestamp": "2025-08-21T11:45:00.000Z"
        },
        {
          "status": "COMPLETED",
          "timestamp": "2025-08-21T11:48:00.000Z"
        }
      ],
      "start": "2025-08-21T11:45:00.000Z",
      "end": "2025-08-21T11:48:00.000Z",
      "sessionId": "sess_123456",
      "userId": "usr_123456",
      "deleted": false
    }
  ]
}