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:

POST

/api/v1/click_to_sms

Params

Authorization

Body

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'POST',
  url: 'https://exemplo.callix.com.br/api/v1/click_to_sms',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

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

Atributo	Tipo	Obrigatório	Validação	Descrição
`destination_number`	string	Sim	Formato de telefone válido	Número de telefone móvel que receberá o SMS
`content`	string	Sim	Não vazio, máx. 1000 caracteres	Conteúdo da mensagem a ser enviada

Atributos da Resposta

Atributo	Tipo	Descrição
`message`	string	Mensagem de confirmação do envio da solicitação

Códigos de Resposta e Erros

Código HTTP	Código Específico	Descrição
`200`	-	SMS enviado com sucesso
`400`	`165`	Formato do número de telefone inválido
`400`	`165`	O número de telefone deve ser móvel
`400`	`165`	Conteúdo da mensagem não pode estar vazio
`400`	`165`	Conteú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
`403`	`103`	SMS não está habilitado para este tenant
`403`	`103`	Token não possui as permissões necessárias para enviar SMS
`404`	`404`	Tenant não encontrado

Observações Importantes

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