Realizado

Mautic - integração com Plataforma Sms via Api (tenho os 2 instalados)

Publicado em 04 de Julho de 2019 dias na TI e Programação

Sobre este projeto

Aberto

Conectar o MAUTIC com Plataforma de envios SMS, os 2 estão instalados.


*******************************Documentação MAUTIC******************************
https://www.mautic.org/docs/en/index.html

****************Manual de Integração de envio de sms através de API*********************
integração via http

A integração via api é bem simples bastando para isso fazer uma chamada  http com os parâmetros corretos.
Veja no exemplo abaixo como deve ser a URL da chamada.
OBS: Os valores dos parâmetros devem ser trocados pelos dados do cliente, a explicação de cada parâmetro esta logo abaixo.
http://179.111.252.172:9090/sms/api/processa_api_url.php?fone=11999999999&mensagem=texto da mensagem&op=indefinida&user=usuario@usuario.com.br&pass=senha&tipo=2&id_msg=7

onde:
fone: número do fone com o ddd e nono digito.
Mensagem: mensagem a ser enviada, pode ter no máximo 310 caracteres, caso a mensagem tenha mais de 160 caracteres será cobrado o valor de 2 SMS. A mensagem também não pode ter acentuação.

User: É o login do cliente criado na hora em que foi feito seu cadastro, é sempre um e-mail
pass: É a senha do cliente, pode ser alfanumérica. Lembre-se de respeitar a digitação pois o sistema distingue caracteres maiúsculos e minúsculos. Sua senha encontra-se no final deste manual
op: é a operadora do número, por exemplo vivo, tim, etc..




.  Se não souber a operadora preencha nesse campo o valor indefinida

tipo: é um campo opcional, pode ter dois valores:
    1 = SMS Longcode
    2 = SMS Shortcode
    Caso seja omitido o valor padrão é 1.

Id_msg: é um campo onde o cliente pode informar seu id interno, este id é retornado na tabela de respostas quando alguém responde o sms.


Como saber se a chamada HTTP teve sucesso?
Quando executar a chamada http para inserir uma mensagem a url irá retornar um valor ok  caso a inclusão seja bem sucedida, caso não apareça esse valor é porque a requisição http falhou.



Obtendo as respostas dos SMS enviados
É comum que clientes respondam as mensagem enviadas, essas respostas ficam armazenadas em um banco de dados específico para cada cliente.

Existem 2 modos para acessar as respostas através de API
•    Acesso direto a base de dados de respostas da API ou;
•    Através de requisição HTTP


Acesso direto a Base de Dados
Para pegar as respostas por esse método acesse diretamente o bando de dados de respostas de sua API, utilize os dados abaixo.

Host:  179.111.252.172
usuario: 257
senha: 257123
banco de dados: 257

Este banco contém apenas uma tabela chamada respostas com os seguintes campos:

id - chave primaria auto increment
fone - numero que respondeu
mensagem - a resposta do cliente
status - campo de controle, vem com valor zero, assim que vc processar a resposta altere o valor deste campo para 1, serve para você controlar quais respostas você já processou, por padrão ele vem com valor 0(zero)
data - data e hora da resposta
chave - chave interna do seu envio, é gerada uma chave para cada dia ou seja todas as respostas que entrarem em um dia terão a mesma chave
id_cli – neste campo é retornado o id da msg informado pelo cliente no momento que fez o envio.

OBS1: o sistema processa as respostas dos envios Longcode em média 3 vezes ao dia, as respostas dos envios Shortcode são processadas imediatamente após ser repassada pela operadora.


Através de Requisição HTTP
Por requisição HTTP é possível informar um período do qual você pretende verificar se houve respostas, elas são impressas na tela e podem ser facilmente capturadas e armazenadas em um banco de dados.
Veja abaixo um exemplo da requisição HTTP a ser utilizada em um exemplo de sua saída.

http://179.111.252.172:9090/sms/api/checa_respostas.php?dti=2017-03-07 10:00:00&dtf=2017-03-07 19:00:00&user=usuario@usuario.com.br&pass=SENHA


Retorno da requisição acima:

onde:
dti = data e hora inicial da filtragem, no formato americano yyyy/mm/dd hh:mm;ss
dft = data e hora final da filtragem, no formato americano yyyy/mm/dd hh:mm;ss
user: é o login do cliente criado na hora em que foi feito seu cadastro, é sempre um e-mail
pass: é a senha do cliente, pode ser alfanumérica. Lembre-se de respeitar a digitação pois o sistema distingue caracteres maiúsculos e minúsculos.

