Como receber SMS por API e webhooks

Ative o acesso à API no perfil, gere um token e chame a API com ele. Para que os SMS recebidos sejam enviados ao seu servidor, adicione um URL de webhook no mesmo separador.

Atualizado 2 min de leitura

Pode ler as suas mensagens e gerir números a partir do seu próprio código. Há duas formas de obter novos SMS: pedi-los à API, ou deixar que um webhook envie cada um ao seu servidor assim que chega.

Obter um token da API

  1. Passo 1. Abra o separador API

    Vá a Profile e abra o separador API.

    Abra o separador API. Vá a Profile e abra o separador API.
  2. Passo 2. Ative o acesso à API

    Mude API access para Enabled. O mesmo interruptor corta todo o acesso à API se alguma vez precisar.

  3. Passo 3. Gere o token

    Prima Generate token em Personal access token. O token é mostrado uma só vez, por isso copie-o e guarde-o em segurança. Regenerate token emite um novo e revoga o anterior.

  4. Passo 4. Chame a API

    Envie o token como Bearer token no cabeçalho Authorization. O URL base e um exemplo de curl pronto a usar estão no mesmo separador.

Todas as chamadas, parâmetros e respostas estão na documentação da API.

Receber SMS com um webhook

Com um webhook enviamos um pedido POST ao seu servidor quando algo acontece, para não ter de consultar a API. Depois de ativar o acesso à API, aparece em baixo, no mesmo separador, uma secção Webhooks.

  1. Passo 1. Indique o seu URL

    Preencha Webhook URL, um endereço no seu servidor que responda com estado 2xx em 10 segundos. Prefira https, porque com http simples o texto dos SMS e os códigos viajam sem cifra.

    Indique o seu URL. Preencha Webhook URL, um endereço no seu servidor que responda com estado 2xx em 10 segundos. Prefira https, porque com http simples o texto dos SMS e os códigos viajam sem cifra.
  2. Passo 2. Escolha os eventos

    Escolha entre New SMS received, Number is online after wake-up, Rent renewed, Rent not renewed: not enough balance e Rent ended.

  3. Passo 3. Crie e teste

    Prima Create webhook, confirme que Send events está ligado e depois prima Send test event. O resultado e as últimas entregas aparecem listados na página.

Cada pedido é assinado com o seu Signing secret, por isso verifique a assinatura do seu lado. As entregas falhadas são repetidas durante várias horas.

Perguntas sobre o tema

Em Profile, no separador API. Depois de gerar o token, é mostrado uma só vez. Se o perdeu, prima Regenerate token.

Não. Pode consultar a API. Os webhooks só evitam essa consulta.

Se o seu servidor falha repetidamente em responder, as entregas são desligadas. Corrija o endpoint, ligue Send events e guarde.

Não. Ela lê mensagens e gere números. Enviar não é possível.

Leia também

Não encontrou a resposta?

Escreva ao suporte no Telegram. Envie o número e uma captura do que vê, assim resolvemos mais depressa.

Notícias Suporte