Update Inbound SIP Gateway - API

Updates an existing inbound SIP gateway for the authenticated user using its gatewayId. Supports partial updates — only the provided fields will be updated.

HTTP method and endpoint

PATCH

|

https://api.videosdk.live/v2/sip/inbound-gateways/:gatewayId

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.

Parameters

gatewayId

REQUIRED

Unique identifier of the inbound SIP gateway to update.

Body Parameters

name

OPTIONAL

Updated name of the inbound SIP gateway.

numbers

OPTIONAL

Updated array of phone numbers for the gateway.

auth

OPTIONAL

Updated authentication config for the gateway.

allowedAddresses

OPTIONAL

Updated list of SIP addresses allowed to connect.

allowedNumbers

OPTIONAL

Updated list of phone numbers allowed to connect.

mediaEncryption

OPTIONAL

Updated media encryption setting (disable, enable).

record

OPTIONAL

Whether to record calls (true/false).

noiseCancellation

OPTIONAL

Whether to enable noise cancellation.

metadata

OPTIONAL

Custom metadata for the gateway.

tags

OPTIONAL

Updated tags for the gateway.

Response Parameters

id

Unique identifier for the inbound SIP gateway.

name

Updated name of the SIP gateway.

address

SIP address/domain of the gateway.

numbers

Array of updated phone numbers associated with the gateway.

allowedAddresses

Updated array of allowed SIP addresses.

allowedNumbers

Updated array of allowed phone numbers.

mediaEncryption

Updated media encryption setting.

record

Indicates if call recording is enabled.

noiseCancellation

Indicates if noise cancellation is enabled.

tags

Updated tags associated with the gateway.

auth

Updated authentication config.

geoRegion

Geographical region (if configured).

metadata

Updated custom metadata.

PATCH

|

https://api.videosdk.live/v2/sip/inbound-gateways/:gatewayId

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "PATCH",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
};
const url= `https://api.videosdk.live/v2/sip/inbound-gateways/:gatewayId`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "id": "gateway_123456789",
  "name": "Updated Inbound Gateway",
  "address": "sip:updated.sipdomain.com",
  "numbers": [
    "+11234567890",
    "+19876543210"
  ],
  "allowedAddresses": [
    "sip:trusted.example.com"
  ],
  "allowedNumbers": [
    "+14150001111"
  ],
  "mediaEncryption": "disable",
  "transport": "udp",
  "record": true,
  "tags": [
    "staging",
    "backup"
  ],
  "auth": {
    "username": "sip_user",
    "password": "••••••••"
  },
  "geoRegion": "in001",
  "metadata": {
    "env": "staging"
  },
  "noiseCancellation": true
}