@vonage/cli-plugin-numbers

@vonage/cli-plugin-numbers

• Usage
• Commands

Usage

$ npm install -g @vonage/cli-plugin-numbers
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@vonage/cli-plugin-numbers/1.1.0 linux-x64 node-v12.18.2
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...

Commands

• oclif-example numbers
• oclif-example numbers:buy [NUMBER] [COUNTRYCODE]
• oclif-example numbers:cancel [NUMBER] [COUNTRYCODE]
• oclif-example numbers:search [COUNTRYCODE]
• oclif-example numbers:update NUMBER COUNTRYCODE --url=https://www.example.com

oclif-example numbers

manage your Vonage numbers

USAGE
  $ oclif-example numbers

OPTIONS
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

EXAMPLE
  vonage number

See code: dist/commands/numbers/index.ts

oclif-example numbers:buy [NUMBER] [COUNTRYCODE]

buy a Vonage number

USAGE
  $ oclif-example numbers:buy [NUMBER] [COUNTRYCODE]

OPTIONS
  -h, --help  show CLI help

See code: dist/commands/numbers/buy.ts

oclif-example numbers:cancel [NUMBER] [COUNTRYCODE]

cancel a Vonage number

USAGE
  $ oclif-example numbers:cancel [NUMBER] [COUNTRYCODE]

OPTIONS
  -h, --help  show CLI help

See code: dist/commands/numbers/cancel.ts

oclif-example numbers:search [COUNTRYCODE]

search for available Vonage numbers

USAGE
  $ oclif-example numbers:search [COUNTRYCODE]

OPTIONS
  -h, --help                                                          show CLI help
  --contains=contains                                                 Filter from anywhere in the phone number.
  --endsWith=endsWith                                                 Filter from the end of the phone number.

  --features=SMS|VOICE|SMS,VOICE|MMS|SMS,MMS|VOICE,MMS|SMS,MMS,VOICE  Available features are SMS, VOICE and MMS. To look
                                                                      for numbers that support multiple features, use a
                                                                      comma-separated value: SMS,MMS,VOICE.

  --startsWith=startsWith                                             Filter from the start of the phone number.

  --type=landline|mobile-lvn|landline-toll-free                       Filter by type of number, such as mobile or
                                                                      landline

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.ts

oclif-example numbers:update NUMBER COUNTRYCODE --url=https://www.example.com

update a Vonage Number

USAGE
  $ oclif-example numbers:update NUMBER COUNTRYCODE --url=https://www.example.com

OPTIONS
  -h, --help  show CLI help
  --url=url   url for mobile inbound webhook

See code: dist/commands/numbers/update.ts