Call Transfer - API

API to transfer the call to another telephone number or SIP address.

HTTP method and endpoint

POST

|

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

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

Content-Type

REQUIRED

values : application/json

This is usefull for json body parameters, so that VideoSDK servers can understand that the incoming body parameter will be a JSON string.

Body Parameters

callId

REQUIRED

ID of the call which has to be transfered.

transferTo

REQUIRED

The destination phone number (E.164 format) or SIP endpoint

Response Parameters

message

Confirmation message about the call status.

data.callId

Unique ID of the call.

data.status

Current status of the call (e.g., INITIATED).

data.roomId

Room ID associated with the call.

data.sipCallTo

Destination number of the call.

data.sipCallFrom

Source number of the call.

data.gatewayId

Gateway ID used for the call.

data.metadata

Custom metadata associated with the call.

data.timelog

Array of status change logs with timestamps.

POST

|

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

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "POST",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
	body: JSON.stringify({
		"callId" : "712350ce-8fff-464d-b427-587bfb66636a",
		"transferTo" : "+14155550123"
	}),
};
const url= `https://api.videosdk.live/v2/sip/call/transfer`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "message": "Call initiated successfully",
  "data": {
    "callId": "call_123456789",
    "status": "answered",
    "roomId": "room_123456",
    "sipCallTo": "+14155550123",
    "sipCallFrom": "+14155559876",
    "gatewayId": "gw_123456789",
    "metadata": {
      "campaignId": "cmp_123",
      "source": "crm"
    },
    "timelog": [
      {
        "status": "INITIATED",
        "timestamp": "2025-08-21T11:45:00.000Z"
      }
    ]
  }
}