API - Documentação (v1)

Para utilizar a API é necessário solicitar a ativação deste recurso na sua conta do ChatGuru. Os dados ficam disponíveis na página "Celulares", apenas usuários com permissão ADMIN tem acesso.

Neste exemplo estamos utilizando o endpoint "https://app.zap.guru/api/v1", verifique em sua conta qual é o endpoint que deve ser utilizado.

post
Parâmetros obrigatórios em todas as requisições

https://app.zap.guru/api/v1
Os parâmetros a seguir são obrigatórios em todas as requisições de nossa API, devem ser sempre incorporados com o restante das requisições.
Request
Response
Request
Path Parameters
chat_number
required
string
Número completo do WhatsApp, código do país, código de área e número, ex. 5511999999999
key
required
string
Sua chave da API
account_id
required
string
ID de sua conta ChatGuru
phone_id
required
string
ID do aparelho cadastrado no ChatGuru
Response
200: OK

post
Enviar Mensagem (message_send)

https://app.zap.guru/api/v1?key=KEY&account_id=ACCOUNT_ID&phone_id=PHONE_ID&action=message_send&send_date=SEND_DATE&text=TEXT&chat_number=CHAT_NUMBER
Envia uma mensagem para um chat que já encontra-se previamente cadastrado no ChatGuru.
Request
Response
Request
Headers
send_date
optional
string
Data, Hora e Minuto para envio da mensagem. Formato: YYYY-MM-DD HH:MM
action
required
string
Ação desejada, neste caso "message_send"
text
required
string
Texto da mensagem.
Response
201: Created
O retorno das requisições é disponibilizado em formato JSON
{
"code": 201,
"result": "success",
"description": "Mensagem cadastrada com sucesso!",
"message_id": "5dd69cde00078e1be17fffd4",
"message_status": "scheduled"
}
400: Bad Request
O retorno das requisições é disponibilizado em formato JSON
{
"code": 400,
"description": "account_id inválida",
"result": "error"
}

post
Verificar Status da Mensagem (message_status)

https://app.zap.guru/api/v1?key=KEY&account_id=ACCOUNT_ID&phone_id=PHONE_ID&action=message_status&message_id=MESSAGE_ID
Retorna o status da mensagem
Request
Response
Request
Headers
action
required
string
Ação desejada, neste caso "message_status"
message_id
required
string
ID da mensagem recebida em resposta ao método message_send
Response
200: OK
O retorno das requisições é disponibilizado em formato JSON
{
"message_status": "sent",
"result": "success",
"code": 200
}
400: Bad Request
O retorno das requisições é disponibilizado em formato JSON
{
"description": "message_id inválida",
"result": "error",
"code": 400
}

post
Cadastrar um chat (chat_add)

https://app.zap.guru/api/v1?key=KEY&account_id=ACCOUNT_ID&phone_id=PHONE_ID&action=chat_add&name=NAME&text=TEXT&chat_number=CHAT_NUMBER&user_id=USER_ID&dialog_id=DIALOG_ID
Permite cadastrar um chat apenas se o recurso de "Adicionar Chats"estiver ativo em sua conta. O retorno das requisições é disponibilizado em formato JSON, o campo chat_add_id é informado neste retorno contendo o id que pode ser utilizado para verificar se o chat foi inserido ou houve algum erro durante a inserção.
Request
Response
Request
Path Parameters
dialog_id
optional
ID do diálogo do chatbot que deseja executar para o chat após ele ter sido incluído com sucesso
action
required
string
Ação desejada, neste caso "chat_add"
name
required
string
Nome do chat que deseja cadastrar
text
required
string
Texto da mensagem inicial para o chat.
user_id
optional
string
ID do usuário do ChatGuru para quem deseja delegar o chat automaticamente.
Response
201: Created
O retorno com sucesso não indica que o chat foi inserido com sucesso no ZapGuru, este retorno aponta apenas que ele foi cadastrado para ser inserido pelo ZapGuru. Utilize a ação chat_add_status para verificar se o chat foi criado e iniciado corretamente.
{
"code": 201,
"result": "success",
"description": "Chat cadastrado para inclusão com sucesso!",
"chat_add_id": "5dd69c2300078e1be17fffd4",
"chat_add_status": "pending"
}
400: Bad Request
{
"code": 400,
"description": "Número não informado",
"result": "error"
}

