Fetch Inbound SIP Gateway by ID - API

Retrieves details of a specific inbound SIP gateway using its gatewayId.

HTTP method and endpoint

GET

|

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

Parameters

gatewayId

REQUIRED

Unique identifier of the inbound SIP gateway.

Response Parameters

id

Unique identifier for the inbound SIP gateway (maps to gatewayId).

name

Human-readable name of the gateway.

numbers

Array of phone numbers associated with this gateway.

allowedAddresses

Array of SIP addresses allowed to connect.

allowedNumbers

Array of phone numbers allowed to connect.

mediaEncryption

Media encryption setting for the SIP gateway.

transport

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

record

Indicates if calls should be recorded (true/false).

tags

Custom tags associated with the gateway.

auth

Authentication configuration for the SIP gateway.

geoRegion

Geographical region associated with the gateway.

metadata

Custom metadata for the gateway.

noiseCancellation

Noise cancellation setting (true/false).

GET

|

https://api.videosdk.live/v2/sip/inbound-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/inbound-gateways/:gatewayId`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "id": "gateway_123456789",
  "name": "Twilio Inbound Gateway",
  "address": "sip:twilio.sipdomain.com",
  "numbers": [
    "+11234567890",
    "+19876543210"
  ],
  "allowedAddresses": [
    "sip:trusted.example.com"
  ],
  "allowedNumbers": [
    "+14150001111"
  ],
  "mediaEncryption": "disable",
  "transport": "udp",
  "record": false,
  "tags": [
    "production",
    "twilio"
  ],
  "auth": {
    "username": "sip_user",
    "password": "••••••••"
  },
  "geoRegion": "in001",
  "metadata": {
    "env": "production",
    "owner": "team-voice"
  },
  "noiseCancellation": true
}