No exemplo dado acima você estaria filtrando as respostas recebidas no dia 07/03/2017 no intervalo das 10hr da manhã até as 19hr da noite
Ordem do retorno: Data e hora | Número que respondeu a Mensagem | Resposta
Cada campo é separado pelo caracter pipe ( | )



Checar Saldo
Para checar o saldo de sua conta basta executar a URL abaixo com os seguintes parâmetros:
http://179.111.252.172:9090/sms/api/busca.php?user=usuario@usuario.com.br&pass=SENHA&procura=saldo

user =  É o login do cliente criado na hora em que foi feito seu cadastro, é sempre um e-mail
pass =  É a senha do cliente, pode ser alfanumérica. Lembre-se de respeitar a digitação pois o sistema distingue caracteres maiúsculos e minúsculos.
Procura =  este campo deve conter o valor “saldo” para que seja retornado o saldo de SMS do cliente naquele exato instante.
Será retornado seu saldo ou um código de erro, veja lista dos códigos de erro na secção Códigos de erro que esta mais abaixo deste manual.


Checar Número
Esta consulta devolve o número pesquisado e quantas vezes o mesmo foi enviado no dia juntamente com o horário que foi enviado ou um código de erro, ver abaixo.
O retorno será o telefone procurado e a data e hora que foi enviado, separados pelo caracter  ( | ) pipe. A pesquisa retorna números enviados no Maximo a 10 dias atrás.
http://179.111.252.172:9090/sms/api/busca.php?user=usuario@usuario.com.br&pass=SENHA&procura=numero&data=14-03-2018&num=21972174433

Veja o exemplo de retorno da requisição:
Onde:
user = É o login do cliente criado na hora em que foi feito seu cadastro, é sempre um e-mail
pass =  É a senha do cliente, pode ser alfanumérica. Lembre-se de respeitar a digitação pois o sistema distingue caracteres maiúsculos e minúsculos.
Procura = este campo deve conter o valor “numero”
data = é a data em que se deseja fazer a busca do numero no formato dd-mm-aaaa
num = é o numero do telefone que deseja saber informações no formato ddd+nonodigito+numero



Quantidade enviada no dia
esta requisição retorna unicamente um número que é a quantidade que o cliente enviou no dia procurado ou um código de erro, segue abaixo exemplo da url

http://179.111.252.172:9090/sms/api/busca.php?user=usuario@usuario.com.br&pass=SENHA&procura=qtddia&data=14-03-2018
Onde:
user = É o login do cliente criado na hora em que foi feito seu cadastro, é sempre um e-mail
pass =  É a senha do cliente, pode ser alfanumérica. Lembre-se de respeitar a digitação pois o sistema distingue caracteres maiúsculos e minúsculos.
Procura = este campo deve conter o valor “qtddia” para que seja retornado o saldo de SMS do cliente naquele exato instante.
Data = é a data em que se deseja fazer a busca no formato dd-mm-aaaa



Acesso web
contamos também com um painel web onde estão disponíveis as opções de:
•    controlar seus dados de acesso
•    cadastrar campanhas
•    fazer envios (com opção de agendamento)
•    relatórios de envios
•    relatório de consumo
•    relatório de respostas (por campanha e por dia)
•    saldo de sms



Para desenvolvedores recomendamos o acesso direto através do endereço  http://179.111.252.172:9090/sms por ser mais rápido e sem redirecionamentos.

Informe seu usuário e senha e tenha acesso a todas as funcionalidades.

Dados para seu acesso ao Painel e API
Pegar com Rogerio

Utilize os dados abaixo para substituir nos campos correspondentes citados acima para utilizar a API e também para acessar o Painel Administrativo pela Web.

Código de erros
ERRO#9 – Número de telefone invalido
ERRO#8 – Erro na data
ERRO#7 – Tipo de busca(procura) invalido
ERRO#6 – usuário ou senha inválido

Categoria TI e Programação
Subcategoria Programação
Qual é o alcance do projeto? Alteração média
Isso é um projeto ou uma posição de trabalho? Um projeto
Tenho, atualmente Eu tenho especificações
Disponibilidade requerida Conforme necessário
Integrações de API Outros (Outras APIs)
Funções necessárias Desenvolvedor, Outro
Outras funções necessárias Preciso que configure o Mautic para que ele envie SMS pelo PAINEL.

Prazo de Entrega: Não estabelecido

Habilidades necessárias

Outro projetos publicados por R. F.