Update an Incoming Phone Number

POST 
/Accounts/:AccountSid/IncomingPhoneNumbers/:Sid

Allows you to modify the properties of an incoming phone number, including transferring it to another account.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

AccountSid uuidrequired

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

Sid uuidrequired

The unique identifier of the phone number.

application/x-www-form-urlencoded

Body

required

AccountSiduuid
The unique identifier for an account to which the number should be transferred to.
Example: b3877c40-da60-4998-90ad-b792e98472ac
AddressSidstring
The unique identifier for the address associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472ad
EmergencyAddressSidstring
The unique identifier of the address associated with E911 for this phone number.
Example: null
FriendlyNamestring
A formatted version of the number.
Example: 310-338-6745
IdentitySidstring
The unique identifier for the identity associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472ri
SmsApplicationSidstring
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.
Example: null
SmsFallbackMethodstring
Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
SmsFallbackUrlstring
The URL to request if errors occur when fetching SmsUrl.
Example:
SmsMethodstring
Whether the request to SmsUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
SmsUrlstring
The URL to request when an incoming SMS is received.
Example:
StatusCallbackstring
The URL to request to pass status updates to.
Example: example.com
StatusCallbackMethodstring
Whether the request to StatusCallback is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
TrunkSidstring
The unique identifier for the Trunk associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472tr
VoiceApplicationSidstring
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.
Example: null
VoiceCallerIdLookupboolean

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

VoiceFallbackMethodstring
Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
VoiceFallbackUrlstring
The URL to request if errors occur when fetching Url.
Example: example.com
VoiceMethodstring
Whether the request to Url is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: GET
VoiceReceiveModestring
Whether this number can receive calls or fax. Possible values are voice or fax. Default is voice.
Possible values: [voice, fax]
Example: voice
VoiceUrlstring
The URL to request when an incoming call is received.
Example: http://your-application.com/docs/voice.xml

Responses

200

OK

application/json

Schema

Schema

account_siduuid
The unique identifier for the account that is associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472ac
address_requirementsstring
Whether or not a registered address with SignalWire is required.
Possible values: [none, any, local, foreign]
Example: none
address_sidstring
The unique identifier for the address associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472ad
api_versionstring
The version of the SignalWire API.
Example: 2010-04-01
betaboolean

New numbers on SignalWire are marked as beta.

capabilities

object

Whether or not a number can receive calls and messages.

Voiceboolean

SMSboolean

MMSboolean

Faxboolean
date_createdstring
The date, in RFC 2822 format, this phone number was created.
Example: Tue, 25 Sept 2018 23:00:00 +0000
date_updatedstring
The date, in RFC 2822 format, this phone number was updated.
Example: Wed, 26 Sept 2018 22:00:00 +0000
emergency_address_sidstring
The unique identifier of the address associated with E911 for this phone number.
Example: null
emergency_statusstring
Whether the phone route has an active E911 address associated.
Possible values: [active, inactive]
Example: active
friendly_namestring
A formatted version of the number.
Example: 310-338-6745
identity_sidstring
The unique identifier for the identity associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472ri
originstring
The origin of the phone number. SignalWire numbers are denoted as signalwire while hosted numbers are denoted as hosted.
Possible values: [signalwire, hosted]
Example: origin
phone_numberstring
The incoming number in E.164 format.
Example: +13103386745
sidstring
The unique identifier for this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472pn
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.
Example: null
sms_fallback_methodstring
Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
sms_fallback_urlstring
The URL to request if errors occur when fetching SmsUrl.
Example:
sms_methodstring
Whether the request to SmsUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
sms_urlstring
The URL to request when an incoming SMS is received.
Example:
status_callbackstring
The URL to request to pass status updates to.
Example: example.com
status_callback_methodstring
Whether the request to StatusCallback is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
trunk_sidstring
The unique identifier for the Trunk associated with this phone number.
Example: b3877c40-da60-4998-90ad-b792e98472tr
uristring
The URI for this number.
Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json
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.
Example: null
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.
Possible values: [GET, POST]
Example: POST
voice_fallback_urlstring
The URL to request if errors occur when fetching Url.
Example: example.com
voice_methodstring
Whether the request to Url is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: GET
voice_urlstring
The URL to request when an incoming call is received.
Example: http://your-application.com/docs/voice.xml

Example (from schema)

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "address_requirements": "none",
  "address_sid": "b3877c40-da60-4998-90ad-b792e98472ad",
  "api_version": "2010-04-01",
  "beta": true,
  "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": "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_fallback_url": "",
  "sms_method": "POST",
  "sms_url": "",
  "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_caller_id_lookup": true,
  "voice_fallback_method": "POST",
  "voice_fallback_url": "example.com",
  "voice_method": "GET",
  "voice_url": "http://your-application.com/docs/voice.xml"
}