$ npm install -g @vonage/cli-plugin-numbers
$ @vonage/cli-plugin-numbers COMMAND
running command...
$ @vonage/cli-plugin-numbers (--version)
@vonage/cli-plugin-numbers/1.2.2 darwin-arm64 node-v16.18.1
$ @vonage/cli-plugin-numbers --help [COMMAND]
USAGE
$ @vonage/cli-plugin-numbers COMMAND
...@vonage/cli-plugin-numbers numbers@vonage/cli-plugin-numbers numbers:buy [NUMBER] [COUNTRYCODE]@vonage/cli-plugin-numbers numbers:cancel [NUMBER] [COUNTRYCODE]@vonage/cli-plugin-numbers numbers:search [COUNTRYCODE]@vonage/cli-plugin-numbers numbers:update NUMBER COUNTRYCODE --url=https://www.example.com
manage your Vonage numbers
USAGE
$ @vonage/cli-plugin-numbers numbers [--apiKey <value> --apiSecret <value>] [--appId <value> --keyFile
<value>] [--sort <value>] [--filter <value>] [--output csv|json|yaml | | ] [-x | ] [--no-header | ]
FLAGS
-x, --extended show extra columns
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
VONAGE API FLAGS FLAGS
--apiKey=<value>
--apiSecret=<value>
VONAGE APPLICATION FLAGS FLAGS
--appId=<value>
--keyFile=<value>
DESCRIPTION
manage your Vonage numbers
EXAMPLES
vonage number
See code: dist/commands/numbers/index.js
buy a Vonage number
USAGE
$ @vonage/cli-plugin-numbers numbers:buy [NUMBER] [COUNTRYCODE] [--apiKey <value> --apiSecret <value>] [--appId
<value> --keyFile <value>]
VONAGE API FLAGS FLAGS
--apiKey=<value>
--apiSecret=<value>
VONAGE APPLICATION FLAGS FLAGS
--appId=<value>
--keyFile=<value>
DESCRIPTION
buy a Vonage number
See code: dist/commands/numbers/buy.js
cancel a Vonage number
USAGE
$ @vonage/cli-plugin-numbers numbers:cancel [NUMBER] [COUNTRYCODE] [--apiKey <value> --apiSecret <value>] [--appId
<value> --keyFile <value>]
VONAGE API FLAGS FLAGS
--apiKey=<value>
--apiSecret=<value>
VONAGE APPLICATION FLAGS FLAGS
--appId=<value>
--keyFile=<value>
DESCRIPTION
cancel a Vonage number
See code: dist/commands/numbers/cancel.js
search for available Vonage numbers
USAGE
$ @vonage/cli-plugin-numbers numbers:search [COUNTRYCODE] [--apiKey <value> --apiSecret <value>] [--appId <value>
--keyFile <value>] [--type landline|mobile-lvn|landline-toll-free] [--startsWith <value> | --endsWith <value> |
--contains <value>] [--features SMS|VOICE|SMS,VOICE|MMS|SMS,MMS|VOICE,MMS|SMS,MMS,VOICE]
FLAGS
--contains=<value> Filter from anywhere in the phone number.
--endsWith=<value> Filter from the end of the phone number.
--features=<option> Available features are SMS, VOICE and MMS. To look for numbers that support multiple features,
use a comma-separated value: SMS,MMS,VOICE.
<options: SMS|VOICE|SMS,VOICE|MMS|SMS,MMS|VOICE,MMS|SMS,MMS,VOICE>
--startsWith=<value> Filter from the start of the phone number.
--type=<option> Filter by type of number, such as mobile or landline
<options: landline|mobile-lvn|landline-toll-free>
VONAGE API FLAGS FLAGS
--apiKey=<value>
--apiSecret=<value>
VONAGE APPLICATION FLAGS FLAGS
--appId=<value>
--keyFile=<value>
DESCRIPTION
search for available Vonage numbers
EXAMPLES
vonage numbers:search US
vonage numbers:search US --startsWith=1555
vonage numbers:search US --features=VOICE,SMS --endsWith=1234
See code: dist/commands/numbers/search.js
update a Vonage Number
USAGE
$ @vonage/cli-plugin-numbers numbers:update NUMBER COUNTRYCODE --url=https://www.example.com
FLAGS
--url=<value> url for mobile inbound webhook
VONAGE API FLAGS FLAGS
--apiKey=<value>
--apiSecret=<value>
VONAGE APPLICATION FLAGS FLAGS
--appId=<value>
--keyFile=<value>
DESCRIPTION
update a Vonage Number
See code: dist/commands/numbers/update.js