Início rápido da CLI (Command‑Line Interface, interface de linha de comando)

Este produto Twilio está atualmente disponível como uma versão Beta. Alguns recursos ainda não foram implementados e outros podem ser alterados antes que o produto seja declarado como disponível para o público em geral. Os produtos Beta não são abrangidos por um SLA da Twilio. Saiba mais sobre o suporte a produtos Beta.

A twilio-cli permite gerenciar seus recursos da Twilio a partir do terminal ou do prompt de comando. Vamos fazer a instalação e um tour rápido.

Instale a twilio-cli

Instalar usando o Homebrew

Para instalar a twilio-cli no macOS usando o Homebrew, execute:

brew tap twilio/brew && brew install twilio

Instalar usando Scoop

Para instalar a twilio-cli no Windows usando o Scoop, execute o PowerShell como administrador e:

Adicione o Bucket da twilio-cli:

scoop bucket add twilio-scoop https://github.com/twilio/scoop-twilio-cli

Instale o aplicativo:
```
instalação do scoop twilio
```

Instalar usando apt

Para instalar a twilio-cli em distribuições como Debian, Ubuntu, Linux Mint e muito mais usando Advanced Package Tool (apt), execute o seguinte:

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 twilio

Executar a imagem do Docker

Para executar a twilio-cli como uma imagem do Docker com um shell bash interativo, execute:

docker run -it --rm twilio/twilio-cli bash

Para obter mais detalhes sobre o uso, consulte a documentação dedicada do Docker da twilio-cli.

Isenção de responsabilidade

É altamente recomendável usar um dos outros métodos de instalação, se possível. Uma instalação por npm não é atualizada automaticamente e usa a versão do Node.js do seu sistema, que pode ser mais antiga do que a versão que a Twilio desenvolve em relação à twilio-cli.

Instalar usando npm

Para instalar a twilio-cli globalmente para que possa ser usada a partir de qualquer diretório, use:

npm install -g twilio-cli

Para obter mais métodos de instalação, consulte a documentação de instalação e atualização da twilio-cli.

Para que a twilio-cli acesse sua conta da Twilio e execute comandos em seu nome, você precisa fazer login e fornecer suas credenciais da Twilio. Isso pode ser feito pela execução de:

twilio login

Você precisará fornecer o SID de sua conta e o token de autenticação, que podem ser encontrados no dashboard do seu console do Twilio.

Isso criará uma chave de API para você que será armazenada com segurança e usada para emitir solicitações autenticadas conforme você usa a twilio-cli. Esta chave de API segura e suas configurações serão armazenadas localmente como um perfil.

Para usar várias contas ou perfis na twilio-cli no mesmo computador, consulte o guia de uso geral.

Instale o preenchimento automático da CLI (somente bash ou zsh)

O preenchimento automático permite inserir parcialmente um parâmetro, comando ou opção e completar automaticamente o comando ou exibir sugestões para você. Se o preenchimento automático estiver ativado, você poderá solicitar essas sugestões à twilio-cli pressionando a tecla de conclusão (geralmente Tab na maioria dos shells).

Ative o comando de preenchimento automático para a twilio-cli executando o comando apropriado para seu shell:

twilio autocomplete bash

twilio autocomplete zsh

Siga as instruções resultantes e reinicie ou abra um novo shell para concluir a instalação do comando de preenchimento automático.

Se as sugestões não forem exibidas, verifique se você reiniciou o shell ou abriu uma nova instância desde a instalação.

Explore a twilio-cli

A melhor maneira de aprender o que pode ser feito com a twilio-cli é simplesmente executar o comando:

twilio

Ao fazer isso, você verá uma lista dos vários tópicos e comandos disponíveis para execução. Os tópicos são apenas agrupamentos para mais tópicos e comandos, semelhante à estrutura de pastas no sistema de arquivos.

$ twilio
Catalise o poder da Twilio em sua linha de comando. Visite https://twil.io/cli para obter a documentação.

VERSÃO
  twilio-cli/3.0.0 darwin-x64 node-v16.13.1

USO
  $ twilio [COMMAND]

TÓPICOS
  api            acesso avançado a todas as configurações das APIs da Twilio
  config         gerencia as configurações da CLI da Twilio
  debugger       mostra uma lista de eventos de log gerados para a conta
  email          envia e‐mails para um ou vários destinatários usando o Twilio SendGrid
  feedback       fornece feedback à equipe de CLI
  phone-numbers  gerencia números de telefone da Twilio
  plugins        lista plugins disponíveis para instalação
  profiles       gerencia credenciais para os perfis da Twilio

COMANDOS
  autocomplete  exibe instruções de instalação de preenchimento automático
  feedback      fornece feedback à equipe de CLI
  help          exibe a ajuda do twilio
  login         cria um novo perfil para armazenar credenciais e configuração da conta da Twilio
  plugins       lista os plugins instalados
  update        atualiza a CLI da twilio

Viu algo de interessante? Tente executar:

api twilio

Como api é um tópico, serão exibidos mais tópicos e comandos contidos neste tópico. Digamos que no processo de exploração, você se deparou com este comando:

twilio api:core:messages:list

Se você executar esse comando, ele listará todas as suas mensagens SMS, que podem ser muitas. Como você pode filtrá‐las? Ou, em termos mais gerais, como descobrir quais opções um determinado comando de CLI oferece? A resposta é adicionar --help ao comando da seguinte forma:

twilio api:core:messages:list --help

Se você digitar um comando, poderá receber um erro caso não tenha fornecido todas as opções necessárias. Esta é outra situação em que a adição da palavra --help ao comando pode fornecer mais informações.

Exemplos

Liste seus números de telefones

twilio phone-numbers:list

Envie uma mensagem de texto

twilio api:core:messages:create \
  --from "+15017122661" \
  --to "+15558675310" \
  --body "I love you 3000"

Mais exemplos

Visite nossa página de exemplos para ver uma galeria com mais exemplos.

O que vem a seguir?

Agora que você foi apresentado à twilio-cli, quais os próximos passos?

Mais exemplos

Visite nossa página de exemplos para obter mais exemplos das várias coisas que podem ser feitas com a twilio-cli.

Explore os plugins

A twilio-cli pode ser estendida por meio de plugins. É possível publicar seu próprio plugin para a comunidade ou torná‐lo privado para os fluxos de trabalho de sua empresa ou de seus clientes. Já existem vários plugins disponíveis para você estender sua CLI.

Guia de uso geral

Consulte nosso guia de uso geral para saber mais sobre uma variedade de recursos da CLI:

Envie‐nos feedback

Por fim, gostaríamos de saber sua opinião. Sempre que quiser nos enviar um feedback, basta executar o camando:

twilio feedback

Precisa de ajuda?

Às vezes, todos nós precisamos; a programação é difícil. Receba ajuda agora da nossa equipe de suporte, ou confie na sabedoria da multidão navegando pelo Stack Overflow Collective da Twilio ou buscando a tag Twilio no Stack Overflow.

Precisa de ajuda?

Obrigado pelo seu feedback!

Obrigado pelo seu feedback!