Canal por API
- Nicola Occhipinti
É possível conectar um canal por API no NicoChat! Isso possibilita utilizar o NicoChat para automatizar as interações de um chat interno do seu Sistema. A Integração envia e recebe mensagens utilizando o OmniChannel da Workspace.
Esse é um complemento pago, caso tenha dúvidas entre em contato com o Suporte.
💴 Pagamento do Complemento
Esse complemento exige um setup no valor único de R$ 750,00. Esse set-up liberará uma chave API para fazer a autenticação do cadastro de webhooks em qualquer número de workspaces. Cada Sistema a ser integrado irá requerer um setup. Exemplos:
Se você quiser integrar um sistema a diversas workspaces irá haver apenas uma cobrança de setup.
Se você tiver 2 sistemas que deseja integrar, irá requerer 2 cobranças de setups, independente do numero de workspaces.
O Link de Pagamento do setup é o seguinte: https://buy.stripe.com/6oE3fgexL3mEb6g00i
Envie o comprovante de pagamento para o Suporte do NicoChat para realizarmos o set-up
Instruções
- Configuração inicial
Habilitar o complemento de parceiro com o Suporte do NicoChat, Api Chat. Será oferecido uma chave API para configuração do Webhook. A Autenticação será por Bearer Auth
Configurar o webhook da Api Chat para o workspace através da API do oferecida pelo suporte. A URL do webhook precisa ser verificada.
O bot_url, retornado na resposta da configuração do webhook da Api Chat, será usado para enviar mensagens do usuário do bot.
Verifique o payload de exemplo para diferentes tipos de mensagens.
Quando o bot ou o agente responder, o payload da mensagem será enviado para a URL do webhook da Api Chat fornecida, com uma assinatura incluída no cabeçalho
Você receberá uma Chave API para fazer as requisições de requisições de registo de webhook.
- Get webhook
POST {{baseUrl}}?action=get-webhookRequest body:
{
"workspace": {{workspace_id}},
"email": "{{workspace_email}}",
"ChaveApi": "{{Chave API do NicoChat}}"
}Sample response,
{
"status": "ok",
"data": {
"webhook_url": "https://your-webhook-url/",
"webhook_verification_key": "VERIFICATION_TOKEN",
"webhook_status": "verified",
"bot_url": "https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}"
}
}
- Set webhook
Request body:
Nota: Três parâmetros serão enviados para a URL do seu webhook via POST para verificação:
hub_mode: O valor será “subscribe"
hub_verify_token : O valor será o mesmo fornecido no corpo da sua requisição como "webhook_verification_key", o exemplo acima foi VERIFICATION_TOKEN
hub_challenge: O valor será uma string aleatória, por exemplo: 205c40409f9bcdeb9e00614b442c5fdd
Você precisa verificar a chave de verificação e retornar a resposta com o conteúdo do parâmetro hub_challenge no corpo da resposta. Exemplo: 205c40409f9bcdeb9e00614b442c5fdd
Exemplo de resposta (sucesso):
- Remove webhook
Request body:
Exemplo de resposta (sucesso):
API do Workspace para enviar mensagens.
Você precisa usar a chave de API do seu fluxo para autenticação, o que requer a permissão de gerenciar fluxo.
- Send Text Message
Request body:
- Send Button Payload
Request body:
- Send Image
Request body:
- Send Audio
Request body:
- Send Video
Request body:
- Send File
Request body:
Webhook payload
Quando o bot ou agente envia uma mensagem, a URL do seu webhook receberá o payload da mensagem. Para cada requisição, você pode verificar os seguintes headers.
Código PHP de exemplo para verificar a assinatura do payload.
- Receive Text Message
- Receive Button Template
- Receive Generic Template (Card/Carousel)
- Receive Image Message
- Receive Audio Message
- Receive Video Message
- Receive File Message