Api20100401Account4

Api20100401AddOnResult3

Api20100401Address5

Api20100401AllTime1

Api20100401Application5

Api20100401AssignedAddOn4

Api20100401AssignedAddOnExtension2

Api20100401AuthCallsCredentialListMapping4

Api20100401AuthCallsIpAccessControlListMapping4

Api20100401AuthorizedConnectApp2

Api20100401AuthRegistrationsCredentialListMapping4

Api20100401AvailablePhoneNumberCountry2

Api20100401Balance1

Api20100401Call5

Api20100401CallNotification2

Api20100401CallRecording5

Api20100401CallTranscription2

Api20100401Conference3

Api20100401ConferenceRecording4

Api20100401ConnectApp4

Api20100401Credential5

Api20100401CredentialList5

Api20100401CredentialListMapping4

Api20100401Daily1

Api20100401Data1

Api20100401DependentPhoneNumber1

Api20100401Domain5

Api20100401Event1

Api20100401Feedback1

Api20100401IncomingPhoneNumber5

Api20100401IncomingPhoneNumberLocal2

Api20100401IncomingPhoneNumberMobile2

Api20100401IncomingPhoneNumberTollFree2

Api20100401IpAccessControlList5

Api20100401IpAccessControlListMapping4

Api20100401Key4

Api20100401LastMonth1

Api20100401Local1

Api20100401MachineToMachine1

Api20100401Media1

Api20100401MediaInstance2

Api20100401Member3

Api20100401Message5

Api20100401Mobile1

Api20100401Monthly1

Api20100401National1

Api20100401NewKey1

Api20100401NewSigningKey1

Api20100401Notification2

Api20100401OutgoingCallerId4

Api20100401Participant5

Api20100401Payload3

Api20100401Payment2

Api20100401Queue5

Api20100401Record1

Api20100401Recording3

Api20100401RecordingTranscription3

Api20100401SharedCost1

Api20100401ShortCode3

Api20100401SigningKey4

Api20100401SipIpAddress5

Api20100401Siprec2

Api20100401Stream2

Api20100401ThisMonth1

Api20100401Today1

Api20100401Token1

Api20100401TollFree1

Api20100401Transcription3

Api20100401Trigger5

Api20100401UserDefinedMessage1

Api20100401UserDefinedMessageSubscription2

Api20100401ValidationRequest1

Api20100401Voip1

Api20100401Yearly1

Api20100401Yesterday1

Api20100401IncomingPhoneNumber

Purchase a phone-number for the account.

post/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

Path parameters

AccountSidstring required

The SID of the Account that will create the resource.

Response

Created

account_sidstring nullable

The SID of the Account that created this IncomingPhoneNumber resource.

address_sidstring nullable

The SID of the Address resource associated with the phone number.

address_requirements'none' | 'any' | 'local' | 'foreign'

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

api_versionstring nullable

The API version used to start a new TwiML session.

betaboolean nullable

Whether the phone number is new to the Twilio platform. Can be: true or false.

date_createdstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

friendly_namestring nullable

The string that you assigned to describe the resource.

identity_sidstring nullable

The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.

phone_numberstring phone-number nullable

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

originstring nullable

The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.

sidstring nullable

The unique string that that we created to identify this IncomingPhoneNumber resource.

sms_application_sidstring nullable

The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.

sms_fallback_method'GET' | 'POST' http-method nullable

The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

sms_fallback_urlstring uri nullable

The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.

sms_method'GET' | 'POST' http-method nullable

The HTTP method we use to call sms_url. Can be: GET or POST.

sms_urlstring uri nullable

The URL we call when the phone number receives an incoming SMS message.

status_callbackstring uri nullable

The URL we call using the status_callback_method to send status information to your application.

status_callback_method'GET' | 'POST' http-method nullable

The HTTP method we use to call status_callback. Can be: GET or POST.

trunk_sidstring nullable

The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

uristring nullable

The URI of the resource, relative to https://api.twilio.com.

voice_receive_mode'voice' | 'fax'

voice_application_sidstring nullable

The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

voice_caller_id_lookupboolean nullable

Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

voice_fallback_method'GET' | 'POST' http-method nullable

The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

voice_fallback_urlstring uri nullable

The URL that we call when an error occurs retrieving or executing the TwiML requested by url.

voice_method'GET' | 'POST' http-method nullable

The HTTP method we use to call voice_url. Can be: GET or POST.

voice_urlstring uri nullable

The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

emergency_status'Active' | 'Inactive'

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

emergency_address_sidstring nullable

The SID of the emergency address configuration that we use for emergency calling from this phone number.

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

bundle_sidstring nullable

The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

statusstring nullable

typestring nullable

The phone number type.

Changes

Changed in 2 of the 51 revisions of this API.2021

Feb 5, 2026v20107751d3d3c93e1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 18, 2024v2010cf63f47f41aa2020See the full diff
- ▲
  removed the enum value DELETE of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value DELETE of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value DELETE of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value DELETE of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value DELETE of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value HEAD of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value HEAD of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value HEAD of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value HEAD of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value HEAD of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PATCH of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PATCH of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PATCH of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PATCH of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PATCH of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PUT of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PUT of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PUT of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PUT of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value PUT of the request property
  request-property-enum-value-removed
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed

Full history