Como integrar a Duotalk em outro sistema?

Integração Duotalk

Ao configurar esta integração, a Duotalk envia os dados do contato para o sistema de destino.

Neste caso, o sistema deve desenvolver o recebimento do JSON, segundo o padrão da integração.

O padrão do JSON que é enviado:

body: '{
	"method":"POST",
	"url":"https://url.webhook-do-sistema.com",
	"headers":
		{
			"Content-Type":"application/json",
			"token":"t0k3n-autenticaca0"},
			"data":{
				"nome": "José Mario",
		    "telefone": "5511977777777" ,
		    "email": "josermario@email.com.br",
				"first_message": "Olá, preciso de ajuda!",
				"mensagem":"Mensagem: Conversa iniciada via whatsapp",
				"tipoIntegracao":"abertura",
				"origem":"WhatsApp 360",
				"origemTitulo": "opcional",
				"origemTipo": "opcional",
				"origemUrl": "opcional",
				"url_duotalk":"Inicie a conversa: https://app.duotalk.io/apps/inbox/start-conversation?name=Jose%20Mario&phone=5511977777777",
				"Entidade1":"Valor entidade 1",
				"Entidade2":"Valor entidade 2",
				"closingReason":"Motivo de encerramento" /* Enviado quando o tipoIntegracao é fechamento */
			}
		}',

  headers: {
    "Content-Type": "application/json",
    "Access-Control-Allow-Headers": "Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token",
    "Access-Control-Allow-Methods": "OPTIONS,GET,POST",
    "Access-Control-Allow-Origin": undefined,
    "Access-Control-Max-Age": '86400'
}

Requisição HTTP

A integração ocorre através de uma requisição HTTP do tipo POST para o endpoint do sistema externo.

• URL do Endpoint: https://url.webhook-do-sistema.com

• Método HTTP: POST

• Cabeçalhos:

  • Content-Type: application/json

  • token: Token de autenticação necessário para validar a requisição.

Descrição dos Campos

• nome: Nome do contato que iniciou a conversa.

• telefone: Número de telefone do contato, incluindo o código do país (ex: +55 para Brasil).

• email: Endereço de e-mail do contato.

• first_message: Texto da primeira mensagem enviada pelo cliente na conversa.

• mensagem: Mensagem inicial enviada pelo contato. Neste exemplo, a mensagem indica que a conversa foi iniciada via WhatsApp.

• tipoIntegracao: Tipo de integração, que pode ser abertura (para novas conversas) ou fechamento (para encerrar conversas).

• origem: Plataforma de origem da mensagem (ex: WhatsApp 360).

• origemTitulo (opcional): Título opcional para a origem da mensagem.

• origemTipo (opcional): Tipo opcional de origem.

• origemUrl (opcional): URL opcional relacionada à origem.

• url_duotalk: Link direto para iniciar a conversa no Duotalk.

• Entidade1 e Entidade2: Valores adicionais que podem ser utilizados conforme a necessidade da integração.

• closingReason: Motivo de encerramento da conversa, usado apenas quando tipoIntegracao é fechamento.

Configurações Adicionais de Cabeçalhos

Além dos cabeçalhos básicos, a requisição pode conter as seguintes configurações:

• Access-Control-Allow-Headers: Lista de cabeçalhos permitidos na requisição.

• Access-Control-Allow-Methods: Métodos HTTP permitidos (ex: OPTIONS, GET, POST).

• Access-Control-Allow-Origin: Origem permitida para a requisição (por exemplo, pode ser definido para permitir todas as origens com *).

• Access-Control-Max-Age: Tempo máximo (em segundos) que a resposta do pré-vôo pode ser armazenada em cache (ex: 86400 para 24 horas).

Esse modelo fornece uma visão clara e estruturada sobre como a integração deve ser configurada e quais campos e valores são esperados na requisição.