Release Phone Number - API

Releases a phone number end-to-end. Uses :phoneNumberId (the UUID), not the e164.

Releasing a number:

• Detaches it from any inbound and outbound SIP gateways it was attached to.
• Removes it from any routing rules.
• For provider-purchased numbers (Twilio / Plivo, origin = PURCHASED), the number is also released at the provider and your billing is adjusted accordingly.

The call is idempotent from the caller's perspective and always returns 200 once the number is released.

Responses:

• 200 → { message, phoneNumberId, e164 }.
• 404 phone number not found.

HTTP method and endpoint

POST

|

https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumberId/release

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

Parameters

phoneNumberId

REQUIRED

UUID of the phone number to release. This is the phoneNumberId field, not the e164 string.

Response Parameters

message

Human-readable success message.

phoneNumberId

UUID of the released phone number.

e164

The released number in e164 format.

POST

|

https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumberId/release

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "POST",
	headers: {
		"Authorization": "$YOUR_TOKEN",
	},
};
const url= `https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumberId/release`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "message": "Phone number released successfully",
  "phoneNumberId": "pn_abc123",
  "e164": "+14155551234"
}