Update an incoming phone number

Changes how an account-owned phone number is identified or routes inbound calls, messages, and faxes. Use this operation for form-encoded configuration; use SignalWire REST Update phone number for JSON configuration.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Changes how an account-owned phone number is identified or routes inbound calls, messages, and faxes. Use this operation for form-encoded configuration; use SignalWire REST [Update phone number](/docs/apis/rest/phone-numbers/update-phone-number) for JSON configuration. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"

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

SidstringRequiredformat: "uuid"

The unique identifier of the phone number.

Request

This endpoint expects an object.

AccountSidstringOptionalformat: "uuid"

The unique identifier for an account to which the number should be transferred. Must be within the same Space.

EmergencyAddressSidstringOptionalformat: "uuid"

The unique identifier of the address associated with E911 for this phone number. Not supported for toll-free numbers or certain providers.

FriendlyNamestringOptional1-255 characters

A friendly name for the phone number.

SmsApplicationSidstringOptionalformat: "uuid"

The unique identifier for the application associated with SMS handling on this phone number.

SmsFallbackMethodenumOptionalDefaults to POST

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

SmsFallbackUrlstringOptionalformat: "uri"

The URL to request if errors occur when fetching SmsUrl.

SmsMethodenumOptionalDefaults to POST

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

SmsUrlstringOptionalformat: "uri"

The URL to request when an incoming SMS is received.

StatusCallbackstringOptionalformat: "uri"

The URL to request to pass status updates to.

StatusCallbackMethodenumOptionalDefaults to POST

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

VoiceApplicationSidstringOptionalformat: "uuid"

The unique identifier for the application associated with call handling on this phone number.

VoiceFallbackMethodenumOptionalDefaults to POST

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

VoiceFallbackUrlstringOptionalformat: "uri"

The URL to request if errors occur when fetching VoiceUrl.

VoiceMethodenumOptionalDefaults to POST

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

VoiceReceiveModeenumOptional

Whether this number can receive voice calls or faxes.

VoiceUrlstringOptionalformat: "uri"

The URL to request when an incoming call is received.

Response

The request has succeeded.

account_idstringformat: "uuid"

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

account_sidstringformat: "uuid"

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

address_requirementsenum

Whether or not a registered address with SignalWire is required. Always 'none'.

address_sidstring or null

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

api_versionstring

The version of the SignalWire API.

betaboolean

New numbers on SignalWire are marked as beta. Always false.

capabilitiesobject

Whether or not a number can receive calls and messages.

country_codestring

The ISO 3166-1 alpha-2 country code for this phone number.

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 or null

The unique identifier of the address associated with E911 for this phone number, or null if not set.

emergency_statusstring

Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.

friendly_namestring

A formatted version of the number.

identity_sidstring or null

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

originenum

The origin of the phone number.

phone_numberstring

The incoming number in E.164 format.

sidstring

The unique identifier for this phone number.

sms_application_sidstring or null

The unique identifier for the application associated with SMS handling on this phone number, or null if not set.

sms_fallback_methodstring

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

sms_fallback_urlstring or null

The URL to request if errors occur when fetching SmsUrl, or null if not set.

sms_methodstring

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

sms_urlstring or null

The URL to request when an incoming SMS is received, or null if not set.

status_callbackstring or null

The URL to request to pass status updates to, or null if not set.

status_callback_methodstring

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

trunk_sidstring or null

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

uristring

The URI for this number.

voice_application_sidstring or null

The unique identifier for the application associated with call handling on this phone number, or null if not set.

voice_caller_id_lookupboolean or null

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

voice_fallback_methodstring

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

voice_fallback_urlstring or null

The URL to request if errors occur when fetching Url, or null if not set.

voice_methodstring

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

voice_urlstring or null

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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error