Create an Incoming Phone Number

Create an Incoming Phone Number.

Permissions

The API token must include the following scopes: Numbers.

Path Parameters
AccountSid uuid — REQUIRED The unique identifier for the account that is associated with this phone number.

Request Body
AreaCode string — REQUIRED The area code of your new number. A new number within this area code will be generated for you. Area code is necessary if phone number is not present.
PhoneNumber string — REQUIRED The incoming number in E.164 format.
AddressSid string The unique identifier for the address associated with this phone number.
FriendlyName string A formatted version of the number.
IdentitySid string The unique identifier for the identity associated with this phone number.
SmsApplicationSid string 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.
SmsFallbackMethod string Possible values: [GET, POST] Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.
SmsFallbackUrl string The URL to request if errors occur when fetching SmsUrl.
SmsMethod string Possible values: [GET, POST] Whether the request to SmsUrl is a GET or a POST. Default is POST.
SmsUrl string The URL to request when an incoming SMS is received.
StatusCallback string The URL to request to pass status updates to.
StatusCallbackMethod string Possible values: [GET, POST] Whether the request to StatusCallback is a GET or a POST. Default is POST.
TrunkSid string The unique identifier for the Trunk associated with this phone number.
VoiceApplicationSid string 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.
VoiceCallerIdLookup boolean Whether or not to look up a caller's name in the database.
VoiceFallbackMethod string Possible values: [GET, POST] Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.
VoiceFallbackUrl string The URL to request if errors occur when fetching Url.
VoiceMethod string Possible values: [GET, POST] Whether the request to Url is a GET or a POST. Default is POST.
VoiceReceiveMode string Possible values: [voice, fax] Whether this number can receive calls or fax. Possible values are voice or fax. Default is voice.
VoiceUrl string The URL to request when an incoming call is received.

Responses

200 OK Schema — OPTIONAL account_sid uuid — OPTIONAL The unique identifier for the account that is associated with this phone number. address_requirements string — OPTIONAL Possible values: [none, any, local, foreign] Whether or not a registered address with SignalWire is required. address_sid string — OPTIONAL The unique identifier for the address associated with this phone number. api_version string — OPTIONAL The version of the SignalWire API. beta boolean — OPTIONAL New numbers on SignalWire are marked as beta. capabilities object — OPTIONAL Whether or not a number can receive calls and messages. Voice boolean — OPTIONAL SMS boolean — OPTIONAL MMS boolean — OPTIONAL Fax boolean — OPTIONAL date_created string — OPTIONAL The date, in RFC 2822 format, this phone number was created. date_updated string — OPTIONAL The date, in RFC 2822 format, this phone number was updated. emergency_address_sid string — OPTIONAL The unique identifier of the address associated with E911 for this phone number. emergency_status string — OPTIONAL Possible values: [active, inactive] Whether the phone route has an active E911 address associated. friendly_name string — OPTIONAL A formatted version of the number. identity_sid string — OPTIONAL The unique identifier for the identity associated with this phone number. origin string — OPTIONAL Possible values: [signalwire, hosted] The origin of the phone number. SignalWire numbers are denoted as signalwire while hosted numbers are denoted as hosted. phone_number string — OPTIONAL The incoming number in E.164 format. sid string — OPTIONAL The unique identifier for this phone number. sms_application_sid string — OPTIONAL 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. sms_fallback_method string — OPTIONAL Possible values: [GET, POST] Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST. sms_fallback_url string — OPTIONAL The URL to request if errors occur when fetching SmsUrl. sms_method string — OPTIONAL Possible values: [GET, POST] Whether the request to SmsUrl is a GET or a POST. Default is POST. sms_url string — OPTIONAL The URL to request when an incoming SMS is received. status_callback string — OPTIONAL The URL to request to pass status updates to. status_callback_method string — OPTIONAL Possible values: [GET, POST] Whether the request to StatusCallback is a GET or a POST. Default is POST. trunk_sid string — OPTIONAL The unique identifier for the Trunk associated with this phone number. uri string — OPTIONAL The URI for this number. voice_application_sid string — OPTIONAL 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. voice_caller_id_lookup boolean — OPTIONAL Whether or not to look up a caller's name in the database. voice_fallback_method string — OPTIONAL Possible values: [GET, POST] Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST. voice_fallback_url string — OPTIONAL The URL to request if errors occur when fetching Url. voice_method string — OPTIONAL Possible values: [GET, POST] Whether the request to Url is a GET or a POST. Default is POST. voice_url string — OPTIONAL The URL to request when an incoming call is received.