Fetch All Outbound SIP Gateways - API

Retrieves a paginated list of all outbound SIP gateways for the authenticated user. Supports filtering by id and searching by gateway name.

HTTP method and endpoint

GET

|

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

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

Query Parameters

id

OPTIONAL

Optional. Filter by a specific outbound gateway ID.

search

OPTIONAL

Optional. Search outbound gateways by name (case-insensitive).

page

OPTIONAL

Page number for pagination. Defaults to 1.

perPage

OPTIONAL

Number of records per page. Defaults to 10.

Response Parameters

pageInfo

Pagination info (current page, per page, last page, total count).

data

Array of outbound SIP gateways matching the query.

GET

|

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

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?id=gateway_out_123456789&search=twilio-outbound&page=1&perPage=10`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "pageInfo": {
    "currentPage": 1,
    "perPage": 10,
    "lastPage": 1,
    "total": 2
  },
  "data": [
    {
      "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
    },
    {
      "id": "gateway_out_987654321",
      "name": "Backup Outbound Gateway",
      "address": "sip:backup-outbound.sipdomain.com",
      "numbers": [
        "+19876543210"
      ],
      "allowedAddresses": [],
      "allowedNumbers": [],
      "mediaEncryption": "disable",
      "transport": "udp",
      "record": false,
      "tags": [
        "staging"
      ],
      "auth": {
        "username": "backup_out_user",
        "password": "••••••••"
      },
      "geoRegion": "in001",
      "metadata": {},
      "noiseCancellation": false
    }
  ]
}