REST ClientCompatPhone Numbers

get

View as MarkdownOpen in Claude

Retrieve a single phone number by SID.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.
SidstringRequiredformat: "uuid"
The unique identifier of the phone number.

Response

account_idstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.
address_requirementsenumRequired
Whether or not a registered address with SignalWire is required. Always 'none'.
address_sidstring or nullRequired
The unique identifier for the address associated with this phone number. Always null.
api_versionstringRequired
The version of the SignalWire API.
betabooleanRequired
New numbers on SignalWire are marked as beta. Always false.
capabilitiesobjectRequired
Whether or not a number can receive calls and messages.
country_codestringRequired
The ISO 3166-1 alpha-2 country code for this phone number.
date_createdstringRequired
The date, in RFC 2822 format, this phone number was created.
date_updatedstringRequired
The date, in RFC 2822 format, this phone number was updated.
emergency_address_sidstring or nullRequired
The unique identifier of the address associated with E911 for this phone number, or null if not set.
emergency_statusstringRequired
Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
friendly_namestringRequired
A formatted version of the number.
identity_sidstring or nullRequired
The unique identifier for the identity associated with this phone number. Always null.
originenumRequired
The origin of the phone number.
phone_numberstringRequired
The incoming number in E.164 format.
sidstringRequired
The unique identifier for this phone number.
sms_application_sidstring or nullRequired
The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
sms_fallback_methodstringRequired
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
sms_fallback_urlstring or nullRequired
The URL to request if errors occur when fetching SmsUrl, or null if not set.
sms_methodstringRequired
Whether the request to SmsUrl is a `GET` or a `POST`.
sms_urlstring or nullRequired
The URL to request when an incoming SMS is received, or null if not set.
status_callbackstring or nullRequired
The URL to request to pass status updates to, or null if not set.
status_callback_methodstringRequired
Whether the request to StatusCallback is a `GET` or a `POST`.
trunk_sidstring or nullRequired
The unique identifier for the Trunk associated with this phone number. Always null.
uristringRequired
The URI for this number.
voice_application_sidstring or nullRequired
The unique identifier for the application associated with call handling on this phone number, or null if not set.
voice_caller_id_lookupboolean or nullRequired
Whether or not to look up a caller's name in the database. Always null.
voice_fallback_methodstringRequired
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
voice_fallback_urlstring or nullRequired
The URL to request if errors occur when fetching `Url`, or null if not set.
voice_methodstringRequired
Whether the request to Url is a `GET` or a `POST`.
voice_urlstring or nullRequired
The URL to request when an incoming call is received, or null if not set.
verification_statusstringOptional
The verification status for toll-free numbers. Only present for toll-free numbers.

Response Example

Response
{
  "account_id": "b3877c40-da60-4998-90ad-b792e98472ac",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "address_requirements": "none",
  "address_sid": null,
  "api_version": "2010-04-01",
  "beta": false,
  "capabilities": {
    "voice": true,
    "sms": true,
    "mms": true,
    "fax": true
  },
  "country_code": "US",
  "date_created": "Tue, 25 Sept 2018 23:00:00 +0000",
  "date_updated": "Wed, 26 Sept 2018 22:00:00 +0000",
  "emergency_address_sid": null,
  "emergency_status": "Inactive",
  "friendly_name": "(310) 338-6745",
  "identity_sid": null,
  "origin": "signalwire",
  "phone_number": "+13103386745",
  "sid": "b3877c40-da60-4998-90ad-b792e98472pn",
  "sms_application_sid": null,
  "sms_fallback_method": "POST",
  "sms_fallback_url": null,
  "sms_method": "POST",
  "sms_url": null,
  "status_callback": null,
  "status_callback_method": "POST",
  "trunk_sid": null,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json",
  "voice_application_sid": null,
  "voice_caller_id_lookup": null,
  "voice_fallback_method": "POST",
  "voice_fallback_url": null,
  "voice_method": "POST",
  "voice_url": null,
  "verification_status": "Unverified"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const number = await client.compat.phoneNumbers.get("PN...");