{ "name": "twilio", "description": "Manage your Twilio resources from your terminal", "options": [ { "names": [ "-h", "--help" ], "description": "Show a help message", "isPersistent": true } ], "args": [ { "name": "command", "isOptional": true } ], "subcommands": [ { "name": "autocomplete", "description": "Display autocomplete installation instructions", "hidden": true, "options": [ { "names": [ "-r", "--refresh-cache" ], "description": "Refresh cache (ignores displaying instructions)" } ], "args": [ { "name": "shell", "description": "Shell type", "suggestions": [ "bash", "zsh" ] } ] }, { "name": "config:list", "description": "List Twilio CLI configurations", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" } ] }, { "name": "config:set", "description": "Update Twilio CLI configurations", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "-e", "--edge" ], "description": "Sets an Edge configuration" }, { "names": [ "--require-profile-input" ], "exclusiveOn": [ "--no-require-profile-input" ] }, { "names": [ "--no-require-profile-input" ], "exclusiveOn": [ "--require-profile-input" ] } ] }, { "name": "debugger:logs:list", "description": "Show a list of log events generated for the account", "hidden": true }, { "name": "email:send", "description": "Sends emails to single or multiple recipients", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--attachment" ], "description": "Path for the file that you want to attach", "args": [ { "name": "attachment", "template": "filepaths" } ] }, { "names": [ "--from" ], "description": "Email address of the sender", "args": [ { "name": "from" } ] }, { "names": [ "--no-attachment" ], "description": "Do not include or prompt for an attachment" }, { "names": [ "--subject" ], "description": "The subject line for an email", "args": [ { "name": "subject" } ] }, { "names": [ "--text" ], "description": "Text to send within the email body", "args": [ { "name": "text" } ] }, { "names": [ "--to" ], "description": "Email address of recipient (comma-separated)", "args": [ { "name": "to" } ] } ] }, { "name": "email:set", "description": "Sets a default sending email address and subject line", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--from" ], "description": "Email address of the sender", "args": [ { "name": "from" } ] }, { "names": [ "--subject" ], "description": "The subject line for an email", "args": [ { "name": "subject" } ] } ] }, { "name": "feedback", "description": "Provide feedback to the CLI team", "hidden": true }, { "name": "login", "description": "Create a new profile to store Twilio Account credentials and configuration", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "-f", "--force" ], "description": "Force overwriting existing profile credentials" }, { "names": [ "-p", "--profile" ], "description": "Shorthand identifier for your profile", "args": [ { "name": "profile" } ] }, { "names": [ "--auth-token" ], "description": "Your Twilio Auth Token for your Twilio Account or Subaccount", "args": [ { "name": "auth-token" } ] }, { "names": [ "--region" ], "description": "Twilio region to use", "args": [ { "name": "region" } ] } ] }, { "name": "phone-numbers:buy:local", "description": "Purchase a local phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:machine-to-machine", "description": "Purchase a machine-to-machine phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:mobile", "description": "Purchase a mobile phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:national", "description": "Purchase a national phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:shared-cost", "description": "Purchase a shared-cost phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:toll-free", "description": "Purchase a toll-free phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:buy:voip", "description": "Purchase a voip phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--country-code" ], "description": "The ISO-3166-1 country code of the country from which to read phone numbers", "isRequired": true, "args": [ { "name": "country-code", "suggestions": [ "AD - Andorra", "AE - United Arab Emirates", "AF - Afghanistan", "AG - Antigua and Barbuda", "AI - Anguilla", "AL - Albania", "AM - Armenia", "AO - Angola", "AQ - Antarctica", "AR - Argentina", "AS - American Samoa", "AT - Austria", "AU - Australia", "AW - Aruba", "AX - Åland Islands", "AZ - Azerbaijan", "BA - Bosnia and Herzegovina", "BB - Barbados", "BD - Bangladesh", "BE - Belgium", "BF - Burkina Faso", "BG - Bulgaria", "BH - Bahrain", "BI - Burundi", "BJ - Benin", "BL - Saint Barthélemy", "BM - Bermuda", "BN - Brunei Darussalam", "BO - Bolivia (Plurinational State of)", "BQ - Bonaire, Sint Eustatius and Saba", "BR - Brazil", "BS - Bahamas", "BT - Bhutan", "BV - Bouvet Island", "BW - Botswana", "BY - Belarus", "BZ - Belize", "CA - Canada", "CC - Cocos (Keeling) Islands", "CD - Congo, Democratic Republic of the", "CF - Central African Republic", "CG - Congo", "CH - Switzerland", "CI - Côte d'Ivoire", "CK - Cook Islands", "CL - Chile", "CM - Cameroon", "CN - China", "CO - Colombia", "CR - Costa Rica", "CU - Cuba", "CV - Cabo Verde", "CW - Curaçao", "CX - Christmas Island", "CY - Cyprus", "CZ - Czechia", "DE - Germany", "DJ - Djibouti", "DK - Denmark", "DM - Dominica", "DO - Dominican Republic", "DZ - Algeria", "EC - Ecuador", "EE - Estonia", "EG - Egypt", "EH - Western Sahara", "ER - Eritrea", "ES - Spain", "ET - Ethiopia", "FI - Finland", "FJ - Fiji", "FK - Falkland Islands (Malvinas)", "FM - Micronesia (Federated States of)", "FO - Faroe Islands", "FR - France", "GA - Gabon", "GB - United Kingdom of Great Britain and Northern Ireland", "GD - Grenada", "GE - Georgia", "GF - French Guiana", "GG - Guernsey", "GH - Ghana", "GI - Gibraltar", "GL - Greenland", "GM - Gambia", "GN - Guinea", "GP - Guadeloupe", "GQ - Equatorial Guinea", "GR - Greece", "GS - South Georgia and the South Sandwich Islands", "GT - Guatemala", "GU - Guam", "GW - Guinea-Bissau", "GY - Guyana", "HK - Hong Kong", "HM - Heard Island and McDonald Islands", "HN - Honduras", "HR - Croatia", "HT - Haiti", "HU - Hungary", "ID - Indonesia", "IE - Ireland", "IL - Israel", "IM - Isle of Man", "IN - India", "IO - British Indian Ocean Territory", "IQ - Iraq", "IR - Iran (Islamic Republic of)", "IS - Iceland", "IT - Italy", "JE - Jersey", "JM - Jamaica", "JO - Jordan", "JP - Japan", "KE - Kenya", "KG - Kyrgyzstan", "KH - Cambodia", "KI - Kiribati", "KM - Comoros", "KN - Saint Kitts and Nevis", "KP - Korea (Democratic People's Republic of)", "KR - Korea, Republic of", "KW - Kuwait", "KY - Cayman Islands", "KZ - Kazakhstan", "LA - Lao People's Democratic Republic", "LB - Lebanon", "LC - Saint Lucia", "LI - Liechtenstein", "LK - Sri Lanka", "LR - Liberia", "LS - Lesotho", "LT - Lithuania", "LU - Luxembourg", "LV - Latvia", "LY - Libya", "MA - Morocco", "MC - Monaco", "MD - Moldova, Republic of", "ME - Montenegro", "MF - Saint Martin (French part)", "MG - Madagascar", "MH - Marshall Islands", "MK - North Macedonia", "ML - Mali", "MM - Myanmar", "MN - Mongolia", "MO - Macao", "MP - Northern Mariana Islands", "MQ - Martinique", "MR - Mauritania", "MS - Montserrat", "MT - Malta", "MU - Mauritius", "MV - Maldives", "MW - Malawi", "MX - Mexico", "MY - Malaysia", "MZ - Mozambique", "NA - Namibia", "NC - New Caledonia", "NE - Niger", "NF - Norfolk Island", "NG - Nigeria", "NI - Nicaragua", "NL - Netherlands", "NO - Norway", "NP - Nepal", "NR - Nauru", "NU - Niue", "NZ - New Zealand", "OM - Oman", "PA - Panama", "PE - Peru", "PF - French Polynesia", "PG - Papua New Guinea", "PH - Philippines", "PK - Pakistan", "PL - Poland", "PM - Saint Pierre and Miquelon", "PN - Pitcairn", "PR - Puerto Rico", "PS - Palestine, State of", "PT - Portugal", "PW - Palau", "PY - Paraguay", "QA - Qatar", "RE - Réunion", "RO - Romania", "RS - Serbia", "RU - Russian Federation", "RW - Rwanda", "SA - Saudi Arabia", "SB - Solomon Islands", "SC - Seychelles", "SD - Sudan", "SE - Sweden", "SG - Singapore", "SH - Saint Helena, Ascension and Tristan da Cunha", "SI - Slovenia", "SJ - Svalbard and Jan Mayen", "SK - Slovakia", "SL - Sierra Leone", "SM - San Marino", "SN - Senegal", "SO - Somalia", "SR - Suriname", "SS - South Sudan", "ST - Sao Tome and Principe", "SV - El Salvador", "SX - Sint Maarten (Dutch part)", "SY - Syrian Arab Republic", "SZ - Eswatini", "TC - Turks and Caicos Islands", "TD - Chad", "TF - French Southern Territories", "TG - Togo", "TH - Thailand", "TJ - Tajikistan", "TK - Tokelau", "TL - Timor-Leste", "TM - Turkmenistan", "TN - Tunisia", "TO - Tonga", "TR - Turkey", "TT - Trinidad and Tobago", "TV - Tuvalu", "TW - Taiwan, Province of China", "TZ - Tanzania, United Republic of", "UA - Ukraine", "UG - Uganda", "UM - United States Minor Outlying Islands", "US - United States of America", "UY - Uruguay", "UZ - Uzbekistan", "VA - Holy See", "VC - Saint Vincent and the Grenadines", "VE - Venezuela (Bolivarian Republic of)", "VG - Virgin Islands (British)", "VI - Virgin Islands (U.S.)", "VN - Viet Nam", "VU - Vanuatu", "WF - Wallis and Futuna", "WS - Samoa", "YE - Yemen", "YT - Mayotte", "ZA - South Africa", "ZM - Zambia" ] } ] }, { "names": [ "--account-sid" ], "description": "The SID of the Account requesting the AvailablePhoneNumber resources", "args": [ { "name": "account-sid" } ] }, { "names": [ "--address-sid" ], "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations", "args": [ { "name": "address-sid" } ] }, { "names": [ "--api-version" ], "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`", "args": [ { "name": "api-version" } ] }, { "names": [ "--area-code" ], "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada", "args": [ { "name": "area-code" } ] }, { "names": [ "--beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--no-beta" ] }, { "names": [ "--no-beta" ], "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`", "exclusiveOn": [ "--beta" ] }, { "names": [ "--bundle-sid" ], "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations", "args": [ { "name": "bundle-sid" } ] }, { "names": [ "--contains" ], "description": "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", "args": [ { "name": "contains" } ] }, { "names": [ "--distance" ], "description": "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", "args": [ { "name": "distance" } ] }, { "names": [ "--emergency-address-sid" ], "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number", "args": [ { "name": "emergency-address-sid" } ] }, { "names": [ "--emergency-status" ], "description": "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", "args": [ { "name": "status", "suggestions": [ "active", "inactive" ] } ] }, { "names": [ "--exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-all-address-required" ] }, { "names": [ "--no-exclude-all-address-required" ], "description": "Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-all-address-required" ] }, { "names": [ "--exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-foreign-address-required" ] }, { "names": [ "--no-exclude-foreign-address-required" ], "description": "Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-foreign-address-required" ] }, { "names": [ "--exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--no-exclude-local-address-required" ] }, { "names": [ "--no-exclude-local-address-required" ], "description": "Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`", "exclusiveOn": [ "--exclude-local-address-required" ] }, { "names": [ "--fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--no-fax-enabled" ] }, { "names": [ "--no-fax-enabled" ], "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`", "exclusiveOn": [ "--fax-enabled" ] }, { "names": [ "--friendly-name" ], "description": "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", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--identity-sid" ], "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations", "args": [ { "name": "identity-sid" } ] }, { "names": [ "--in-lata" ], "description": "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", "args": [ { "name": "in-lata" } ] }, { "names": [ "--in-locality" ], "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number", "args": [ { "name": "in-locality" } ] }, { "names": [ "--in-postal-code" ], "description": "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", "args": [ { "name": "in-postal-code" } ] }, { "names": [ "--in-rate-center" ], "description": "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", "args": [ { "name": "in-rate-center" } ] }, { "names": [ "--in-region" ], "description": "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", "args": [ { "name": "in-region" } ] }, { "names": [ "--limit" ], "description": "The maximum number of resources to return. Use '--no-limit' to disable", "args": [ { "name": "limit" } ] }, { "names": [ "--mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-mms-enabled" ] }, { "names": [ "--no-mms-enabled" ], "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`", "exclusiveOn": [ "--mms-enabled" ] }, { "names": [ "--near-lat-long" ], "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada", "args": [ { "name": "near-lat-long" } ] }, { "names": [ "--near-number" ], "description": "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", "args": [ { "name": "near-number" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--page-size" ], "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000", "args": [ { "name": "page-size" } ] }, { "names": [ "--properties" ], "description": "The properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] }, { "names": [ "--sms-application-sid" ], "description": "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", "args": [ { "name": "sms-application-sid" } ] }, { "names": [ "--sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--no-sms-enabled" ] }, { "names": [ "--no-sms-enabled" ], "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`", "exclusiveOn": [ "--sms-enabled" ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL we should call when the new phone number receives an incoming SMS message", "args": [ { "name": "sms-url" } ] }, { "names": [ "--status-callback" ], "description": "The URL we should call using the `status_callback_method` to send status information to your application", "args": [ { "name": "status-callback" } ] }, { "names": [ "--status-callback-method" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--trunk-sid" ], "description": "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", "args": [ { "name": "trunk-sid" } ] }, { "names": [ "--voice-application-sid" ], "description": "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", "args": [ { "name": "voice-application-sid" } ] }, { "names": [ "--voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--no-voice-caller-id-lookup" ] }, { "names": [ "--no-voice-caller-id-lookup" ], "description": "Whether 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`", "exclusiveOn": [ "--voice-caller-id-lookup" ] }, { "names": [ "--voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--no-voice-enabled" ] }, { "names": [ "--no-voice-enabled" ], "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`", "exclusiveOn": [ "--voice-enabled" ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`", "args": [ { "name": "method", "suggestions": [ "head", "get", "post", "patch", "put", "delete" ] } ] }, { "names": [ "--voice-receive-mode" ], "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`", "args": [ { "name": "mode", "suggestions": [ "voice", "fax" ] } ] }, { "names": [ "--voice-url" ], "description": "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", "args": [ { "name": "voice-url" } ] } ] }, { "name": "phone-numbers:list", "description": "Show what Twilio phone numbers you have configured", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--account-sid" ], "description": "Access resources for the specified account", "args": [ { "name": "account-sid" } ] }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" }, { "names": [ "--properties" ], "description": "The incomingPhoneNumber object properties you would like to display (JSON output always shows all properties)", "args": [ { "name": "properties" } ] } ] }, { "name": "phone-numbers:update", "description": "Update the properties of a Twilio phone number", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--account-sid" ], "description": "Access resources for the specified account", "args": [ { "name": "account-sid" } ] }, { "names": [ "--friendly-name" ], "description": "A human readable descriptive text for this resource, up to 64 characters long", "args": [ { "name": "friendly-name" } ] }, { "names": [ "--sms-fallback-method" ], "description": "The HTTP method that should be used to request the SmsFallbackUrl", "args": [ { "name": "method", "suggestions": [ "GET", "POST" ] } ] }, { "names": [ "--sms-fallback-url" ], "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl", "args": [ { "name": "sms-fallback-url" } ] }, { "names": [ "--sms-method" ], "description": "The HTTP method Twilio will use when making requests to the SmsUrl", "args": [ { "name": "method", "suggestions": [ "GET", "POST" ] } ] }, { "names": [ "--sms-url" ], "description": "The URL that Twilio should request when somebody sends an SMS to the new phone number", "args": [ { "name": "sms-url" } ] }, { "names": [ "--voice-fallback-method" ], "description": "The HTTP method Twilio will use when requesting the VoiceFallbackUrl", "args": [ { "name": "method", "suggestions": [ "GET", "POST" ] } ] }, { "names": [ "--voice-fallback-url" ], "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by VoiceUrl", "args": [ { "name": "voice-fallback-url" } ] }, { "names": [ "--voice-method" ], "description": "The HTTP method Twilio will use when making requests to the VoiceUrl", "args": [ { "name": "method", "suggestions": [ "GET", "POST" ] } ] }, { "names": [ "--voice-url" ], "description": "The URL that Twilio should request when somebody dials the phone number", "args": [ { "name": "voice-url" } ] } ], "args": [ { "name": "phone-number", "description": "The SID or E.164 formatted phone number you wish to update" } ] }, { "name": "plugins:available", "description": "List available plugins for installation", "hidden": true }, { "name": "plugins:inspect", "description": "Displays installation properties of a plugin", "hidden": true, "options": [ { "names": [ "-v", "--verbose" ] } ], "args": [ { "name": "plugin", "description": "Plugin to inspect" } ] }, { "name": "plugins:install", "description": "Installs a plugin into the CLI", "hidden": true, "options": [ { "names": [ "-f", "--force" ], "description": "`yarn install` with force flag" }, { "names": [ "-v", "--verbose" ] } ], "args": [ { "name": "plugin", "description": "Plugin to install" } ] }, { "name": "plugins:link", "description": "Links a plugin into the CLI for development", "hidden": true, "options": [ { "names": [ "-v", "--verbose" ] } ], "args": [ { "name": "path", "template": "filepaths" } ] }, { "name": "plugins:uninstall", "description": "Removes a plugin from the CLI", "hidden": true, "options": [ { "names": [ "-v", "--verbose" ] } ], "args": [ { "name": "plugin" } ] }, { "name": "plugins:update", "description": "Update installed plugins", "hidden": true, "options": [ { "names": [ "-v", "--verbose" ] } ] }, { "name": "profiles:add", "description": "Create a new profile to store Twilio Account credentials and configuration", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "-f", "--force" ], "description": "Force overwriting existing profile credentials" }, { "names": [ "-p", "--profile" ], "description": "Shorthand identifier for your profile", "args": [ { "name": "profile" } ] }, { "names": [ "--auth-token" ], "description": "Your Twilio Auth Token for your Twilio Account or Subaccount", "args": [ { "name": "auth-token" } ] }, { "names": [ "--region" ], "description": "Twilio region to use", "args": [ { "name": "region" } ] } ] }, { "name": "profiles:create", "description": "Create a new profile to store Twilio Account credentials and configuration", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "-f", "--force" ], "description": "Force overwriting existing profile credentials" }, { "names": [ "-p", "--profile" ], "description": "Shorthand identifier for your profile", "args": [ { "name": "profile" } ] }, { "names": [ "--auth-token" ], "description": "Your Twilio Auth Token for your Twilio Account or Subaccount", "args": [ { "name": "auth-token" } ] }, { "names": [ "--region" ], "description": "Twilio region to use", "args": [ { "name": "region" } ] } ] }, { "name": "profiles:list", "description": "Show what profiles you have configured", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" }, { "names": [ "--no-header" ], "description": "Skip including of headers while listing the data" } ] }, { "name": "profiles:port", "description": "Port API keys from keytar to config file. This command ports ALL keys by default, although to only port a specific key append the profile-id as additional argument", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" } ], "args": [ { "name": "profile" } ] }, { "name": "profiles:remove", "description": "Select which profile to remove", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" } ], "args": [ { "name": "profile" } ] }, { "name": "profiles:use", "description": "Select which profile to use", "hidden": true, "options": [ { "names": [ "-l" ], "args": [ { "name": "level", "description": "Level of logging messages", "suggestions": [ "debug", "info", "warn", "error", "none" ] } ] }, { "names": [ "-o" ], "description": "Format of command output", "args": [ { "name": "format", "suggestions": [ "columns", "json", "tsv", "none" ] } ] }, { "names": [ "--silent" ], "description": "Suppress output and logs. This is a shorthand for \"-l none -o none\"" } ], "args": [ { "name": "profile" } ] }, { "name": "update", "description": "Update the twilio CLI", "hidden": true, "options": [ { "names": [ "--from-local" ], "description": "Interactively choose an already installed version" } ], "args": [ { "name": "channel", "isOptional": true } ] }, { "name": "help", "args": [ { "name": "command", "isOptional": true } ] }, { "name": "plugins", "description": "List installed plugins", "hidden": true, "options": [ { "names": [ "--core" ], "description": "List core plugins" } ] } ] }