twilio phone-numbers:buy:shared-cost

Purchase a shared-cost phone number

Options

NameDescription
-l <level>
-o <format>Format of command output
--silentSuppress output and logs. This is a shorthand for "-l none -o none"
--country-code <country-code>
  • Required ✳
--account-sid <account-sid>The SID of the Account requesting the AvailablePhoneNumber resources
--address-sid <address-sid>The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations
--api-version <api-version>The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`
--area-code <area-code>The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada
--betaWhether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`
--no-betaWhether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`
--bundle-sid <bundle-sid>The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations
--contains <contains>The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters
--distance <distance>The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada
--emergency-address-sid <emergency-address-sid>The SID of the emergency address configuration to use for emergency calling from the new phone number
--emergency-status <status>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
--exclude-all-address-requiredWhether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`
--no-exclude-all-address-requiredWhether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`
--exclude-foreign-address-requiredWhether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`
--no-exclude-foreign-address-requiredWhether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`
--exclude-local-address-requiredWhether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`
--no-exclude-local-address-requiredWhether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`
--fax-enabledWhether the phone numbers can receive faxes. Can be: `true` or `false`
--no-fax-enabledWhether the phone numbers can receive faxes. Can be: `true` or `false`
--friendly-name <friendly-name>A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number
--identity-sid <identity-sid>The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations
--in-lata <in-lata>Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada
--in-locality <in-locality>Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number
--in-postal-code <in-postal-code>Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada
--in-rate-center <in-rate-center>Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada
--in-region <in-region>Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada
--limit <limit>The maximum number of resources to return. Use '--no-limit' to disable
--mms-enabledWhether the phone numbers can receive MMS messages. Can be: `true` or `false`
--no-mms-enabledWhether the phone numbers can receive MMS messages. Can be: `true` or `false`
--near-lat-long <near-lat-long>Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada
--near-number <near-number>Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada
--no-headerSkip including of headers while listing the data
--page-size <page-size>How many resources to return in each list page. The default is 50, and the maximum is 1000
--properties <properties>The properties you would like to display (JSON output always shows all properties)
--sms-application-sid <sms-application-sid>The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application
--sms-enabledWhether the phone numbers can receive text messages. Can be: `true` or `false`
--no-sms-enabledWhether the phone numbers can receive text messages. Can be: `true` or `false`
--sms-fallback-method <method>The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`
--sms-fallback-url <sms-fallback-url>The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`
--sms-method <method>The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`
--sms-url <sms-url>The URL we should call when the new phone number receives an incoming SMS message
--status-callback <status-callback>The URL we should call using the `status_callback_method` to send status information to your application
--status-callback-method <method>The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`
--trunk-sid <trunk-sid>The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa
--voice-application-sid <voice-application-sid>The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa
--voice-caller-id-lookupWhether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`
--no-voice-caller-id-lookupWhether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`
--voice-enabledWhether the phone numbers can receive calls. Can be: `true` or `false`
--no-voice-enabledWhether the phone numbers can receive calls. Can be: `true` or `false`
--voice-fallback-method <method>The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`
--voice-fallback-url <voice-fallback-url>The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`
--voice-method <method>The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`
--voice-receive-mode <mode>The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`
--voice-url <voice-url>The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set