Incoming Phone Numbers

View as Markdown

IncomingPhoneNumbers represent an account’s phone numbers that were purchased through SignalWire.

Properties

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'.
Allowed values:
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.
Allowed values:
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.

Example object

The Incoming Phone Number Object
1{
2 "account_id": "string",
3 "account_sid": "string",
4 "address_requirements": "none",
5 "address_sid": "string",
6 "api_version": "string",
7 "beta": true,
8 "capabilities": {
9 "voice": true,
10 "sms": true,
11 "mms": true,
12 "fax": true
13 },
14 "country_code": "string",
15 "date_created": "string",
16 "date_updated": "string",
17 "emergency_address_sid": "string",
18 "emergency_status": "string",
19 "friendly_name": "string",
20 "identity_sid": "string",
21 "origin": "signalwire",
22 "phone_number": "string",
23 "sid": "string",
24 "sms_application_sid": "string",
25 "sms_fallback_method": "string",
26 "sms_fallback_url": "string",
27 "sms_method": "string",
28 "sms_url": "string",
29 "status_callback": "string",
30 "status_callback_method": "string",
31 "trunk_sid": "string",
32 "uri": "string",
33 "verification_status": "string",
34 "voice_application_sid": "string",
35 "voice_caller_id_lookup": true,
36 "voice_fallback_method": "string",
37 "voice_fallback_url": "string",
38 "voice_method": "string",
39 "voice_url": "string"
40}

address_requirements

The address_requirements attribute has the following values:

Value
noneNo address is required.
anyAn address is required, but can be anywhere in the world.
localAn address is required and must be in the same country as the number.
foreignAn address is required and must be outside the country of the number.