Sign in
Imported Phone Numbers

Import a Phone Number

Import a phone number hosted elsewhere into your SignalWire Space.

Note: This is a Partner API. To enable it on your SignalWire Space, contact Sales.

Permissions

The API token must include the following scopes: Numbers.

post/Accounts/{AccountSid}/ImportedPhoneNumbers

Path parameters

AccountSidstring uuid required

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

Response

The request has succeeded and a new resource has been created as a result.

account_sidstring uuid

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

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

Address requirements.

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'

Emergency status.

friendly_namestring

A formatted version of the number.

identity_sidstring

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

origin'signalwire' | 'hosted'

Phone number origin.

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.

sms_fallback_methodstring

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_methodstring

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_methodstring

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.

voice_caller_id_lookupboolean

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

voice_fallback_methodstring

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_methodstring

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_sid": "b3877c40-da60-4998-90ad-b792e98472ad",
  "api_version": "2010-04-01",
  "capabilities": {
    "Voice": true,
    "SMS": true,
    "MMS": true,
    "Fax": true
  },
  "date_created": "Tue, 25 Sept 2018 23:00:00 +0000",
  "date_updated": "Wed, 26 Sept 2018 22:00:00 +0000",
  "emergency_address_sid": "b3877c40-da60-4998-90ad-b792e98472ea",
  "friendly_name": "310-338-6745",
  "identity_sid": "b3877c40-da60-4998-90ad-b792e98472ri",
  "phone_number": "+13103386745",
  "sid": "b3877c40-da60-4998-90ad-b792e98472pn",
  "sms_application_sid": "b3877c40-da60-4998-90ad-b792e98472sa",
  "sms_fallback_method": "POST",
  "sms_fallback_url": "http://example.com/sms-fallback",
  "sms_method": "POST",
  "sms_url": "http://example.com/sms",
  "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": "b3877c40-da60-4998-90ad-b792e98472va",
  "voice_fallback_method": "POST",
  "voice_fallback_url": "example.com",
  "voice_method": "GET",
  "voice_url": "http://your-application.com/docs/voice.xml"
}

Changes