Webhook

A integração via Webhook tem como objetivo disponibilizar em real time os eventos gerados a partir das plataformas Invenio Center e Invenio Live.

• Mensagens enviadas e atualização de status de entrega
• Mensagens recebidas e atualização de status de recebimento
• KPI Eventos inseridos no ambiente (sejam eles feitos por usuário ou sistema)
• Campanhas e atualização de status
• Carteiras e atualização ou edição de suas configurações
• Status de templates HSM, bem como sua qualidade e alterações
• Status de linhas WhatsApp, bem como sua qualidade e alterações
• Relação de usuários, logs e alterações
• Protocolos com suas estatísticas e dados relacionados

Manual de Integração #

Como funciona a integração via Webhook+Enpoint? #

Este serviço serve como receptor de todas interações que constam no banco de dados Robbu, os objetos enviados em blocos JSON são: [contact], [event] ,[messageincoming], [messageoutgoing], [campaign], [template], [protocol], [wallet], [whatsapp numbers], [status].

Esse serviço enviará blocos de 30 arquivos JSON em um intervalo médio de 2 segundos.

Configuração #

1 – Download do projeto #

Comece fazendo o download do projeto de referência em:

• Clique aqui para projeto para Azure Functions:
• Clique aqui para projeto para .NET Full Framework:

Localize o arquivo Script_Tabelas_Robbu.sql, é nesse schema de tabelas que o serviço webhook irá popular as tabelas do banco de dados do endpoint.

Obs: O script de criação das tabelas foi criado em SQL, assim como os métodos de inserção dos dados estão considerando esse banco de dados. Trazemos dessa forma para que funcione como um facilitador, porém fica a critério da empresa a definição das tecnologias a serem utilizados, ficando sob total responsabilidade do próprio cliente manter em funcionamento.

2 – Publicação do Projeto: #

Essa solução é a interpretadora dos blocos JSON que o webhook irá disparar ao endpoint destino. Ela fica responsável por separar cada tipo de interação e salvar as informações no banco de dados externo.

Caso você já possua uma infraestrutura cloud/on-premises e queira reaproveitá-la, você pode publicar nossa solução neste mesmo servidor disponível.

Fique à vontade para utilizar um servidor novo. A prioridade aqui é que serviço de disparo consiga acessar externamente a partir de uma rota de execução.

3 – Recomendações para o deploy: #

O arquivo root da solução é apiv1.ashx. Ele é o responsável por fazer com que o processamento seja iniciado.

Sobre versionamento do .NET Framework, ele deve ser 4.6.1. e 4.8. Atente-se aos .NET instalados no servidor para que tenham compatibilidade com a solução.

A URL da solução publicada não contém restrições. É possível publicá-la a partir de qualquer rota e pode ser exposta em rota HTTP ou HTTPS. Recomendamos HTTPS pela segurança.

Também se faz necessária a liberação da relação de IP’s abaixo no firewall para garantir a conectividade da integração:

104.41.15.44, 104.41.14.184, 104.41.13.132, 104.41.12.97, 104.41.56.229, 104.41.30.250, 20.206.191.81, 191.235.52.58, 191.235.52.65, 191.235.52.78, 191.235.52.195, 191.235.52.245, 191.235.53.35, 191.235.53.57, 191.235.53.74, 191.235.53.158, 191.235.54.48, 191.235.54.59, 104.41.13.179

4- Recomendações iniciais de infraestrutura: #

Para um servidor endpoint de ambiente de produção recomendamos o setup mínimo:

• SSD de 250 GB
• 16 GB de RAM
• CPU com 4 núcleos.

Não recomendamos a utilização de um HD devido a velocidade e volume de mensagens de entrada, saída e eventos. O baixo desempenho pode gerar gargalos com a carga das replicações.

Esta é uma recomendação técnica inicial. A área de TI deve manter a gestão contínua da infraestrutura usada na solução devido a necessidade futura de escala. A solução a ser executada no servidor endpoint é desenvolvida em .NET, desta forma orientamos a usar produtos Microsoft. Recomendamos também a utilização de banco de dados SQL Server.

5 – Configuração final: #

Após configurar toda infraestrutura de servidor, banco de dados, liberações de firewall e publicação externamente do serviço webhook, acesse:

https://inveniocenter.robbu.com.br/painel/configuracoes > Webhook

Clique em gerenciar:

Adicione a URL final que foi gerada pelo Visual Studio ou pela IDE que foi utilizada e salve.

Após essa etapa aguarde em aproximadamente 60 minutos você deverá começar a receber as requisições em seu endpoint.

