Fetch One Outbound SIP Gateway - API

Fetches the details of a specific outbound SIP gateway by its gatewayId for the authenticated user.

HTTP method and endpoint

GET

|

https://api.videosdk.live/v2/sip/outbound-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

Parameters

gatewayId

REQUIRED

The unique identifier of the outbound SIP gateway.

Response Parameters

id

Unique identifier of the outbound SIP gateway.

name

Name of the outbound SIP gateway.

address

SIP address/URI of the outbound gateway.

numbers

Array of outbound numbers associated with this gateway.

allowedAddresses

List of SIP addresses allowed to use this gateway.

allowedNumbers

List of phone numbers allowed to use this gateway.

mediaEncryption

Media encryption type (e.g., SRTP, NONE).

transport

Transport protocol (e.g., UDP, TLS, TCP).

record

Boolean indicating if call recording is enabled.

tags

Custom tags associated with the gateway.

auth

Authentication credentials (username & password).

geoRegion

Geographic region for this outbound gateway.

metadata

Custom metadata key-value pairs.

noiseCancellation

Boolean indicating if noise cancellation is enabled.

GET

|

https://api.videosdk.live/v2/sip/outbound-gateways/{gatewayId}

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/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"
  ],
  "allowedAddresses": [
    "sip:trusted.partner.com"
  ],
  "allowedNumbers": [
    "+14159999999"
  ],
  "mediaEncryption": "disable",
  "transport": "udp",
  "record": true,
  "tags": [
    "production"
  ],
  "auth": {
    "username": "outbound_user",
    "password": "••••••••"
  },
  "geoRegion": "in001",
  "metadata": {
    "env": "production"
  },
  "noiseCancellation": true
}