Create an Incoming Phone Number
POST/Accounts/:AccountSid/IncomingPhoneNumbers
Create an Incoming Phone Number.
Permissions
The API token must include the following scopes: Numbers.
Request
Path Parameters
The unique identifier for the account that is associated with this phone number.
- application/x-www-form-urlencoded
Body
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.
The incoming number in E.164 format.
+13103386745
The unique identifier for the address associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472ad
A formatted version of the number.
310-338-6745
The unique identifier for the identity associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472ri
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.
null
Whether the request to SmsFallbackUrl
is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request if errors occur when fetching SmsUrl.
Whether the request to SmsUrl is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request when an incoming SMS is received.
The URL to request to pass status updates to.
example.com
Whether the request to StatusCallback is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The unique identifier for the Trunk associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472tr
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.
null
Whether or not to look up a caller's name in the database.
Whether the request to VoiceFallbackUrl is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request if errors occur when fetching Url
.
example.com
Whether the request to Url is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
GET
Whether this number can receive calls or fax. Possible values are voice or fax. Default is voice.
Possible values: [voice
, fax
]
voice
The URL to request when an incoming call is received.
http://your-application.com/docs/voice.xml
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
The unique identifier for the account that is associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472ac
Whether or not a registered address with SignalWire is required.
Possible values: [none
, any
, local
, foreign
]
none
The unique identifier for the address associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472ad
The version of the SignalWire API.
2010-04-01
New numbers on SignalWire are marked as beta.
capabilities
object
Whether or not a number can receive calls and messages.
The date, in RFC 2822 format, this phone number was created.
Tue, 25 Sept 2018 23:00:00 +0000
The date, in RFC 2822 format, this phone number was updated.
Wed, 26 Sept 2018 22:00:00 +0000
The unique identifier of the address associated with E911 for this phone number.
null
Whether the phone route has an active E911 address associated.
Possible values: [active
, inactive
]
active
A formatted version of the number.
310-338-6745
The unique identifier for the identity associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472ri
The origin of the phone number. SignalWire numbers are denoted as signalwire
while hosted numbers are denoted as hosted
.
Possible values: [signalwire
, hosted
]
origin
The incoming number in E.164 format.
+13103386745
The unique identifier for this phone number.
b3877c40-da60-4998-90ad-b792e98472pn
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.
null
Whether the request to SmsFallbackUrl
is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request if errors occur when fetching SmsUrl.
Whether the request to SmsUrl is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request when an incoming SMS is received.
The URL to request to pass status updates to.
example.com
Whether the request to StatusCallback is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The unique identifier for the Trunk associated with this phone number.
b3877c40-da60-4998-90ad-b792e98472tr
The URI for this number.
/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json
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.
null
Whether or not to look up a caller's name in the database.
Whether the request to VoiceFallbackUrl is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
POST
The URL to request if errors occur when fetching Url
.
example.com
Whether the request to Url is a GET
or a POST
. Default is POST
.
Possible values: [GET
, POST
]
GET
The URL to request when an incoming call is received.
http://your-application.com/docs/voice.xml
{
"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"
}