Mapeamento de Campos #

Abaixo apresentamos a estrutura de campos e tabelas para manipulação dos dados recebidos:

Tabela Message #

Tabela Event #

Tabela Campaign #

Tabela Template #

Tabela Protocol #

Tabela User #

Tabela Wallet #

Tabela WhatsApp Numbers #

Tabela Status #

Mensagem de entrada – Exemplo de json #

[{
	"message": {
		"receivedAt": "2020-01-31T02:01:03",
		"direction": "incoming",
		"id": 13232322244444,
		"channel": 3,
		"text": "Olá, teste whats!",
		"source": {
			"countryCode": 55,
			"phoneNumber": 11999999992
		},
		"destination": {
			"countryCode": 55,
			"phoneNumber": 11944497777
		},
		"location": {
			"latitude": -23.5535317,
			"longitude": -46.6631181
		},
		"file": {
			"url": "http://s.robbu.com.br/arquivo?hash=ROBBU",
			"name": "robbu",
			"extension": "pdf"
		},
		"contact": {
			"robbuid": 11111111111,
			"name": "TESTE ROBBU",
			"customCode": "1372511",
			"id": "00000000000",
			"mainWhatsapp": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainSMS": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainEmail": "teste@robbu.global"
		}
	}
}]

Mensagem de Saida- Exemplo de json #

[{
	"message": {
		"sentAt": "2020-01-31T02:05:21.2900000",
		"direction": "outgoing",
		"id": 1323232224455555,
		"channel": 3,
		"type": "",
		"text": "Teste envio whats!",
		"campaignId": 1234,
		"source": {
			"countryCode": 55,
			"phoneNumber": 11944497777,
			"sender": ""
		},
		"destination": {
			"countryCode": 55,
			"phoneNumber": 11999999992
		},
		"file": {
			"url": "http://s.robbu.com.br/arquivo?hash=ROBBU",
			"name": "robbu",
			"extension": "pdf"
		},
		"contact": {
			"robbuid": 11111111111,
			"name": "TESTE ROBBU",
			"customCode": "1372511",
			"id": "00000000000",
			"mainWhatsapp": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainSMS": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainEmail": "teste@robbu.global",
			"queue": {
				"waitingSince": "2021-03-08 12:00:00",
				"firstAnswerAt": "2021-03-08 11:30:00"
			}
		}
	}
}]

Status de Mensagem – Exemplo de json #

[{
	"status": {
		"message": {
			"id": 1323232224455555,
			"source": {
				"sender": "User1"
			},
			"sentToProviderAt": "2020-01-31T15:50:39.9312405",
			"deliveredAt": "2020-01-31T15:51:52.9707831",
			"readAt": "2020-01-31T15:53:14.6399299"
		}
	}
}]

Eventos – Exemplo de json #

[{
	"event": {
		"createdAt": "2020-01-31T02:05:21.0566667",
		"id": 13232322244599998,
		"description": "[CR] Saudacao Final",
		"note": "Saudacao Final",
		"customCode": "298",
		"finalized": false,
		"sender": "",
		"type": "Neutro",
		"contact": {
			"robbuid": 11111111111,
			"name": "TESTE ROBBU",
			"customCode": "1372511",
			"id": "00000000000",
			"mainWhatsapp": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainSMS": {
				"countryCode": 55,
				"phoneNumber": 11999999992
			},
			"mainEmail": "teste@robbu.global"
		}
	}
}]

Campanha – Exemplo de json #

[{
	"campaign": {
		"createdAt": "2020-01-27T22:01:12.2766667",
		"createdBy": "User Robbu",
		"id": 994545,
		"channel": 1,
		"startAt": "2020-01-27T21:59:00",
		"size": 3102,
		"message": "<html><body>Envio campanha email!<\/body><\/html>",
		"hoursToDiscard": 0,
		"type": {
			"code": "EM",
			"description": "EMAIL"
		},
		"splitSend": {
			"percentage": 100.00,
			"minutes": 0
		},
		"mailing": {
			"description": "disparo_email",
			"importedAt": "2020-01-27T21:54:16.5500000",
			"importedBy": "User Robbu",
			"size": 3102,
			"walletClientCode": "1000"
		}
	}
}]

Campanha status – Exemplo de json #

[{
	"status": {
		"campaign": {
			"id": 994545,
			"totalSent": 91,
			"lastSentAt": "2020-01-31T16:10:12.0633333",
			"statusCode": "F"
		}
	}
}]