post
Verifica cadastro do Chat (chat_add_status)

https://app.zap.guru/api/v1?key=KEY&account_id=ACCOUNT_ID&phone_id=PHONE_ID&action=chat_add_status&chat_add_id=CHAT_ADD_ID
Retorna o status do cadastro do chat da ação "chat_add".
Request
Response
Request
Path Parameters
action
required
string
Ação desejada, neste caso "chat_add_status"
chat_add_id
required
string
ID do cadastro do chat informado no retorno de sucesso da ação "chat_add"
Response
200: OK
O retorno das requisições é disponibilizado em formato JSON. No caso de sucesso o item chat_add_status pode ser:: - pending → cadastro ainda está pendente - fetched → cadastro está em andamento - done → cadastro realizado, o chat foi incluído com sucesso. - error → houve um erro ao inserir o chat (número inválido, telefone desconectado, etc.)
{
"chat_add_id": "5e3e9c0f52313722bd2e11a2",
"chat_add_status": "done",
"chat_add_status_description": "Chat adicionado com sucesso!",
"result": "success",
"code": 200
}
400: Bad Request
{
"description": "chat_add_id não encontrado",
"result": "error",
"code": 400
}

post
Atualiza Campos Personalizados (chat_update_custom_fields)

https://app.zap.guru/api/v1?key=KEY&account_id=ACCOUNT_ID&phone_id=PHONE_ID&action=chat_update_custom_fields&chat_number=NUMERODOCHAT&field__NOME_DO_CAMPO=NOMEDOCAMPO
Permite atualizar os campos personalizados do chat através da API. O ID de cada campo pode ser encontrado no Gerenciador de Campos Personalizados
Request
Response
Request
Query Parameters
action
required
string
Ação desejada, nesse caso: "chat_update_custom_fields"
field__NOME_DO_CAMPO
required
string
Valor do campo personalizado
Response
200: OK
O retorno das requisições é disponibilizado em formato JSON.
{
"chat_id": "5e52b639600ce7d9be01f6cd",
"code": 200,
"description": "Campos personalizados foram salvos.",
"result": "success"
}
400: Bad Request
{
"code": 400,
"description": "Chat n\u00e3o encontrado n\u00e3o encontrado.",
"result": "error"
}

post
Adiciona Anotação (note_add)

https://app.zap.guru/api/v1
Permite adicionar anotações em um determinado chat via API
Request
Response
Request
Query Parameters
note_text
required
string
Texto de sua anotação
action
required
string
Ação desejada, nesse caso "note_add"
Response
200: OK
{
"code": 200,
"description": "Anotação criada com sucesso",
"note_id": "5ebbc4ded8d8eaf9919970a9",
"result": "success"
}
400: Bad Request
{
"code": 400,
"description": "Chat não encontrado.",
"result": "error"
}

post
Executar diálogo (dialog_execute)

https://app.zap.guru/api/v1
Permite executar um diálogo em um chat existente
Request
Response
Request
Query Parameters
action
required
string
Ação desejada, nesse caso "dialog_execute"
dialog_id
required
string
ID do diálogo que será executado
Response
200: OK
{
"code": 200,
"dialog_execution_return": "Diálogo executado",
"result": "success"
}
400: Bad Request
{
"code": 400,
"description": "Diálogo não encontrado para o phone_id informado. Verifique se o phone está atribuido corretamente ao chatbot.",
"result": "error"
}

post
Enviar um Arquivo (message_file_send)

https://app.zap.guru/api/v1
Permite enviar um arquivo para um chat existente
Request
Response
Request
Query Parameters
caption
optional
string
Nome do seu arquivo
file_url
required
string
O link de URL do arquivo
action
required
string
message_file_send
Response
200: OK