Request
AccountSid string Optional format: "uuid"
The unique identifier for an account to which the number should be transferred. Must be within the same Space.
EmergencyAddressSid string Optional format: "uuid"
The unique identifier of the address associated with E911 for this phone number. Not supported for toll-free numbers or certain providers.
FriendlyName string Optional 1-255 characters
A friendly name for the phone number.
SmsApplicationSid string Optional format: "uuid"
The unique identifier for the application associated with SMS handling on this phone number.
SmsFallbackMethod enum Optional Defaults to POST
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
Allowed values: GET POST
SmsFallbackUrl string Optional format: "uri"
The URL to request if errors occur when fetching SmsUrl.
SmsMethod enum Optional Defaults to POST
Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values: GET POST
SmsUrl string Optional format: "uri"
The URL to request when an incoming SMS is received.
StatusCallback string Optional format: "uri"
The URL to request to pass status updates to.
StatusCallbackMethod enum Optional Defaults to POST
Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
Allowed values: GET POST
VoiceApplicationSid string Optional format: "uuid"
The unique identifier for the application associated with call handling on this phone number.
VoiceFallbackMethod enum Optional Defaults to POST
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values: GET POST
VoiceFallbackUrl string Optional format: "uri"
The URL to request if errors occur when fetching VoiceUrl.
VoiceMethod enum Optional Defaults to POST
Whether the request to VoiceUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values: GET POST
VoiceReceiveMode enum Optional
Whether this number can receive voice calls or faxes.
Allowed values: voice fax
VoiceUrl string Optional format: "uri"
The URL to request when an incoming call is received.
Response
account_id string Required format: "uuid"
The unique identifier for the account that is associated with this phone number.
account_sid string Required format: "uuid"
The unique identifier for the account that is associated with this phone number.
address_requirements enum Required
Whether or not a registered address with SignalWire is required. Always 'none'.
Allowed values: none any local foreign
address_sid string or null Required
The unique identifier for the address associated with this phone number. Always null.
api_version string Required
The version of the SignalWire API.
beta boolean Required
New numbers on SignalWire are marked as beta. Always false.
capabilities object Required
Whether or not a number can receive calls and messages.
country_code string Required
The ISO 3166-1 alpha-2 country code for this phone number.
date_created string Required
The date, in RFC 2822 format, this phone number was created.
date_updated string Required
The date, in RFC 2822 format, this phone number was updated.
emergency_address_sid string or null Required
The unique identifier of the address associated with E911 for this phone number, or null if not set.
emergency_status string Required
Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
friendly_name string Required
A formatted version of the number.
identity_sid string or null Required
The unique identifier for the identity associated with this phone number. Always null.
origin enum Required
The origin of the phone number.
Allowed values: signalwire hosted
phone_number string Required
The incoming number in E.164 format.
sid string Required
The unique identifier for this phone number.
sms_application_sid string or null Required
The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
sms_fallback_method string Required
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
sms_fallback_url string or null Required
The URL to request if errors occur when fetching SmsUrl, or null if not set.
sms_method string Required
Whether the request to SmsUrl is a `GET` or a `POST`.
sms_url string or null Required
The URL to request when an incoming SMS is received, or null if not set.
status_callback string or null Required
The URL to request to pass status updates to, or null if not set.
status_callback_method string Required
Whether the request to StatusCallback is a `GET` or a `POST`.
trunk_sid string or null Required
The unique identifier for the Trunk associated with this phone number. Always null.
uri string Required
The URI for this number.
voice_application_sid string or null Required
The unique identifier for the application associated with call handling on this phone number, or null if not set.
voice_caller_id_lookup boolean or null Required
Whether or not to look up a caller's name in the database. Always null.
voice_fallback_method string Required
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
voice_fallback_url string or null Required
The URL to request if errors occur when fetching `Url`, or null if not set.
voice_method string Required
Whether the request to Url is a `GET` or a `POST`.
voice_url string or null Required
The URL to request when an incoming call is received, or null if not set.
verification_status string Optional
The verification status for toll-free numbers. Only present for toll-free numbers.
SignalWire Docs