purchase
Purchase a new phone number for the account.
Path parameters
AccountSid
The unique identifier for the account that is associated with this phone number.
Request
PhoneNumber
The phone number to purchase in E.164 format. Must start with `+` followed by 5-17 digits.
FriendlyName
A friendly name for the phone number. If not provided, the formatted phone number will be used.
SmsApplicationSid
The unique identifier for the application associated with SMS handling on this phone number.
SmsFallbackMethod
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
Allowed values:
SmsFallbackUrl
The URL to request if errors occur when fetching SmsUrl.
SmsMethod
Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values:
SmsUrl
The URL to request when an incoming SMS is received.
StatusCallback
The URL to request to pass status updates to. See the [Incoming call status callback](/docs/compatibility-api/rest/incoming-phone-numbers/webhooks/incoming-call-status-callback) webhook for the payload your URL will receive.
StatusCallbackMethod
Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
Allowed values:
VoiceApplicationSid
The unique identifier for the application associated with call handling on this phone number.
VoiceFallbackMethod
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values:
VoiceFallbackUrl
The URL to request if errors occur when fetching VoiceUrl.
VoiceMethod
Whether the request to VoiceUrl is a `GET` or a `POST`. Default is `POST`.
Allowed values:
VoiceReceiveMode
Whether this number can receive voice calls or faxes. Default is `voice`.
Allowed values:
VoiceUrl
The URL to request when an incoming call is received.
Response
account_id
The unique identifier for the account that is associated with this phone number.
account_sid
The unique identifier for the account that is associated with this phone number.
address_requirements
Whether or not a registered address with SignalWire is required. Always 'none'.
Allowed values:
address_sid
The unique identifier for the address associated with this phone number. Always null.
api_version
The version of the SignalWire API.
beta
New numbers on SignalWire are marked as beta. Always false.
capabilities
Whether or not a number can receive calls and messages.
country_code
The ISO 3166-1 alpha-2 country code for this phone number.
date_created
The date, in RFC 2822 format, this phone number was created.
date_updated
The date, in RFC 2822 format, this phone number was updated.
emergency_address_sid
The unique identifier of the address associated with E911 for this phone number, or null if not set.
emergency_status
Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
friendly_name
A formatted version of the number.
identity_sid
The unique identifier for the identity associated with this phone number. Always null.
origin
The origin of the phone number.
Allowed values:
phone_number
The incoming number in E.164 format.
sid
The unique identifier for this phone number.
sms_application_sid
The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
sms_fallback_method
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
sms_fallback_url
The URL to request if errors occur when fetching SmsUrl, or null if not set.
sms_method
Whether the request to SmsUrl is a `GET` or a `POST`.
sms_url
The URL to request when an incoming SMS is received, or null if not set.
status_callback
The URL to request to pass status updates to, or null if not set.
status_callback_method
Whether the request to StatusCallback is a `GET` or a `POST`.
trunk_sid
The unique identifier for the Trunk associated with this phone number. Always null.
uri
The URI for this number.
voice_application_sid
The unique identifier for the application associated with call handling on this phone number, or null if not set.
voice_caller_id_lookup
Whether or not to look up a caller's name in the database. Always null.
voice_fallback_method
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
voice_fallback_url
The URL to request if errors occur when fetching `Url`, or null if not set.
voice_method
Whether the request to Url is a `GET` or a `POST`.
voice_url
The URL to request when an incoming call is received, or null if not set.
verification_status
The verification status for toll-free numbers. Only present for toll-free numbers.
Response Example
Response
