Update Outbound SIP Gateway - API
Updates the details of an existing outbound SIP gateway identified by its
gatewayId. Only fields provided in the request body will be updated; other fields remain unchanged.HTTP method and endpoint
PUT
|
https://api.videosdk.live/v2/sip/outbound-gateways/{gatewayId}Headers Parameters
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
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
REQUIRED
The unique identifier of the outbound SIP gateway to update.
Body Parameters
OPTIONAL
Updated name of the outbound SIP gateway.
OPTIONAL
Array of outbound numbers associated with this gateway.
OPTIONAL
SIP address/URI of the outbound gateway.
OPTIONAL
Geographic region for this outbound gateway.
OPTIONAL
Transport protocol (e.g., UDP, TLS, TCP).
OPTIONAL
Authentication credentials (username & password).
OPTIONAL
Media encryption type (e.g., SRTP, NONE).
OPTIONAL
Boolean indicating if call recording is enabled.
OPTIONAL
Boolean indicating if noise cancellation is enabled.
OPTIONAL
List of phone numbers allowed to use this gateway.
OPTIONAL
Custom metadata key-value pairs.
OPTIONAL
Custom tags associated with the gateway.
Response Parameters
Unique identifier of the outbound SIP gateway.
Name of the outbound SIP gateway.
SIP address/URI of the outbound gateway.
Array of outbound numbers associated with this gateway.
List of phone numbers allowed to use this gateway.
Media encryption type.
Transport protocol (UDP, TLS, TCP).
Boolean indicating if call recording is enabled.
Custom tags associated with the gateway.
Authentication credentials.
Geographic region for this outbound gateway.
Custom metadata key-value pairs.
Boolean indicating if noise cancellation is enabled.
PUT
|
https://api.videosdk.live/v2/sip/outbound-gateways/{gatewayId}
NodeJS
import fetch from 'node-fetch';
const options = {
method: "PUT",
headers: {
"Authorization": "$YOUR_TOKEN",
"Content-Type": "application/json",
},
};
const url= `https://api.videosdk.live/v2/sip/outbound-gateways/{gatewayId}`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
{
"id": "gateway_out_123456789",
"name": "Twilio Outbound Gateway",
"address": "sip:outbound.twilio.com",
"numbers": [
"+14150001111",
"+14150002222"
],
"allowedNumbers": [
"+14159999999"
],
"mediaEncryption": "disable",
"transport": "udp",
"record": true,
"tags": [
"staging",
"test"
],
"auth": {
"username": "outbound_user",
"password": "••••••••"
},
"geoRegion": "in001",
"metadata": {
"env": "staging"
},
"noiseCancellation": false
}
Got a Question? 
Ask us on discord