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.
Parâmetros obrigatórios em todas as requisições
POST
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.
Path Parameters
Enviar Mensagem (message_send)
POST
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.
Headers
Verificar Status da Mensagem (message_status)
POST
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
Headers
Cadastrar um chat (chat_add)
POST
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.
Path Parameters
Verifica cadastro do Chat (chat_add_status)
POST
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".
Path Parameters
Atualiza Campos Personalizados (chat_update_custom_fields)
POST
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
Query Parameters
Adiciona Anotação (note_add)
POST
https://app.zap.guru/api/v1
Permite adicionar anotações em um determinado chat via API
Query Parameters
Executar diálogo (dialog_execute)
POST
https://app.zap.guru/api/v1
Permite executar um diálogo em um chat existente
Query Parameters
Enviar um Arquivo (message_file_send)
POST
https://app.zap.guru/api/v1
Permite enviar um arquivo para um chat existente
Query Parameters
Last updated