Skip to main content

Incoming Phone Numbers

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

Properties

AttributeType
account_sidstringThe unique identifier for the account that is associated with this phone number.
address_requirementsstringWhether or not a registered address with SignalWire is required. See below for possible values.
address_sidstringThe unique identifier for the address associated with this phone number.
api_versionstringThe version of the SignalWire API.
betabooleanNew numbers on SignalWire are marked as beta. Possible values are true or false.
capabilitiesobjectWhether or not a number can receive calls and messages. Possible values are Voice, SMS, MMS, and Fax. Each of these values have a boolean value of true or false.
date_createddatetimeThe date, in RFC 2822 format, this phone number was created.
date_updateddatetimeThe date, in RFC 2822 format, this phone number was updated.
emergency_address_sidstringThe unique identifier of the address associated with E911 for this phone number.
emergency_statusstringWhether the phone route has an active E911 address associated. Possible values are Active or Inactive.
friendly_namestringA formatted version of the number.
identity_sidstringThe unique identifier for the identity associated with this phone number.
originstringThe origin of the phone number. SignalWire numbers are denoted as signalwire while hosted numbers are denoted as hosted.
phone_numberstringThe incoming number in E.164 format.
sidstringThe unique identifier for this phone number.
sms_application_sidstringThe unique identifier for the application associated with SMS handling on this phone number. If SmsApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.
sms_fallback_methodstringWhether the request to SmsFallbackUrl is a GET or a POST. Default is POST.
sms_fallback_urlstringThe URL to request if errors occur when fetching SmsUrl.
sms_methodstringWhether the request to SmsUrl is a GET or a POST. Default is POST.
sms_urlstringThe URL to request when an incoming SMS is received.
status_callbackstringThe URL to request to pass status updates to.
status_callback_methodstringWhether the request to StatusCallback is a GET or a POST. Default is POST.
trunk_sidstringThe unique identifier for the Trunk associated with this phone number.
uristringThe URI for this number.
voice_application_sidstringThe unique identifier for the application associated with call handling on this phone number. If VoiceApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.
voice_caller_id_lookupbooleanWhether or not to look up a caller's name in the database. Possible values are true or false.
voice_fallback_methodstringWhether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.
voice_fallback_urlstringThe URL to request if errors occur when fetching Url.
voice_methodstringWhether the request to Url is a GET or a POST. Default is POST.
voice_urlstringThe URL to request when an incoming call is received.

A sample IncomingPhoneNumber returned from the API:

{
"account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
"address_requirements": "none",
"address_sid": "b3877c40-da60-4998-90ad-b792e98472ad",
"api_version": "2010-04-01",
"beta": false,
"capabilities": {
"mms": true,
"sms": false,
"voice": true
},
"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": "b3877c40-da60-4998-90ad-b792e98472ri",
"origin": "origin",
"phone_number": "+13103386745",
"sid": "b3877c40-da60-4998-90ad-b792e98472pn",
"sms_application_sid": null,
"sms_fallback_method": "POST",
"sms_fallback_url": "",
"sms_method": "POST",
"sms_url": "",
"status_callback": "",
"status_callback_method": "POST",
"trunk_sid": "b3877c40-da60-4998-90ad-b792e98472tr",
"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": false,
"voice_fallback_method": "POST",
"voice_fallback_url": null,
"voice_method": "GET",
"voice_url": "http://your-application.com/docs/voice.xml"
}


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.