{"id":20364366,"url":"https://github.com/bandwidth/bandwidth-cli","last_synced_at":"2025-04-12T04:41:44.748Z","repository":{"id":42246844,"uuid":"267103893","full_name":"Bandwidth/bandwidth-cli","owner":"Bandwidth","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-28T06:45:39.000Z","size":778,"stargazers_count":4,"open_issues_count":23,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-14T06:08:59.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bandwidth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-26T17:09:34.000Z","updated_at":"2024-01-18T04:12:45.000Z","dependencies_parsed_at":"2023-12-26T05:29:49.550Z","dependency_job_id":"290d401b-494a-458e-95cb-bfbd7068dbc4","html_url":"https://github.com/Bandwidth/bandwidth-cli","commit_stats":{"total_commits":251,"total_committers":6,"mean_commits":"41.833333333333336","dds":0.03984063745019917,"last_synced_commit":"2c22b26d9005269c95e310da60e7759e628b6534"},"previous_names":["bandwidth/band-cli"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bandwidth%2Fbandwidth-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bandwidth%2Fbandwidth-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bandwidth%2Fbandwidth-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bandwidth%2Fbandwidth-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bandwidth","download_url":"https://codeload.github.com/Bandwidth/bandwidth-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248519316,"owners_count":21117756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T00:11:25.579Z","updated_at":"2025-04-12T04:41:44.726Z","avatar_url":"https://github.com/Bandwidth.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QuickStart CLI\nThis CLI allows you to order phone numbers and create the necessary [Bandwidth applications](https://dev.bandwidth.com/account/applications/about.html) to quickly setup your development environment and callback\nsettings with Bandwidth. In addition, this quick-setup automates the necessary steps required to order\nyour first number with Bandwidth.\n\nThese quick-setup configurations are stored in the CLI and automatically used in any\norders that are placed through the CLI.\n\nExpected workflow for new account users: [setup](#installationsetup), then [quickly set up your account](#gettingstarted). \n\nThe CLI also allows existing account users that have previously set up their development environment to automate the setup of additional applications and place new number orders.\n\n## Table of Contents\n- [table of contents](#table-of-contents)\n- [setup](#installationsetup)\n- [getting started with Bandwidth](#getting-started-with-bandwidth)\n\n### Reference Materials\n- [Bandwidth's Dev Docs](https://dev.bandwidth.com)\n- [Bandwidth Dashboard Homepage](https://dashboard.bandwidth.com)\n\n### Pre-Reqs\n\nYou must have your Bandwidth Dashboard API credentials. These credentials are used to authenticate against the Dashboard, Voice, and Messaging APIs.\n\nIn order to send text messages and create phone calls, you need a URL that accepts Bandwidth callbacks. [ngrok](https://ngrok.com/) can be used to start a server locally, or [request bin](https://requestbin.com/) can be used to set up a URL remote. Take note that callbacks do contain phone numbers, so be cautious when using any publicly accessible URLs.\n\nInformation on Bandwidth's callback can be found [on our dev site](https://dev.bandwidth.com/guides/callbacks/callbacks.html).\n\n### List of CLI Commands\n| command   | Description |\n| ----------- | ----------- |\n|[create](#create)|Create sip peers/locations, sites/sub-accounts, and applications\n|[default](#default)|Manage default sip peers/locations, sites/sub-accounts, messaging applications, and number\n|[delete](#delete)| Delete sip peers/locations, sites/sub-accounts, and applications\n|[list](#list)| List sip peers/locations, sites/sub-accounts, applications, and numbers associated with sites and sip peers\n|[login](#login)| Login to your bandwidth account to use this tool\n|[message](#message)| Send a text message through Bandwidth\n|[order](#order)|Order phone numbers\n|[quickstart](#quickstart)|Set up your account quickly and process details automatically\n|[accountInfo](#accountInfo)|View products enabled on your account\n\n## Installation/Setup\nThis Bandwidth CLI uses nodeJs version 12. If node is not installed on your computer, visit https://nodejs.org/en/download/ for installation instructions for node. If you have node, check your version with `node -v`\n\nWith node on your machine, install the package globally through npm (or yarn)\n```\nnpm install -g @bandwidth/quickstart-cli\n\nor\n\nyarn global add @bandwidth/quickstart-cli\n```\n\nlog into your bandwidth account by specifying your account id, and your dashboard username and password. \n**The account should be a messaging account. Other account types, such as voice or 911, are currently not supported.**\n\n\n```\n\u003ebandwidth login\nLeaving a field blank will keep it at its previous value.\n? Please enter your Bandwidth dashboard username myUsername\n? Please enter your Bandwidth dashboard password. This will be securely stored. **********\n? Please enter your Bandwidth account ID. 1234567\nYour credentials have been saved. You can now start using the CLI.\n```\n\n## Getting Started With Bandwidth\nFirst time users should use the `quickstart` command to get started. You can use `quickstart` to order a number without prior\nsetup, or simply setup your account (and order numbers later). `quickstart` can be used as many times as needed, and will automatically set up a new site, sippeer, and application without interacting with or influencing existing account settings. \n\n*Note: quickstart will often fail if multiple CLIs were used, as no duplicate names are allowed for messaging applications. To specify a messaging application name, use `bandwidth quickstart --custom`\n\n![Callbacks and bandwidth](https://dev.bandwidth.com/images/bandwidth_callbacks.png)\nMore information about callback urls can be found at https://dev.bandwidth.com/guides/callbacks/callbacks.html\n\n```\n\u003ebandwidth quickstart\n? Please enter a message callbackUrl. Information about sent messages will be sent here. Visit https://dev.bandwidth.com/guides/callbacks/callbacks.html for information on Bandwidth callbacks. (example: http://example.com)\n\u003ehttp://example.com\n\nMessaging application created with id b01b1a3d-230a-467a-b143-3974fccc1ad0\nSite created with id 37390\nSip Peer created with id 624642\n\n? order a phone number?\n\u003eYes\n? Found 10 numbers. Choose which to order.\n (*) 9195007741\n (*) 9195181224\n\u003e(*) 9195182893\n ( ) 9195182967\n ( ) 9195784173\n ( ) 9196703710\n ( ) 9197060281\n(Move up and down to reveal more choices)\n? order 3 phone numbers? Yes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-10T22:03:45.475Z\nnote: Created a new number order for 3 numbers from RALEIGH, NC\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"9195007741\"\n  - \"9195181224\"\n  - \"9195182893\"\n\nsetup successful. To order more numbers using this setup, use \"bandwidth order category \u003cquantity\u003e\" or \"bandwidth order search \u003cquantity\u003e\"\n\n```\nAt this point, you can now use the number for [messages](https://dev.bandwidth.com/messaging/methods/messages/createMessage.html) or [SDKs](https://dev.bandwidth.com/sdks/about.html). Should you need more (or different) numbers than the 10 that were offered, you can order more numbers using [`bandwidth order`](#order).\n\n## commands\n[Commands Table of Contents](#list-of-cli-commands)\n\nnotes:\n- `bandwidth \u003ccommand\u003e --help` is available in the cli for usage and flag notes. \n- `bw` is an alias for bandwidth. `bw order number 123456789` is a valid syntax for the cli.\n\n### quickstart\nusage: `bandwidth quickstart`\n\nSet up your account quickly and process details automatically to immediately enable number\nordering and development.\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|-v, --verbose| Increase setup verbosity| no\n\n```\n\u003ebandwidth quickstart\n? Please enter a message callbackUrl. Information about sent messages will be sent here. Visit https://dev.bandwidth.com/guides/callbacks/callbacks.html for information on Bandwidth callbacks. (example: http://example.com)\n\u003ehttp://example.com\n\nMessaging application created with id b01b1a3d-230a-467a-b143-3974fccc1ad0\nSite created with id 37390\nSip Peer created with id 624642\n\n? order a phone number?\n\u003eYes\n? Found 10 numbers. Choose which to order.\n (*) 9195007741\n (*) 9195181224\n\u003e(*) 9195182893\n ( ) 9195182967\n ( ) 9195784173\n ( ) 9196703710\n ( ) 9197060281\n(Move up and down to reveal more choices)\n? order 3 phone numbers? Yes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-10T22:03:45.475Z\nnote: Created a new number order for 3 numbers from RALEIGH, NC\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"9195007741\"\n  - \"9195181224\"\n  - \"9195182893\"\n\nsetup successful. To order more numbers using this setup, use \"bandwidth order category \u003cquantity\u003e\" or \"bandwidth order search \u003cquantity\u003e\"\n\n```\n\n\n### create\nused to create sites(also known as sub-accounts), sip peers (also known as locations), applications.\n#### create site\n\nusage: `bandwidth create site \u003csitename\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --address-type, -t| must be either billing or service.| yes\n\n```\n\u003ebandwidth create site --address-type billing \"my site name\"\nSite created. See details of your created Site below.\n\nid: 37390\nname: my site name\naddress:\n  houseNumber: 900\n  streetName: MAIN CAMPUS\n  streetSuffix: DR\n  city: RALEIGH\n  stateCode: NC\n  zip: 27606\n  plusFour: 5177\n  country: United States\n  addressType: Billing\n\u003ebandwidth create site --address-type service \"my site name\"\nSite created. See details of your created Site below.\n\nid: 37391\nname: my site name\naddress:\n  houseNumber: 900\n  streetName: MAIN CAMPUS\n  streetSuffix: DR\n  city: RALEIGH\n  stateCode: NC\n  zip: 27606\n  plusFour: 5177\n  country: United States\n  addressType: Service\n```\n\n#### create sip peer\nCreate a sip peer (also known as location). Since all sip peers are nested under sub-accounts/sites,\na siteId must be specified if no default site is set.\n\nThis command will automatically turn on sms and link the default messageApp to the site as a messaging application. \nAutomatic voice application linking is not yet supported by this CLI and will result in an error.\n\nusage: `bandwidth create sippeer \u003cpeername\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --site-id, -s| A valid site Id to put the peer under.| no (yes if no default site is configured.)\n| --default, -d| Make this a default sip peer under the site. This is stored in your account and is **not** the same as the `bandwidth default` command.| no\n\n```\n\u003ebandwidth create sippeer \"my peer name\"\nUsing default site 37397\nPeer created successfully...\nenabled SMS by default.\nLinked created Sip Peer to default messageApp 2065a8e4-20a7-4ec7-9e85-a1944fc5ad4c\nSip Peer created. See details of your created Peer below.\n\npeerId: 624651\npeerName: \"my peer name\"\nisDefaultPeer: false\nvoiceHosts: 0\nvoiceHostGroups: 0\nproducts:\n  product: TERMINATION\nid: 624651\nsiteId: 37397\n```\n\nor, manually specify site Id\n\n```\n\u003ebandwidth create sippeer --site-id mysiteId peername\nPeer created successfully...\nenabled SMS by default.\nLinked created Sip Peer to default messageApp 2065a8e4-20a7-4ec7-9e85-a1944fc5ad4c\nSip Peer created. See details of your created Peer below.\n\npeerId: 624651\npeerName: peername\nisDefaultPeer: false\nvoiceHosts: 0\nvoiceHostGroups: 0\nproducts:\n  product: TERMINATION\nid: 624651\nsiteId: 37397\n```\n\n#### create application\nCreate a voice or messaging application. Note that messaging applications cannot have duplicate names. \n\nusage: `bandwidth create app --type \u003ctype\u003e \u003cappname\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --type, -t| Specify whether the application is `voice` or `messaging`.| yes\n\n```\ncreate a messaging application\n\n\u003ebandwidth create application --type messaging appname\n? Please enter a message callbackUrl. Information about sent messages will be sent here. Visit https://dev.bandwidth.com/guides/callbacks/callbacks.html for information on Bandwidth callbacks. (example: http://example.com)\n\u003ehttp://example.com\nMessaging application created. See details of your created application below.\n\napplicationId: 2c9a96e7-0869-4a6c-94b7-ad39c15db38a\nserviceType: Messaging-V2\nappName: appname\ncallbackUrl: http://example.com\nmsgCallbackUrl: http://example.com\ncallbackCreds: 0\n```\n\nor create a voice application\n\n```\n\u003ebandwidth create application --type voice appname\n? Please enter a callInitiatedCallbackUrl. Information for outbound calls will be sent here, and Bandwidth will attempt\nto grab BXML at this endpoint. (example: http://example.com)\n\u003ehttp://example.com\nVoice application created. See details of your created application below.\n\napplicationId: cfa5dcf5-02ab-4451-af15-88548fa35777\nserviceType: Voice-V2\nappName: appname\ncallInitiatedCallbackUrl: http://example.com\ncallInitiatedMethod: POST\n\n```\n\n### default\nSet, view, and manage a default site(subaccount), sip peer (location), and application. Defaults are\nused automatically for required fields if none are specified. For example, when [ordering](#order) a\nnumber, the default site and sip peer will be used if none are specified.\n\n**Note that defaults, as referred to in this CLI, is different from the default sip peer of a site, as referred to in the rest of the bandwidth API docs**\n\nusage:\n```\nbandwidth default                                       //list all defaults\nbandwidth default \u003cdefault-field\u003e                       //print the value of a particular default\nbandwidth default \u003cdefault-field\u003e \u003cdefault-value\u003e       //set a new default\nbandwidth default -d \u003cdefault-field\u003e                    //delete a default\n```\nCurrent accepted `default-field`s include `site`, `sippeer`, `messageApp`, and `number`. \n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --delete, -d| delete the settings of a default| no\n\n```\n\u003ebandwidth default\nsippeer: 837494\nsite: 30673\napplication: 48e92ba2-20a7-9f8a-9e85-a1944fc5ad4c\n\n\n\u003ebandwidth default site\n30673\n\n\u003ebandwidth default site 12345\nDefault site set.\n\n\u003ebandwidth default site\n12345\n\n\u003ebandwidth default site -d\nDefault site deleted\n\n\u003ebandwidth default\nsippeer: 837494\napplication: 48e92ba2-20a7-9f8a-9e85-a1944fc5ad4c\n```\n\n\n### delete\nDelete sites(also known as sub-accounts), sip peers (also known as locations), applications.\n\n#### delete site\nDelete a site\n\nusage: `bandwidth delete site \u003csite-id\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --force, -f| Force-delete the site and remove sip peers| no\n| --verbose, -v| Increase verbosity of output when force deleting| no\n\n```\n\u003ebandwidth delete site 37397\nSite successfully deleted.\n```\n\nOr force delete all necessary components to delete the site, including all nested sip peers..\n\n```\n\u003ebandwidth delete site 37731 --force --verbose\nPhone numbers associated with sip peer 625370 have been disconnected        //applications are disconnected but not deleted.\nApplication unlinked from sip peer 625370\nSMS deleted from sip peer 625370\nSip peer 625370 deleted.                                                    //Force deleting a site automatically removes all sip peers.\nSite successfully deleted.\n```\n\n#### delete sippeer\nDelete a sippeer\n\nusage: `bandwidth delete sippeer \u003cpeer-id\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --site-id, -s| Specify the ID of the site that the peer is in| no (yes if no default site is configured.)\n| --force, -f| Force delete by removing all numbers and settings.| no \n| --verbose, -v| Increase verbosity of output when force deleting| no\n\n```\n\u003ebandwidth delete sippeer --site-id 37397 624651\nSip Peer successfully deleted.\n```\n\nOr force delete all necessary components to delete the peer.\n```\n\u003ebandwidth delete peer --force --verbose --site-id 37731 625370\nPhone numbers associated with sip peer 625370 have been disconnected        //applications are disconnected but not deleted.\nApplication unlinked from sip peer 625370\nSMS deleted from sip peer 625370\nSip peer 625370 deleted.\n```\n\n#### delete application\nDelete an application\n\nusage: `bandwidth delete app \u003capp-id\u003e`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n| --force, -f| Delete the application even if it is linked to a peer/location.| no\n\n```\n\u003ebandwidth delete app 241f63fe-4a46-4a64-893c-f71d775603b2\nApplication successfully deleted\n```\n\n### list\nList [sites](#list-site)(subaccounts), [sip peers](#list-peer)(locations), [applications](#list-application), or [numbers](#list-numbers) associated with certain sites/subaccounts. \n\n#### list site\n\nusage: `bandwidth list site`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|none|\n\n```\n\u003ebandwidth list site\n\n┌─────────┬──────────────────────────────────┬──────────────┐\n│ (index) │               name               │ sipPeerCount │\n├─────────┼──────────────────────────────────┼──────────────┤\n│   123   │             'site1'              │      7       │\n│   456   │          'site no two'           │      1       │\n└─────────┴──────────────────────────────────┴──────────────┘\n```\n#### list peer\n\nusage: `bandwidth list sippeer [site-id]`\n\nSiteid is required unless a default site id is set, in which case the peers under the default\nsite will be listed instead.\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|none|\n\n```\n\u003ebandwidth list sippeer 45928\n┌─────────┬──────────────────┬───────────────┐\n│ (index) │     peerName     │ isDefaultPeer │\n├─────────┼──────────────────┼───────────────┤\n│ 624650  │ 'My Sip Peer 23' │     true      │\n│ 624651  │    'peername'    │     false     │\n└─────────┴──────────────────┴───────────────┘\n```\n\n#### list application\n\nusage: `bandwidth list app`\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|none|\n\n```\n\u003ebandwidth list application\n\n┌──────────────────────────────────────┬────────────────┬───────────────────────────────┐\n│               (index)                │  serviceType   │            appName            │\n├──────────────────────────────────────┼────────────────┼───────────────────────────────┤\n│ 77762e2e-59ff-4fb4-8586-fee69f073ed9 │ 'Messaging-V2' │   'your cool messaging app'   │\n│ ecbba874-6be3-41b9-a63f-20bbb1c9dc95 │   'Voice-V2'   │            'name'             │\n└──────────────────────────────────────┴────────────────┴───────────────────────────────┘\n```\n\n#### list numbers\nList all numbers and their associated siteId and sip peer id. You can search numbers globally, at the site level, or at the sip peer level. By default, the numbers will be turned into a csv and stored in the current working directory (cwd) under `bandwidth-numbers.csv`. \n\nCLI-level defaults are not used, so `*` or a `site-id` is required. \n\nusage:\n```\nbandwidth list numbers *                        //list all numbers under your account\nbandwidth list numbers \u003csite-id\u003e                //list all numbers under a particular site\nbandwidth list numbers \u003csite-id\u003e \u003cpeer-id\u003e      //list all numbers under a specific peer\n```\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|--out, -o [relative-path]|specify the output's relative path. Prints a table to console if `relative-path` is not specified. Prints csv-formatted output to console if `relative-path` is `stdout`. Otherwise, saves the output to the file specified.|no\n```\n//get all numbers from the account\n\u003ebandwidth list numbers * \nTelephone number data successfully written to users/yourName/bandwidth-numbers.csv\n\n//get all numbers from the site 48259\n\u003ebandwidth list numbers 48259 \nTelephone number data successfully written to users/yourName/bandwidth-numbers.csv\n\n//get all numbers from the site 48259, sip peer 342594\n\u003ebandwidth list numbers 48259 342594\nTelephone number data successfully written to users/yourName/bandwidth-numbers.csv\n\n//Print to console as a table using --out\n\u003ebandwidth list numbers 37656 --out\n┌─────────┬──────────────┬─────────┬───────┐\n│ (index) │    number    │ sippeer │ site  │\n├─────────┼──────────────┼─────────┼───────┤\n│    0    │ '5754041393' │ 625216  │ 37656 │\n│    1    │ '5754894272' │ 625216  │ 37656 │\n│    2    │ '5754895124' │ 625428  │ 37656 │\n└─────────┴──────────────┴─────────┴───────┘\n\n//print to console as raw csv data for piping\n\u003ebandwidth list numbers 37656 --out stdout\nnumber,sippeer,site\n5754041393,625216,37656\n5754894272,625216,37656\n5754895124,625216,37656\n\n//save to a different file. \n\u003ebandwidth list numbers 37656 --out my_file.csv\nTelephone number data successfully written to users/your-name/your-cwd/my_file.csv\n\n```\n### login\nusage: `bandwidth login`\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|none|\n\n```\n\u003ebandwidth login\nLeaving a field blank will keep it at its previous value.\n? Please enter your Bandwidth dashboard username myUsername\n? Please enter your Bandwidth dashboard password. This will be securely stored. **********\n? Please enter your Bandwidth account ID. 1234567\nYour credentials have been saved. You can now start using the CLI.\n```\n\n### message\nusage: `bandwidth message \u003cnumber1\u003e \u003cnumber2\u003e \u003cnumber3, etc...\u003e`\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|--app-id, -a| Specify the application id to send a message under. | no (yes if no default site is configured.)\n|--from-num, -n| Specify the number from which a number is sent. | no (yes if no default number is configured.)\n|--quiet, -q| Suppress output. | no\n```\n\u003ebandwidth message +15554443333 --from-num +17249200266\nUsing default messageApp 7d5f2e74-8488-458b-bb12-6df895ef6041\n? Enter the message you would like to send below: Hello!\nMessage request placed. The following information passed to server:\n\nid: 1595885144985y3yyewnagcem5hws\nowner: \"+17249200266\"\napplicationId: 7d5f2e74-8488-458b-bb12-6df895ef6041\ntime: 2020-07-27T21:25:44.985Z\nsegmentCount: 1\ndirection: out\nto:\n  - \"+15554443333\"\nfrom: \"+17249200266\"\nmedia: null\ntext: Hello!\ntag: null\n\nWarning: The message is not necessarily delivered. Callback information about the text should be accessed via a server. Set up a server for your default messageApp with \"bandwidth code server\".\n\n\n//quietly\n\u003ebw message +15554443333 --from-num 7249200266 -q\n? Enter the message you would like to send below: Hello!\nMessage request placed.\n\n```\n\n### order\nOrder phone numbers in three ways. Orders will be found under the specified sip peer. \n- [`order number`](#order-number): Order a list of specific numbers\n- [`order category`](#order-category): Order a given quantity of numbers with a criteria\n- [`order search`](#order-search): Search for numbers with a criteria and select those that you want to order\n\n\n#### order number\nusage: `bandwidth order number \u003cphone-numbers...\u003e`\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|site-id| the site that the number will be tied to|no (yes if no default site is configured.)\n|peer-id| the sip peer that the number will be tied to. if not specified, will use the site's built in default peer|no\n\n```\n\u003ebandwidth order numbers 4242064432 4242064617\n\n4242064432\n4242064617\n? order 2 phone numbers?\n\u003eYes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-13T18:39:08.952Z\nnote: Created a new number order for 2 numbers from REDONDO, CA\nstatus: COMPLETE\n```\n\n#### order category\nusage: `bandwidth order category [order-parameters] \u003cquantity\u003e`\n\nOrders a specified quantity of numbers based on a set of query parameters. At least one\nquery parameter is required. Use the switches/options below to specify query parameters.\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|site-id| the site that the number will be tied to|no (yes if no default site is configured.)\n|peer-id| the sip peer that the number will be tied to. if not specified, will use the site's built in default peer|no\n|zip | the zip code of the number | no\n|area-code| the area code of the number | no\n|npa-nxx| the first 6 digits of the phone number | no\n|npa-nxx-x| the first 7 digits of the phone numebr | no\n|state| the state abbreviation of the number.  | no\n|area-code| the LATA (Local Access and Transport Area) of the number | no\n```\n\u003ebandwidth order category --state nc 5\nYou have selected the following:\n\nstate: nc\n\n? order 5 numbers? Yes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-13T19:31:44.093Z\nnote: Created a new number order for 5 numbers from (Multiple) Rate Centers\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"2525131647\"\n  - \"2526426029\"\n  - \"7043224179\"\n  - \"7045503870\"\n  - \"7045504093\"\n```\n\nYou can combine as many of these queries as you'd like.\n\n```\n\u003ebandwidth order category --state nc --city raleigh --npa-nxx 919858 3\nYou have selected the following:\n\nnpaNxx: \"919858\"\nstate: nc\ncity: raleigh\n\n? order 3 numbers?\n\u003eYes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-13T19:35:25.832Z\nnote: Created a new number order for 2 numbers from RALEIGH, NC\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"9198586910\"\n  - \"9198586913\"\n```\n\n#### order search\nusage: `bandwidth order search [order-parameters] \u003cquantity\u003e`\n\nFinds a specified quantity of numbers based on a set of query parameters. At least one\nquery parameter is required. You may choose to order any number of the orders found.\n\nUse the switches/options below to specify query parameters.\n\n\nswitches/options\n| name      | Description | required |\n| ----------- | ----------- | ----------- |\n|site-id| the site that the number will be tied to|no (yes if no default site is configured.)\n|peer-id| the sip peer that the number will be tied to. if not specified, will use the site's built in default peer|no\n|zip | the zip code of the number | no\n|area-code| the area code of the number | no\n|npa-nxx| the first 6 digits of the phone number | no\n|npa-nxx-x| the first 7 digits of the phone numebr | no\n|state| the state abbreviation of the number.  | no\n|area-code| the LATA (Local Access and Transport Area) of the number | no\n```\n\u003ebandwidth order search --state nc 5\n? Found 5 numbers. Choose which to order.\n\u003e(*) 7047091101\n ( ) 7047091161\n ( ) 7047091328\n ( ) 7047091233\n ( ) 7047091391\n7047091101\n7047091233\n? order 2 phone numbers?\n\u003eYes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-13T19:37:57.740Z\nnote: Created a new number order for 2 numbers from ALTON, NC\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"7047091101\"\n  - \"7047091233\"\n```\n\nYou can combine as many of these queries as you'd like.\n```\n\u003ebandwidth order search--state nc --city raleigh --npa-nxx 919858 3\n? Found 3 numbers. Choose which to order. 9198586910, 9198586913\n9198586910\n9198586913\n? order 2 phone numbers? Yes\nYour order was placed. Awaiting order completion...\n\norderDate: 2020-07-13T19:35:25.832Z\nnote: Created a new number order for 2 numbers from RALEIGH, NC\nstatus: COMPLETE\ntelephoneNumbers:\n  - \"9198586910\"\n  - \"9198586913\"\n```\n\n## accountInfo\n\nDisplays information regarding the enabled products and features for your account\n\nusage: `bandwidth accountInfo`\n\n```\n┌──────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│     (index)      │                                              features                                               │\n├──────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤\n│  EdgeManagement  │                                              'SIPAuth'                                              │\n│    MESSAGING     │                        'ShortCode, HTTPV2, MMS, TollFree, SMS, A2pLongCode'                         │\n│ NumberManagement │ 'ExternalTNs, Reservation, PortOutPasscodeProtection, CSR, IMPORT_TNS, Ordering, ProtectedTNs, LNP' │\n│   Termination    │                                        'TermHttpVoice, Full'                                        │\n│   Origination    │                          'CNAM, LIDB, OrigHttpVoice, DlDa, CallForwarding'                          │\n│    Analytics     │                                        'MessagingAnalytics'                                         │\n└──────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘\n```\n\n### What's Next?\n\nAfter you have ordered some phone numbers and set up your applications, you can go to [Bandwidth's devsite](https://dev.bandwidth.com) for information on our APIs. Our [Messaging docs](https://dev.bandwidth.com/messaging/about.html) contains information on sending and receiving text messages, and our [Voice docs](https://dev.bandwidth.com/voice/about.html) contain information on how to create and manage phone calls.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbandwidth%2Fbandwidth-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbandwidth%2Fbandwidth-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbandwidth%2Fbandwidth-cli/lists"}