Skip to main content
Version: /v2

Get Phone Number by e164 - API

Retrieves a phone number using its e164 string (not the UUID), along with the inbound and outbound SIP gateways currently attached to it.

URL-encode the leading + as %2B if your HTTP client does not encode it automatically (e.g. /%2B14155551234).

Returns { phoneNumber, inbound, outbound }inbound / outbound are gateway objects or null if the number is not attached.

HTTP method and endpoint

GET

|

https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumber
Headers Parameters

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
REQUIRED
The e164-formatted phone number to look up (e.g. +14155551234). URL-encode + as %2B.
Response Parameters
The phone number record with phoneNumberId, e164, countryCode, provider, origin, status, name, and timestamps.
Inbound SIP gateway currently attached to this number, or null if not attached. Inbound gateways always have address: null and auth: {}.
Outbound SIP gateway currently attached to this number, or null if not attached.
GET
|
https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumber
import fetch from 'node-fetch';
const options = {
method: "GET",
headers: {
"Authorization": "$YOUR_TOKEN",
},
};
const url= `https://api.videosdk.live/v2/sip/phone-numbers/:phoneNumber`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
{
"phoneNumber": {
"phoneNumberId": "pn_abc123",
"e164": "+14155551234",
"countryCode": "US",
"provider": "other",
"origin": "SIP Configured",
"status": "ACTIVE",
"createdAt": "2026-05-11T10:00:00.000Z",
"updatedAt": "2026-05-11T10:00:00.000Z",
"name": "My SIP Setup"
},
"inbound": {
"id": "gw_inbound_uuid",
"address": null,
"numbers": [
"+14155551234"
],
"mediaEncryption": "disable",
"transport": "tls",
"geoRegion": "us002",
"auth": {}
},
"outbound": {
"id": "gw_outbound_uuid",
"address": "sip.telnyx.com:5061",
"numbers": [
"+14155551234"
],
"mediaEncryption": "disable",
"transport": "tls",
"geoRegion": "us002",
"auth": {
"username": "sip-user",
"password": "sip-pass"
}
}
}

Got a Question? Ask us on discord