Envio por API Personalizada

Este processo de envio se aplica para parceiros que utilizam sistemas de terceiros e que não tem muita flexibilidade em relação à melhorias no código do sistema, e também já tem um módulo pronto para envio de SMS pelo próprio sistema, ou seja, utilizamos a API e via Webhook conseguimos configurar e interpretar quais variáveis do seu sistema enviada por GET ou POST, interpretando-as e sempre que a nossa API recebe essas variáveis efetua o envio do SMS substituindo pela variável que seria interpretada pelo nosso sistema. 

 

Para realizar este tipo de envio vamos tentar explicar em alguns simples passos:

Vamos realizar o teste utilizando o aplicativo POSTMAN para simular um sistema de terceiro.

Passo 1: Primeiramente, vamos acessar o Painel SMS e acessar a aba API Personalizada e após isto no botão +API Personalizada

Passo 2: Na próxima página você encontrará a URL para efetuar uma chamada do seu sistema para a API Personalizada da Comtele, portanto, você precisa copiar a URL e efetuar a chamada para essa URL dentro do seu sistema para que possamos interpretar o que está chegando para nós.

Passo 3: Essa etapa depende da configuração do seu sistema, ou seja, você precisa encontrar no seu sistema onde está a configuração para Enviar SMS, no caso utilizaremos o Postman para realizar essa chamada.

OBS Importante: No método POST, somente é suportado um Objeto Simples em JSON, array de objetos atualmente não é suportado.

OBS Importante: Demora no máximo 5 minutos para que o URL da API Personalizada seja propagada, portanto, aguarde este tempo e depois efetue a chamada.

Envio via GET (Postman): Neste envio, o seu sistema enviará via URL os parâmetros, por exemplo:
Como a URL ficará: https://sms.comtele.com.br/api/v2/customconfig/xxxx65xaas-ss11-405f-877c-1ee667e56ebb?sender=Igor&destinatarios=16999874562&conteudo=Teste da Comtele - Conteúdo API Personalizada Teste

 

Reparem que no campo Key, são os nomes das variáveis que teoricamente estariam no sistema de vocês e em Value o que ele está enviando de "conteúdo" e após clicar em Send, como deu Success: True significa que a comunicação funcionou corretamente.

Passo 4: Após realizar o envio da requisição, conseguimos identificar no nosso sistema quais parâmetros chegaram e como iremos "Linkar" com os parâmetros que deveriam ser enviados para o nosso sistema, ou seja, ao invés do nosso sistema interpretar destinatarios e conteudo, ele vai linkar destinatarios e interpretar como Receivers e conteudo como Content, que seriam o nome das variáveis caso fosse enviado via API normal da Comtele.

Parâmetro Remetente: Esse campo pode ser utilizado no método de relatório posteriormente para buscar detalhes individualmente de cada SMS.

Parâmetro Destinatário: Neste campo será informado o telefone que irá receber a mensagem. O formato deve ser DDD + nonô dígito + Número completo, totalizando assim 11 dígitos.

Template de Conteúdo: Neste campo você pode escrever uma mensagem e combinar com parâmetros recebidos na API Personalizada.

Neste exemplo acima, não efetuei nenhuma personalização, a personalização pode vir pronta do próprio sistema caso preferir, portanto para configurar que está correto, ficaria da seguinte forma e após é só clicar em Salvar:

 

Envio via POST (Postman): Neste envio, o seu sistema enviará um JSON via BODY os parâmetros, por exemplo:

Via JSON:

Reparem que no campo Key, são os nomes das variáveis que teoricamente estariam no sistema de vocês e em Value o que ele está enviando de "conteúdo" e após clicar em Send e como deu Success: True significa que a comunicação funcionou corretamente.

Passo 4: Após realizar o envio da requisição, conseguimos identificar no nosso sistema quais parâmetros chegaram e como iremos "Linkar" com os parâmetros que deveriam ser enviados para o nosso sistema, ou seja, ao invés do nosso sistema interpretar destinatarios e conteudo, ele vai linkar destinatarios e interpretar como Receivers e conteudo como Content, que seriam o nome das variáveis caso fosse enviado via API normal.

Parâmetro Remetente: Esse campo pode ser utilizado no método de relatório posteriormente para buscar detalhes individualmente de cada SMS.

Parâmetro Destinatário: Neste campo será informado o telefone que irá receber a mensagem. O formato deve ser DDD + nonô dígito + Número completo, totalizando assim 11 dígitos.

Template de Conteúdo: Neste campo você pode escrever uma mensagem e combinar com parâmetros recebidos na API Personalizada.

Neste exemplo acima, não efetuei nenhuma personalização, a personalização pode vir pronta do próprio sistema caso preferir, portanto para configurar que está correto, ficaria da seguinte forma e após é só clicar em Salvar:

Após Salvar, você será redirecionado à seguinte tela:

Pronto!
Sua API Personalizada está pronta e agora é só efetuar o teste no seu sistema.

Como testar no seu sistema:

Após salvo o sistema irá fornecer uma URL para utilizar em sua aplicação com os campos que foram mapeados.

Caso seu sistema for GET você utilizará o URL de Envio GET, caso for POST irá utilizar o POST.

Testando via método GET:

Perceba que ele colocou os Params dentro da URL antes de enviar, depois disso é só Enviar.

O retorno da nossa aplicação para confirmar o envio é esse mostrado na imagem abaixo e significa que Recebemos a Requisição e o SMS foi colocado na Fila de Envios, o tempo de envio depende da operadora a partir desse momento.

Testando via método POST:

O retorno da nossa aplicação para confirmar o envio é esse mostrado na imagem abaixo e significa que Recebemos a Requisição e o SMS foi colocado na Fila de Envios, o tempo de envio depende da operadora a partir desse momento.

E quando voltamos no Painel SMS e verificamos o Relatório de Envios, conseguimos visualizar a mensagem enviada tanto como POST como GET: