コマンドラインインターフェイス（CLI）クイックスタート
このTwilio製品は現在、ベータ版としてご利用いただけます。まだ実装されていない機能や、正式リリース時に機能が変更される可能性があることを、ご了承ください。ベータ版製品はTwilio SLAの対象外です。詳細はベータ版製品のサポートを参照してください。
twilio-cliの利点のひとつは、ターミナルやコマンドプロンプトから、Twilioのリソースを管理できる点です。インストールが完了したら、クイックツアーを始めましょう。
twilio-cliのインストール
Homebrewによるインストール
Homebrewを使用しtwilio-cliをmacOSにインストールするには、次のコマンドを実行します。
brew tap twilio/brew && brew install twilioScoopによるインストール
Scoopを使用しWindowsにtwilio-cliをインストールするには、管理者としてPowerShellを実行し、次のコマンドを実行します。
- 次の
twilio-cliのバケットを追加します。
scoop bucket add twilio-scoop https://github.com/twilio/scoop-twilio-cli - 次のアプリをインストールします。
scoop install twilio
aptによるインストール
Advanced Package Tool(apt)を使用し、Debian、Ubuntu、Linux Mintなどのディストリビューションにtwilio-cliをインストールするには、次のコマンドを実行します。
wget -qO- https://twilio-cli-prod.s3.amazonaws.com/twilio_pub.asc \
| sudo apt-key add -
sudo touch /etc/apt/sources.list.d/twilio.list
echo 'deb https://twilio-cli-prod.s3.amazonaws.com/apt/ /' \
| sudo tee /etc/apt/sources.list.d/twilio.list
sudo apt update
sudo apt install -y twilioDockerイメージの実行
対話型のbashシェルを含むDockerイメージとしてtwilio-cliを実行するには、次のコマンドを実行します。
docker run -it --rm twilio/twilio-cli bash使用方法の詳細については、専用のtwilio-cli Dockerドキュメントをご覧ください。
注意
可能な場合は、他のインストール方法を使用してください。npmによるインストールでは、自動更新が行われず、ご利用システムのNode.jsのバージョンが使用されます。それは、Twilioがtwilio-cliの開発で対応したバージョンより古い可能性があります。
npmによるインストール
twilio-cliを任意のディレクトリから使用できるように、グローバルにインストールするには、次のコマンドを使用します。
npm install -g twilio-cliインストール方法の詳細については、twilio-cliのインストールと更新のドキュメントをご覧ください。
Twilioアカウントへのログイン
twilio-cliがTwilioアカウントにアクセスしコマンドを実行するには、ログインしお客様のTwilio認証情報を指定する必要があります。そのために次のコマンドを実行します。
twilio loginコマンド実行後、Account SIDとAuth Tokenの入力が要求されますが、いずれもTwilioコンソールのダッシュボードで確認できます。
それによりAPIキーが作成、安全に保存されます。このキーは、twilio-cliを使用する際、認証されたリクエストを発行するために使用されます。この安全なAPIキーと設定は、プロファイルとしてローカルに保存されます。
同じマシン上で複数のアカウントやプロファイルをtwilio-cliに使用する場合は、Twilio CLI利用ガイドをご覧ください。
CLIオートコンプリートのインストール(bash、zshのみ)
オートコンプリートを使用すると、パラメーター、コマンド、オプションの一部を入力することで、コマンドを自動的に完全なものにするか、候補を表示できます。オートコンプリートを有効にした場合は、コンプリートキー(ほとんどのシェルで通常はTab)を押すことで、コマンドの候補を表示するようにtwilio-cliに指示できます。
シェルに応じたコマンドを実行し、twilio-cliのコマンドオートコンプリートを有効にします。
twilio autocomplete bashtwilio autocomplete zsh表示される指示に従い、シェルを再起動するか新しいシェルを開き、コマンドオートコンプリートのインストールを終了します。
候補が表示されない場合は、インストール後にシェルを再起動したか、新しいインスタンスを開いたかを再度確認してください。
twilio-cliの詳細
次のコマンドを実行すると、twilio-cliを使用してできることがすぐに分かります。
twilioこのコマンドを実行すると、各種トピックや使用できるコマンドのリストが表示されます。TOPICSでは、配下のトピックやコマンドがグループ化され、ファイルシステムのフォルダーのように構成されています。
$ twilio
Unleash the power of Twilio from your command prompt. Visit https://twil.io/cli for documentation.
VERSION
twilio-cli/3.0.0 darwin-x64 node-v16.13.1
USAGE
$ twilio [COMMAND]
TOPICS
api advanced access to all of the Twilio APIs
config manage Twilio CLI configurations
debugger Show a list of log events generated for the account
email sends emails to single or multiple recipients using Twilio SendGrid
feedback provide feedback to the CLI team
phone-numbers manage Twilio phone numbers
plugins list available plugins for installation
profiles manage credentials for Twilio profiles
COMMANDS
autocomplete display autocomplete installation instructions
feedback provide feedback to the CLI team
help display help for twilio
login create a new profile to store Twilio Account credentials and configuration
plugins list installed plugins
update update the twilio CLI気になるものがあれば実行してみましょう。
twilio api「api」というトピックでは、その中に含まれている別のトピックやコマンドを実際に表示できます。CLIを試す過程で、このコマンドを偶然見つけたとしましょう。
twilio api:core:messages:listコマンドを実行すると、すべてのSMSメッセージが表示されます。大量のメッセージが表示されるかもしれません。フィルタリングの方法は?そもそも、どのようなオプションがあるのか?答えは、以下のように、コマンドに「--help」を付けることです。
twilio api:core:messages:list --helpコマンドを入力する際、必要なオプションをすべて入力しないとエラーが表示されることがあります。このような場合にも、コマンドに「--help」を付けることで、詳しい情報を表示できます。
例
電話番号の一覧表示
twilio phone-numbers:listテキストメッセージの送信
twilio api:core:messages:create \
--from "+15017122661" \
--to "+15558675310" \
--body "I love you 3000"その他の例
Twilioのサンプルページには、さまざまな例が記載されています。
次の手順
ここまでtwilio-cliの概要を説明しました。以下では、次のステップを紹介します。
その他の例
twilio-cliで行えるさまざまな操作の例については、サンプルページをご覧ください。
プラグインを確認する
twilio-cliは、プラグインを使用し拡張できます。自作のプラグインは、コミュニティに公開することも、自社(または自社のクライアント)専用のビジネスワークフローとして非公開にすることもできます。CLIの拡張にご利用いただけるプラグインが多数用意されています。
Twilio CLI利用ガイド
各種CLI機能の詳細については、Twilio CLI利用ガイドの下記項目をそれぞれご覧ください。
フィードバックを送る
Twilioではお客様のご意見をお待ちしています。お気付きのことがありましたら、いつでもフィードバックをお送りください。以下のコマンドを実行するだけです。
twilio feedbackサポートが必要ですか？
コーディングに関するご質問、ご不明点等ございましたら、お問い合わせからご連絡いただくか、TwilioのStack Overflow Collectiveにアクセスいただくか、Stack OverflowサイトでTwilioタグを検索してください。
