Skip to navigation
IntroduçãoExemplos de usoAções

Usando a API para enviar SMS

Para enviar SMS usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

Os SMS enviados serão listados no relatório em Relatórios > SMS > Enviados.

1. Enviar um SMS

Este endpoint solicita o envio de um SMS através do provedor configurado para o tenant.

Exemplo de chamada:

curl -X POST "https://sua-conta.callix.com.br/api/v1/click_to_sms" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "click_to_sms",
    "attributes": {
      "destination_number": "11987654321",
      "content": "Olá! Esta é uma mensagem de teste enviada via API."
    }
  }
}'

Na chamada, você deve fornecer:

  • destination_number: Número de telefone móvel que receberá o SMS
  • content: Conteúdo da mensagem (máximo de 1000 caracteres)

O número de telefone deve ser um número móvel válido em formato nacional (ex: 11987654321) ou internacional (ex: +5511987654321).

Exemplo de resposta:

{
  "message": "Successfully requested to send SMS. Track the status through the report."
}

Atributos

Atributos da Requisição

AtributoTipoObrigatórioValidaçãoDescrição
destination_numberstringSimFormato de telefone válidoNúmero de telefone móvel que receberá o SMS
contentstringSimNão vazio, máx. 1000 caracteresConteúdo da mensagem a ser enviada

Atributos da Resposta

AtributoTipoDescrição
messagestringMensagem de confirmação do envio da solicitação

Códigos de Resposta e Erros

Código HTTPCódigo EspecíficoDescrição
200-SMS enviado com sucesso
400165Formato do número de telefone inválido
400165O número de telefone deve ser móvel
400165Conteúdo da mensagem não pode estar vazio
400165Conteúdo da mensagem excede o limite de 1000 caracteres
401-Token de autenticação inválido ou ausente
402-Saldo insuficiente para envio de SMS
403103SMS não está habilitado para este tenant
403103Token não possui as permissões necessárias para enviar SMS
404404Tenant não encontrado

Observações Importantes

  1. Permissões: O token de API deve ter as permissões necessárias para envio de SMS
  2. Habilitação: O serviço de SMS deve estar habilitado no tenant
  3. Saldo: É necessário ter saldo suficiente para o envio
  4. Tipo de Número: Apenas números móveis são aceitos
  5. Limite de Caracteres: Mensagens são limitadas a 1000 caracteres
  6. Rastreamento: Use o relatório de SMS para acompanhar o status do envio