Controllr/Aplicativos/Cadastros/Messenger/SMS/Apis

De BrByte Wiki
< Controllr‎ | Aplicativos‎ | Cadastros‎ | Messenger‎ | SMS
Revisão de 14h01min de 15 de fevereiro de 2023 por Klelber (discussão | contribs)

Messenger Apis

No App Messenger APIs Dev-sms-campaign.png

O aplicativo Messenger APIs permite realizar a conexão com as plataformas de envio de mensagens. A seguir, mostraremos como configurá-la para várias plataformas diferentes.

Controllr-aplicativos-cadastros-messenger-apis.png


Para adicionar uma nova API, basta clicar no botão Add.png Novo.

Novo

Nesta sessão, ensinaremos o passo a passo para conectar suas APIs com o nosso sistema. Essa API poderá ser qualquer uma de sua preferência desde que disponibilize o envio dos SMS via API com a montagem de uma URL de disparo. Conforme a imagem abaixo, algumas informações devem ser preenchidas.

Controllr-aplicativos-cadastros-messenger-apis-novo.png


Novo Genétrico/Outros
Campo Descrição Exemplo
Nome Descreva um nome para a sua aplicação que está sendo cadastrada. Facilita Móvel
Serviço Selecione um dos serviços disponíveis de gateway que irá contratar. Genérico/Outros
Habilitado Habilita ou desabilita para aparecer nas listas de APIs disponíveis.
Método Seleciona o método de envio que o Controllr enviará para a API. As opção são: GET e POST. GET
Acesso
Host Informe o site aonde será iniciado a comunicação do envio via API com o gateway contratado. api.facilitamovel.com.br
Porta Informe a porta que o Controllr deve comunicar-se com o Host do gateway contratado.

Por exemplo: As portas 80 e 443 são as portas padrão para HTTP e HTTPS respectivamente.
80
SSL Marque se a comunicação do Controllr com o Host será com criptografia SSL ou não.

Os sites que configurarem um certificado SSL/TLS podem utilizar o protocolo HTTPS para estabelecer uma comunicação segura com o servidor.
Url Deve ser inserido a URL com os parâmetros corretos para ser enviado o SMS do gateway contratado.
Cada gateway possui um padrão que deve ser verificado na documentação da API.

Você poderá utilizar algumas palavras chaves que o sistema Controllr utilizará para recuperar as informações através de variáveis. Temos:

{u}: uma variável aleatória que pode ser usada como nome de usuário cadastrado.
{p}: uma variável aleatória que, normalmente, é usada como senha.
{t}: uma variável aleatória que pode ser usada como uma chave de token.
{d}: Variável que puxará automaticamente o número de telefone do cliente que será enviado a mensagem.
{m}: Variável que puxará automaticamente a mensagem dos modelos de envio que será enviada ao cliente.


Essas variáveis aleatórias são preenchidas na categoria abaixo denominada Autorização.
api/simpleSend.ft?user={u}&password={p}&destinatario={d}&msg={m}
Loader
Intervalo Defina o intervalo (em segundos) que será enviado uma quantidade X de mensagens ao seus clientes.

Recomendamos a cada 30 segundos enviar 5 mensagens.
30
Limite Defina quantas mensagens serão disparadas no intervalo definido acima. 5

Voipr

O nosso produto Voipr é uma solução completa para provedores de serviços competitivos. Algumas funcionalidades são: cobrança, monitoramento, geração de relatórios, gerenciamento de troncos, roteamento de chamadas, URA, suporte a modem GSM para chamadas e envio de SMS e interconexão entre servidores.

Após fazer a instalação do Voipr utilizando o manual do produto, você deverá preencher as informações do Serviço Voipr/BrByte. Descrevemos os campos abaixo.

Controllr-aplicativos-cadastros-messenger-apis-novo.png


Voipr/BrByte
Campo Descrição Exemplo
Host Insira o IP do seu servidor Voipr. 192.168.142.14
Porta Insira a porta de acesso web do seu servidor Voipr. 8080
SSL Marque essa opção se seu servidor utiliza uma camada extra de criptografia.
Campaign Key Insira a chave autenticadora da campanha gerada pelo servidor Voipr.

Obs: Use o tipo texto na criação campanha, pois o template de envio usado será o do Controllr.
4BxUFnE37jpnEmQmjJsUOm1EhWP51oCh
Client Key Insira a chave do cliente criada no seu servidor Voipr. KdL3LhLdsH7aIig6WF8F6YZQvlz7Sphz

O número de cada cliente e a mensagem serão substituídos de acordo com o cliente e o Bulk cadastrado respectivamente.

Goip

