Sign in
Incoming Phone Numbers

Create an Incoming Phone Number

Create an Incoming Phone Number.

Permissions

The API token must include the following scopes: Numbers.

post/Accounts/{AccountSid}/IncomingPhoneNumbers

Path parameters

AccountSidstring uuid required

The unique identifier for the account that is associated with this phone number.

Response

OK

account_sidstring uuid

The unique identifier for the account that is associated with this phone number.

address_requirements'none' | 'any' | 'local' | 'foreign'

Whether or not a registered address with SignalWire is required.

address_sidstring

The unique identifier for the address associated with this phone number.

api_versionstring

The version of the SignalWire API.

betaboolean

New numbers on SignalWire are marked as beta.

date_createdstring

The date, in RFC 2822 format, this phone number was created.

date_updatedstring

The date, in RFC 2822 format, this phone number was updated.

emergency_address_sidstring

The unique identifier of the address associated with E911 for this phone number.

emergency_status'active' | 'inactive'

Whether the phone route has an active E911 address associated.

friendly_namestring

A formatted version of the number.

identity_sidstring

The unique identifier for the identity associated with this phone number.

origin'signalwire' | 'hosted'

The origin of the phone number. SignalWire numbers are denoted as signalwire while hosted numbers are denoted as hosted.

phone_numberstring

The incoming number in E.164 format.

sidstring

The unique identifier for this phone number.

sms_application_sidstring

The 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_method'GET' | 'POST'

Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

sms_fallback_urlstring

The URL to request if errors occur when fetching SmsUrl.

sms_method'GET' | 'POST'

Whether the request to SmsUrl is a GET or a POST. Default is POST.

sms_urlstring

The URL to request when an incoming SMS is received.

status_callbackstring

The URL to request to pass status updates to.

status_callback_method'GET' | 'POST'

Whether the request to StatusCallback is a GET or a POST. Default is POST.

trunk_sidstring

The unique identifier for the Trunk associated with this phone number.

uristring

The URI for this number.

voice_application_sidstring

The 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_lookupboolean

Whether or not to look up a caller's name in the database.

voice_fallback_method'GET' | 'POST'

Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

voice_fallback_urlstring

The URL to request if errors occur when fetching Url.

voice_method'GET' | 'POST'

Whether the request to Url is a GET or a POST. Default is POST.

voice_urlstring

The URL to request when an incoming call is received.

Example response

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "address_requirements": "none",
  "address_sid": "b3877c40-da60-4998-90ad-b792e98472ad",
  "api_version": "2010-04-01",
  "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": "active",
  "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_method": "POST",
  "status_callback": "example.com",
  "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_fallback_method": "POST",
  "voice_fallback_url": "example.com",
  "voice_method": "GET",
  "voice_url": "http://your-application.com/docs/voice.xml"
}

Changes