REST Client MethodsIncoming Phone Numbers

Create

View as Markdown

Use this endpoint for the IncomingPhoneNumber method to create an IncomingPhoneNumber.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.

Request

PhoneNumberstringRequiredformat: "^\+\d{5,17}$"6-18 characters
The phone number to purchase in E.164 format. Must start with `+` followed by 5-17 digits.
FriendlyNamestringOptional
A friendly name for the phone number. If not provided, the formatted phone number will be used.
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`.
Allowed values:
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`.
Allowed values:
SmsUrlstringOptionalformat: "uri"
The URL to request when an incoming SMS is received.
StatusCallbackstringOptionalformat: "uri"
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.
StatusCallbackMethodenumOptionalDefaults to POST
Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
Allowed values:
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`.
Allowed values:
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`.
Allowed values:
VoiceReceiveModeenumOptionalDefaults to voice
Whether this number can receive voice calls or faxes. Default is `voice`.
Allowed values:
VoiceUrlstringOptionalformat: "uri"
The URL to request when an incoming call is received.

Response

account_idstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.
address_requirementsenumRequired
Whether or not a registered address with SignalWire is required. Always 'none'.
Allowed values:
address_sidstring or nullRequired
The unique identifier for the address associated with this phone number. Always null.
api_versionstringRequired
The version of the SignalWire API.
betabooleanRequired
New numbers on SignalWire are marked as beta. Always false.
capabilitiesobjectRequired
Whether or not a number can receive calls and messages.
country_codestringRequired
The ISO 3166-1 alpha-2 country code for this phone number.
date_createdstringRequired
The date, in RFC 2822 format, this phone number was created.
date_updatedstringRequired
The date, in RFC 2822 format, this phone number was updated.
emergency_address_sidstring or nullRequired
The unique identifier of the address associated with E911 for this phone number, or null if not set.
emergency_statusstringRequired
Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
friendly_namestringRequired
A formatted version of the number.
identity_sidstring or nullRequired
The unique identifier for the identity associated with this phone number. Always null.
originenumRequired
The origin of the phone number.
Allowed values:
phone_numberstringRequired
The incoming number in E.164 format.
sidstringRequired
The unique identifier for this phone number.
sms_application_sidstring or nullRequired
The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
sms_fallback_methodstringRequired
Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
sms_fallback_urlstring or nullRequired
The URL to request if errors occur when fetching SmsUrl, or null if not set.
sms_methodstringRequired
Whether the request to SmsUrl is a `GET` or a `POST`.
sms_urlstring or nullRequired
The URL to request when an incoming SMS is received, or null if not set.
status_callbackstring or nullRequired
The URL to request to pass status updates to, or null if not set.
status_callback_methodstringRequired
Whether the request to StatusCallback is a `GET` or a `POST`.
trunk_sidstring or nullRequired
The unique identifier for the Trunk associated with this phone number. Always null.
uristringRequired
The URI for this number.
voice_application_sidstring or nullRequired
The unique identifier for the application associated with call handling on this phone number, or null if not set.
voice_caller_id_lookupboolean or nullRequired
Whether or not to look up a caller's name in the database. Always null.
voice_fallback_methodstringRequired
Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
voice_fallback_urlstring or nullRequired
The URL to request if errors occur when fetching `Url`, or null if not set.
voice_methodstringRequired
Whether the request to Url is a `GET` or a `POST`.
voice_urlstring or nullRequired
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.

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.incomingPhoneNumbers
5      .create({
6         friendlyName: 'IncomingPhoneNumber1',
7         phoneNumber: '+13103386745'
8       })
9      .then(incoming_phone_number => console.log(incoming_phone_number.sid))
10      .done();