ChatGuru
Search…
🧑🏫
Introdução
Seja bem-vindo(a) a documentação da API v1 do ChatGuru. Através dessa documentação você conseguirá utilizar os recursos que uma conta possui dentro da nossa plataforma.

Endpoints

Cada conta possui um endpoint específico para realizar as requisições.
Exemplo: https://s10.chatguru.app/api/v1
Para consultar o seu endpoint, acesse a sua conta na plataforma e selecione Celulares Whatspp no menu lateral.
Essas informações ficam visíveis apenas para usuários administradores.
Caso você não encontre os dados no menu de Celulares WhatsApp, significa que o módulo de API não está habilitado na sua conta. Entre em contato com o nosso suporte caso deseje habilitar o módulo.

Autenticação

Para a autenticação via API, você deverá passar quatro parâmetros em todas as requisições, são eles:
Query Param
Elemento
Tipo
Ocorrência
Descrição
Exemplo
key
string
obrigatório
Sua chave da API.
K8881E8955Y1515
account_id
string
obrigatório
ID da sua conta.
8881ID9551515
phone_id
string
obrigatório
ID WhatsApp da sua conta.
8881IDW9551515
chat_number
string
obrigatório
Número do chat em que a ação será executada. É necessário utilizar o número completo.
5581999887766
Código do País + DDD + Número.
Você consegue alguns desses dados acessando o mesmo menu explicado anteriormente, Celulares WhatsApp.

Post do ChatGuru para URL personalizada

Para utilizar post através do ChatGuru você precisa ter os módulos de API e Chatbot.
Primeiramente você precisará criar um diálogo, como é mostrado clicando aqui.
Depois, basta adicionar a ação chamada "CRM", como mostra a imagem abaixo:
Adicionando uma ação de CRM ao diálogo
Após isso, basta mudar o campo "CRM" dessa ação para "Post para URL" e colar a sua URL logo abaixo:
Campos obrigatórios em um post
Os demais campos são opcionais. Caso você preencha algum deles, a informação que você colocar será enviada para a sua URL, juntamente com os dados do chat. Por exemplo, você pode colocar no campo origem a palavra "Vendas" e saberá que aquele post veio da configuração de vendas do chatbot.
Abaixo está um exemplo das informações enviadas pelo ChatGuru quando um post é realizado através do chatbot:
1
{
2
"campanha_id": "",
3
"campanha_nome": "",
4
"origem": "Vendas",
5
"email": "[email protected]",
6
"nome": "Alexandre Magno - ChatGuru",
7
"tags": [
8
"Fechado e Ganho",
9
"Autorizado",
10
"APP"
11
],
12
"texto_mensagem": "",
13
"campos_personalizados": {
14
"CNPJ": "121654654",
15
"email2": "[email protected]"
16
},
17
"bot_context": {
18
"ChatGuru": true,
19
},
20
"responsavel_nome": "",
21
"responsavel_email": "",
22
"link_chat": "https://app5.zap.guru/chats/5kgrr8kdt87lk21",
23
"celular": "5588988776655",
24
"datetime_post": "2020-08-13 18:28:41.998983"
Copied!
Last modified 1mo ago