Controllr-aplicativos-cadastros-messenger-apis-novo.png
Goip
Campo Descrição Exemplo
Canal Insira o canal que irá utilizar do seu servidor Goip.
Host Insira o IP do seu servidor Goip.
Porta Insira a porta de acesso web do seu servidor Goip. 8080
SSL Marque essa opção se seu servidor utiliza uma camada extra de criptografia.
Usuário Insira o usuário para podermos conectar com o servidor Goip.
Senha Insira a senha para podermos conectar com o servidor Goip.

Mega Dedicados


Mega Dedicados
Campo Descrição Exemplo
Usuário - -
Senha Insira o token gerado pelo Mega Dedicados.

Para gerar, acesse o site Mega Dedicados Api. Depois de autenticar na plataforma, adicione o dispositivo que enviará as mensagens. Em seguida, copie o token gerado e cole nesse campo.
1YGm5y92GHZE1S0Zvfpz

SmsGateway.me

SmsGateway.me
Campo Descrição Exemplo
Token Informe o token que foi gerado pelo aplicativo. eyj0eXAiOiJKV
ID do dispositivo Informe o ID que foi atribuído para o seu dispositivo. 11

Khal

Khal
Campo Descrição Exemplo
Usuário Informe o seu usuário que será disponibilizado no seu e-mail após contratar o serviço. 6799999
Senha Informe a sua senha que será disponibilizada no seu e-mail após contratar o serviço. *******

Zenvia

Zenvia
Campo Descrição Exemplo
Alias Informe a credencial que foi atribuída ao produto que você comprou.

Você pode obtê-la, acessando o site: https://app.zenvia.com/home/credentials. Após isso, clique no produto obtido para visualizar a informação.
educated-tested
Token Informe o token gerado pelo sistema.

Você pode obtê-lo, acessando o site: https://app.zenvia.com/home/api. Após isso, crie um novo token clicando no botão Criar Novo. Em seguida, copie o token que foi gerado pelo sistema.
PaFYlQDVMvAIl5BxUhpAF13-ITl9t-Tu6aNO

Pronto, agora é só substituir nos campos da categoria Autenticação. E não se esqueça de trocar para a Versão 2.

VirtusHost

Controllr-aplicativos-cadastros-messenger-apis-novo.png


VirtusHost
Campo Descrição Exemplo
Usuário Informe o seu usuário que será disponibilizado no seu e-mail após contratar o serviço. -
Senha Informe a sua senha que será disponibilizada no seu e-mail após contratar o serviço. -

Owen Brasil

Controllr-aplicativos-cadastros-messenger-apis-novo.png


Owen Brasil
Campo Descrição Exemplo
Token Informe o token que foi gerado após contratar o serviço.

Para consultá-lo, acesse https://owenbrasil.com/admin/tokens.php e você terá acesso a ele.
TERTpasTIlçzpMqQUyuPDFVa

MyZAP

Controllr-aplicativos-cadastros-messenger-apis-novo.png


MyZAP
Campo Descrição Exemplo
Host Insira o IP do seu servidor MyZAP.
Porta Insira a porta de acesso web do seu servidor MyZAP.
SSL Marque essa opção se seu servidor utiliza uma camada extra de criptografia.
Sessão
Sessão Key

Outros

Além desses já cadastrados em nosso sistema, mostraremos o passo a passo para outras plataformas de envio de mensagem.

Api-SMS

Novo Genétrico/Outros
Campo Descrição Exemplo
Nome Descreva um nome para a sua aplicação que está sendo cadastrada. Api-SMS
Serviço Selecione um dos serviços disponíveis de gateway que irá contratar. Genérico/Outros
Habilitado Habilita ou desabilita para aparecer nas listas de APIs disponíveis.
Método Seleciona o método de envio que o Controllr enviará para a API. As opção são: GET e POST. GET
Acesso
Host Informe o site aonde será iniciado a comunicação do envio via API com o gateway contratado. api-sms.com.br
Porta Informe a porta que o Controllr deve comunicar-se com o Host do gateway contratado.

Por exemplo: As portas 80 e 443 são as portas padrão para HTTP e HTTPS respectivamente.
443
SSL Marque se a comunicação do Controllr com o Host será com criptografia SSL ou não.

Os sites que configurarem um certificado SSL/TLS podem utilizar o protocolo HTTPS para estabelecer uma comunicação segura com o servidor.
Url Deve ser inserido a URL com os parâmetros corretos para ser enviado o SMS do gateway contratado.
Cada gateway possui um padrão que deve ser verificado na documentação da API.
API/URL:user={u}&password={p}&destinatario={d}&msg={m}
Loader
Intervalo Defina o intervalo (em segundos) que será enviado uma quantidade X de mensagens ao seus clientes.

Recomendamos a cada 30 segundos enviar 5 mensagens.
30
Limite Defina quantas mensagens serão disparadas no intervalo definido acima. 5