Construtor de API
Algumas funções de solicitação de API podem ser executadas na Calculadora.
As solicitações são enviadas via POST ou GET método para uma URL no seguinte formato:
https://chatter.mavibot.ai/api/{api_key}/{action}
Onde:
api_key — a chave de acesso da API gerada nas configurações do projeto.
Para usar o token em uma solicitação de URL, primeiro você precisa gerar uma chave de API.
As instruções para fazer isso estão na seção "Gerando uma Chave de API". ссылка
Ao copiar uma URL desta página, pode aparecer um espaço e ele deve ser removido.
Exemplo de link incorreto: https://chatter.mavibot.pro /api/callback
Se o espaço após .pro permanecer, a solicitação não vai funcionar.
Não use caracteres proibidos ao enviar uma solicitação GET.
Certifique-se de entender o formato correto para solicitações GET.
Como gerar uma chave de API
O recurso antigo de geração de chave de API ainda funciona como antes, mas não está disponível para novos projetos.
Se o seu projeto já tiver chaves de API geradas sem as configurações de acesso descritas nesta seção, essas chaves de API existentes continuarão funcionando normalmente.
Se você precisar gerar novas chaves, use as configurações atualizadas.
Para gerar uma chave de API, vá para as configurações do projeto:
Em seguida, vá para a seção "Integrações":
Você encontrará o botão “Adicionar chave de API” na seção "Integrações":
Depois de clicar no botão, uma janela modal será aberta com as configurações de acesso e as opções de geração de chave de API:
Em seguida, você precisa selecionar as permissões de acesso para a chave de API:
A função da API funcionará de acordo com as permissões de acesso que você selecionar.
Por favor, observe!
A função da API depende das permissões de acesso que você definir: se você gerar uma chave de API com acesso somente leitura às informações do cliente e depois usá-la para enviar uma mensagem a um cliente ou modificar suas variáveis, a solicitação da API falhará. A permissão necessária para cada solicitação de API é especificada no cartão da solicitação de API:
Em seguida, digite um nome para a chave de API:
Gere a chave de API clicando no botão "Gerar":
После чего нажмите "Готово" и ключ api добавится в раздел:
Você pode adicionar quantas chaves de API forem necessárias, atribuindo permissões de acesso diferentes a cada uma.
Em seguida, você precisa definir uma chave primária do projeto. Isso permite usar a chave em uma URL de solicitação com o placeholder #{api_key}.
Para fazer isso, clique no botão "{+}" à direita da chave de API desejada:
Em seguida, aparecerá um rótulo ao lado da chave, indicando que ela é a chave primária do projeto.
Você pode acessar a chave primária do projeto via api_key: basta gerar a chave necessária, definir suas permissões e designá-la como a chave primária do projeto. Depois, na Calculadora, use a URL da solicitação com o placeholder #{api_key}, que conterá o valor da chave primária do projeto.
Quaisquer outras chaves geradas com configurações de acesso serão consideradas chaves secundárias. Na URL da solicitação, você pode usar o valor delas em vez de #{api_key}. Para fazer isso, copie o valor da chave secundária:
e cole-o na URL da solicitação no lugar de #{api_key}:
Uma chave de API gerada usando o método antigo é definida como a chave primária do projeto por padrão e tem permissões completas.
Atenção!
Se você excluir a chave definida como a chave primária do projeto, será necessário designar manualmente uma nova chave como primária.
Por favor, observe!
Se você tiver chaves de API geradas usando o método antigo, elas continuarão funcionando normalmente. Não é possível gerar novas chaves de API do tipo antigo.
Como receber mensagens na URL de Webhook especificada nas configurações do projeto
Cada mensagem recebida ou enviada será enviada como a seguinte solicitação JSON POST:
Se uma solicitação retornar um erro, ela não será repetida. Mesmo que o servidor retorne erros, as notificações continuarão sendo enviadas.
Como criar uma solicitação JSON
Acesse as configurações do bloco onde os dados serão gravados na tabela.
Adicione uma seção de Solicitação de API.
Selecione POST-JSON como tipo de solicitação.
Depois, preencha os campos da solicitação:
URL da solicitação — o caminho para a função que será chamada. Na documentação, isso sempre é mostrado na primeira linha ao lado do tipo de solicitação:
Valores salvos — uma lista de parâmetros de resposta com os nomes das variáveis onde os resultados devem ser armazenados, no seguinte formato:
request_parameter -> your_variable
Se a resposta contiver parâmetros com uma estrutura complexa, processe-os da seguinte forma:
"cell_number":{"row":4,"col":2} cell_number|row ->String; cell_number|col -> Column
Cabeçalhos da solicitação — preencha se necessário. Normalmente isso inclui o formato dos dados e/ou o token de acesso.
Parâmetros JSON — o corpo da solicitação, onde você especifica os parâmetros de dados em formato JSON. Exemplo:
{"client_id": "#{recipient_id_in_builder}", "message":"Olá!"}
Para entender a estrutura da resposta, escreva #{custom_answer} no campo Mensagem para exibir o valor da variável.
Em seguida, a documentação lista os parâmetros permitidos na seção "Body":
Como usar um webhook universal
Os métodos listados agora podem ser executados como solicitações POST ou GET.
Anteriormente, nossos métodos tinham parâmetros fixos (como client_id e fb_id) para acionar ações do assinante, o que impunha certas limitações ao integrar com serviços de terceiros.
Agora você pode especificar qual parâmetro da solicitação o SaleBot deve usar para encontrar o ID do usuário. Use um parâmetro com o prefixo value_, por exemplo, value_user_id ou value_group_id.
Além disso, o método de envio callback agora também pode ser acionado usando o e-mail do cliente (client_email) ou número de telefone (client_phone).
O callback, fb_callback, e whatsapp_callback os métodos não estão vinculados a nomes de parâmetros específicos. Você pode especificar qual parâmetro contém o número de telefone, o e-mail ou o ID do cliente.
Isso é útil ao configurar o recebimento de webhook de um site.
Para especificar qual variável contém o client_id, use o parâmetro value_client_id e informe o nome do parâmetro que contém esse valor.
Para especificar qual variável contém o número de telefone, use value_phone.
Para especificar qual variável contém o e-mail, use value_email.
Para especificar qual variável contém o user_id, use value_user_id.
Para especificar qual variável contém o group_id, use value_group_id.
Para especificar a variável que contém a própria mensagem no webhook, use value_message (passado da mesma forma que os outros parâmetros).
Exemplo:
No endereço, especifique value_client_id = my_client.
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Olá mundo"}
A solicitação será equivalente à abaixo:
https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Olá mundo"}
Como você pode ver, o nome do parâmetro que contém o valor é precedido por value_.
Por favor, observe!
Alguns eventos geram notificações do sistema dentro do projeto.
Por exemplo, há notificações do sistema com um campo de mensagem que não está vazio, mas não contém texto do cliente.
Ao mesmo tempo, o projeto também pode gerar hooks de mensagens com conteúdo específico, como "message: new_chat_member".
Portanto, é importante verificar o conteúdo: ele será uma notificação do sistema ou um hook para um evento específico.
Como iniciar o bot
Iniciar o bot
POST https://chatter.mavibot.ai/api/#{api_key}/callback
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/callback
Este método pode ser usado para acionar um funil para um cliente ou confirmar uma ação em um recurso externo. O cliente não verá esta mensagem.
Observe: quaisquer parâmetros que você enviar adicionalmente serão salvos na variável
O método callback agora também pode ser acionado usando o e-mail do cliente (client_email) ou número de telefone (client_phone).
Permissão de acesso ao gerar uma chave: "Permissão para modificar/excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
client_phone - número de telefone usado para localizar o cliente
client_email - e-mail usado para localizar o cliente
client_id - ID do cliente no construtor
message - texto da mensagem
resume_bot - True (parâmetro opcional). Se o bot estiver pausado, isso é usado para retomá-lo.
Exemplo: resume_bot = True
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Iniciando o bot usando um número do WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
URL da solicitação: https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
Este método pode acionar o bot do WhatsApp depois que um cliente se registra no site ou envia uma solicitação com o número de telefone.
Observe: quaisquer parâmetros que você enviar adicionalmente serão salvos na variável
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
name - nome do cliente message - texto da mensagem phone - número de telefone do cliente bot_id - ID do bot resume_bot - True (parâmetro opcional). Se o bot estiver pausado, use isso para retomá-lo. Exemplo: resume_bot = True
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Iniciando o bot usando um ID do Telegram
POST https://chatter.mavibot.pro/api/#{api_key}/tg_callback
URL da solicitação: https://chatter.mavibot.pro/api/#{api_key}/tg_callback
Este método pode ser usado para acionar um funil para um cliente ou confirmar uma ação em um site externo. O cliente não verá esta mensagem.
Observe: quaisquer parâmetros que você enviar adicionalmente serão salvos nas variáveis.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
message - texto da mensagem user_id - ID do usuário no Telegram group_id - nome do bot (terminado em bot) resume_bot - True (parâmetro opcional). Se o bot estiver pausado, use isso para retomá-lo. Exemplo: resume_bot = True
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Enviando mensagens callback para uma lista de clientes por platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
Quando clientes com um platform_id da lista forem encontrados no projeto, um callback será enviado com o texto do campo callback_text. Limite: 1 solicitação = no máximo 300 envios
Exemplo de parâmetros da solicitação: {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
platform_ids - Lista de IDs de clientes no mensageiro callback_text - texto do callback group_id - ID do bot
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Enviando uma mensagem callback para um cliente por e-mail
POST https://chatter.mavibot.ai/api/#{api_key}/email_callback
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/email_callback
Este método pode acionar o bot de e-mail depois que um cliente se registra no site ou envia uma solicitação com o e-mail dele. O método localizará o e-mail do cliente ou o criará se não for encontrado.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Observe: quaisquer parâmetros que você enviar adicionalmente serão salvos na variável
Caminho
chave api* - token de acesso
Body
name - nome do cliente message - texto da mensagem email - endereço de e-mail email_id_bot - endereço de e-mail do bot resume_bot - True (parâmetro opcional).
Se o bot estiver pausado, use isso para retomá-lo. Exemplo: resume_bot = True
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Como trabalhar com mensagens
Parâmetros de envio de mensagem
attachment_type — pode ser: imagem, vídeo, link, arquivo ou áudio. Ao enviar um anexo, o parâmetro message é opcional.
buttons — define os botões a serem anexados à mensagem. O formato dos botões corresponde às configurações avançadas de botões.
Os botões podem ser passados de duas formas: com uma dica para mensageiros que não suportam botões, ou sem ela.
Exemplo do parâmetro buttons:
Enviando uma mensagem para um cliente
POST https://chatter.mavibot.ai/api/#{api_key}/message
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/message
Este método pode ser usado para enviar mensagens de notificação. O parâmetro message é obrigatório, a menos que você esteja enviando um arquivo. Se você estiver enviando um arquivo, o texto é opcional.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
message_id - número do bloco para envio message - texto da mensagem client_id - ID do cliente no construtor attachment_type - tipo de exibição do arquivo. Obrigatório se attachment_url for fornecido. attachment_url - URL do arquivo buttons - botões
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Enviando uma mensagem no WhatsApp
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message
URL da solicitação: https://chatter.mavibot.pro/api/<api_key>/whatsapp_message
Permite enviar uma mensagem em nome do bot conectado para o número especificado. O whatsapp_bot_id deve ser obtido na seção "Mensageiros e chats". Cada conta do WhatsApp conectada recebe um identificador exclusivo do construtor.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
message_id - número do bloco para envio whatsapp_bot_id - ID do bot do WhatsApp de onde a mensagem deve ser enviada attachment_url - URL do arquivo attachment_type - tipo de exibição do arquivo. Obrigatório se attachment_url for fornecido. message - texto da mensagem phone - número de telefone do destinatário
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Envio em massa de mensagens
POST https://chatter.mavibot.ai/api/#{api_key}/broadcast
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/broadcast
Este método permite iniciar uma transmissão.
Você pode usar uma das seguintes opções mutuamente exclusivas:
parâmetro list — a transmissão será enviada para a lista especificada de clientes.
parâmetro clients — a transmissão será enviada para uma matriz de IDs de clientes.
parâmetros platform_ids e group_id — a transmissão será enviada para uma matriz de platform_ids (IDs de mensageiros) para o bot especificado (group_id).
Se nenhum dos parâmetros acima for fornecido, a transmissão não será enviada.
Parâmetros obrigatórios: message (e/ou attachment_type e attachment_url) ou message_id.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
list - número da lista para a qual a transmissão deve ser enviada
clients - IDs de clientes no construtor
message - texto da mensagem
platform_ids - IDs dos destinatários no mensageiro. Deve ser usado junto com o parâmetro obrigatório group_id
group_id - obrigatório apenas ao usar platform_ids. Ignorado com outras opções. Especifica o bot para envio aos platform_ids informados
attachment_url - URL do arquivo
attachment_type - tipo de exibição do arquivo. Obrigatório se attachment_url for fornecido.
buttons - botões
message_id - número do bloco para envio
shift — número de segundos entre mensagens. O padrão é 0.2.
time_shift - número. Se especificado, a mensagem será enviada após o número informado de segundos a partir do momento atual.
send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (por exemplo, "2024-10-16 13:15:59"). Isso define a data e a hora para o envio da mensagem. Se time_shift e send_time forem especificados, time_shift terá prioridade.
Recuperando o histórico de mensagens
GET https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
O parâmetro client_id pode ser obtido aqui. ссылка
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente".
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
limit - número de itens na resposta. Padrão: 2000, máximo: 2000
start_date - data inicial do período de seleção (obrigatório se stop_date for especificado), formato: dd.mm.aaaa
stop_date - data final do período de seleção (obrigatório se start_date for especificado), formato: dd.mm.aaaa
Limpar histórico de mensagens
GET https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
Exclui o histórico do chat
Permissão de acesso ao gerar uma chave: "Permissão para modificar/excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
Como atribuir clientes
Atribuindo um cliente a um funcionário
POST https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
Este método permite atribuir um cliente a um funcionário. O parâmetro email é opcional. Se nenhum e-mail for informado, o sistema atribuirá o cliente de acordo com seu algoritmo.
Permissão de acesso ao gerar uma chave: "Permissão para modificar/excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente email - e-mail do funcionário (opcional)
Importando clientes para o sistema
POST https://chatter.mavibot.ai/api/#{api_key}/load_clients
URL da solicitação: https://chatter.mavibot.pro/api/#{api_key}/load_clients
Este método permite importar clientes para o sistema. Ao enviar clientes do WhatsApp, você pode informar o número em qualquer formato, com ou sem o final @s.whatsapp.net.
O ID do grupo (group_id) pode ser obtido AQUI via /api/<api_key>/connected_channels. (Se client_type = 13 (telefonia), então group_id é uma string vazia: ""). ссылка
O tipo de mensageiro de onde o cliente veio (client_type) pode ser encontrado AQUI. ссылка
Exemplo: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
platform_id - número de telefone group_id - ID do grupo client_type - o tipo de mensageiro de onde o cliente veio
Adicionar clientes a uma lista
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
URL da solicitação: https://chatter.mavibot.ai/api/<api_key>/add_to_list
Adiciona clientes a uma lista
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
list_id - número da lista clients - array de IDs de clientes
Exemplo: Parâmetros JSON {"list_id":1170282, "clients":[411262772, 646410963]}
Remover clientes de uma lista
POST https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
Remove clientes de uma lista
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
list_id - número da lista clients - array de números de clientes no construtor Mavibot (valores de client_id)
Recuperar lista de clientes
GET https://chatter.mavibot.ai/api/<api_key>/get_clients
URL da solicitação: https://chatter.mavibot.a/aipi/<api_key>/get_clients
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
offset – Deslocamento a partir do primeiro elemento
limit – Número de itens na resposta / Padrão: 500, Máximo: 500
list – Número da lista
reverse – Indica ordenação reversa (do registro mais antigo para o mais recente). Esse parâmetro funciona somente se a lista não for especificada.
Retorna o status e uma matriz de itens.
Recuperar a lista de assinantes do bot em qualquer mensageiro
GET https://chatter.mavibot.ai/api/#{api_key}/subscribers
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/subscribers
Recupera as informações do cliente de um mensageiro selecionado.
Atenção! Este método não retorna variáveis.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
page tag – Tag especificada na página de inscrição group – ID do grupo VK ao qual o assinante está vinculado date_from – Inscrito após esta data (timestamp) date_to – Inscrito antes desta data (timestamp) client_type – ID do mensageiro para o qual recuperar a lista de assinantes. Se não for especificado, todos os clientes serão retornados
Como trabalhar com variáveis
Atribuindo variáveis
POST https://chatter.mavibot.ai/api/#{api_key}/save_variables
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/save_variables
! Não há limite para esta solicitação.
Permite salvar variáveis tanto no lead quanto no cliente. Por padrão, a solicitação de atribuição de variáveis as adiciona às variáveis do negócio. Para atualizar variáveis no perfil do cliente, use o prefixo client. Por exemplo, para um telefone: client.phone.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Atualizar: O parâmetro clients permite atribuir variáveis em massa. Exemplo: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}
Caminho
chave api* - token de acesso
Body
clients – Array de IDs de clientes para atribuição de variáveis
client_id – ID do cliente
variables – Hash de variáveis (pares chave-valor)
Recuperar variáveis
GET https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Exemplo: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get_variables?client_id=49177759
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
Como recuperar o ID do cliente (client_id)
Recuperar client_id usando o valor platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
platform_ids - array de IDs em um mensageiro group_id - ID do bot
Recuperar o ID do cliente do chat online
GET https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
Este método permite integrar um site com um chatbot. Por exemplo, se um usuário visitar uma página promocional, você pode enviar imediatamente uma mensagem no chat com uma oferta personalizada.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
api key* - token de acesso
Body
tag - tag (tag do cliente) name - nome do cliente recipient - ID do diálogo em um site
Onde obter o recipient?
Você pode obtê-lo no site com o chat online da Mavibot.ai, use JS para obter a propriedade MavibotAi.recipient_id.
Recuperar client_id por número do WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
Este método retorna o ID do cliente para fazer solicitações de API se você souber o número de WhatsApp do cliente. Se não existir nenhum cliente com esse número, o método retornará um erro 404.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
phone - número de telefone group_id - ID do bot
Recuperar client_id por número de telefone
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
URL da solicitação: https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Este método retorna o ID do cliente para fazer solicitações de API.
A busca é realizada tanto entre clientes do WhatsApp quanto por meio de variáveis.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
phone - número de telefone
Recuperar client_id por e-mail
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
Este método retorna o ID do cliente para fazer solicitações à API. A busca é realizada usando variáveis.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Body
email - e-mail para busca
Recuperar client_id por valor de variável
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
Este método retorna o ID do cliente para fazer solicitações de API.
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"
Caminho
chave api* - token de acesso
Body
var - nome da variável para buscar val - valor da variável group_id - ID do grupo search_in - passe o valor 'order' para pesquisar nas variáveis de negócio; pesquisa até três variáveis para clientes de projetos e retorna uma lista de clientes que possuem todas as variáveis especificadas.
Recuperar o ID do cliente criado mais recentemente por valor de variável
GET https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var?var=&val=
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var ?var=&val=
Este método retorna o ID do cliente criado mais recentemente para fazer solicitações à API. Ele pesquisa tanto variáveis de cliente quanto de negócio.
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"
Caminho
chave api* - token de acesso
Body
var - nome da variável para buscar val - valor da variável
Recuperar uma lista de valores de client_id por valor de variável
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
Este método retorna uma lista de IDs de clientes que possuem a variável especificada com o valor especificado.
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"
Caminho
chave api* - token de acesso
Body
var - nome da variável para buscar val - valor da variável
Recuperar uma lista de valores de client_id com base em vários valores de variáveis
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente".
Caminho
api key* - token de acesso
Body
variável1 - Valor1
variável2 - Valor2
variável3 - Valor3
Buscar por variáveis
POST https://chatter.mavibot.ai/api/#{api_key}/find_clients
URL da requisição: https://chatter.mavibot.ai/api/#{api_key}/find_clients
Este método pesquisa por variáveis e retorna uma lista de IDs de clientes que atendem às condições da consulta.
Por padrão, a busca é realizada nas variáveis do cliente (recomendado): {"q": {"result": "ok", "var": "home", "var": "60"}} – o cliente deve ter todas as variáveis especificadas
Buscar nas variáveis de negócio; pelo menos uma das variáveis especificadas deve estar presente: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}
O nome da variável do cliente é igual a um dos valores da lista: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}
O nome da variável do cliente NÃO é igual a nenhum dos valores da lista: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}
O nome da variável do cliente não é igual a "Joe": {"q": {"name": {"_not": "Joe"}}}
Observação: a comparação numérica funciona somente se todos os clientes tiverem valores numéricos na variável pesquisada. Se até mesmo um cliente tiver uma string, a solicitação falhará.
Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"
Parâmetros
Caminho
chave api* - token de acesso
Body
q – parâmetro obrigatório, contém as condições da consulta para pesquisa de variáveis
search_in – especifica as variáveis de qual entidade devem ser pesquisadas; se não for fornecido, a busca será feita nas variáveis do cliente. Pode receber o valor order.
include_all – indica se todas as condições em q devem ser atendidas;
False – se pelo menos uma condição corresponder, a entidade será selecionada
Como trabalhar com negócios
Recuperar o ID do negócio atual
GET https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
Permissão de acesso ao gerar a chave: "Permissão para ler informações do CRM".
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
Recuperar a lista de negócios
GET https://chatter.mavibot.ai/api/#{api_key}/get_orders
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_orders
Permissão de acesso ao gerar a chave: "Permissão para ler informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
order_status - etapa do negócio: 0 - negócios ativos 1 - negócios bem-sucedidos 2 - negócios malsucedidos
Mover um negócio para a próxima etapa no funil da Mavibot
POST https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
order_id - ID do negócio
Recuperar dados do negócio
POST https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
Permissão de acesso ao gerar a chave: "Permissão para ler informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
order_id - ID do negócio
variables - matriz de variáveis (formato:["var_name1", "var_name2"])
Adicionar variáveis do negócio
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
order_id - ID do negócio
variables - um dicionário de variáveis (a chave é o nome da variável, e o valor é o que deve ser salvo nessa variável) (formato:{"var_name": "var_velue"})
Criar um negócio
POST https://chatter.mavibot.ai/api/#{api_key}/create_order
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/create_order
Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
name - nome do negócio
description - descrição do negócio
budget - valor do negócio
Você deve especificar um dos seguintes parâmetros na requisição: client_id, email ou phone. Se vários parâmetros forem fornecidos, apenas um será usado. A ordem de prioridade é: client_id > phone > email. Se phone ou email for fornecido e não existir um cliente com esse número de telefone ou e-mail, um novo cliente será criado.
Mover um negócio para uma etapa no MavibotCRM
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_state
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/set_order_state
Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
state_id - o número da etapa para a qual o negócio do cliente deve ser movido
Recuperar o ID da etapa do funil no Mavibot CRM
GET https://chatter.mavibot.ai/api/#{api_key}/get_order_state
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/get_order_state
Permissão de acesso ao gerar a chave: "Permissão para ler informações do CRM"
Caminho
chave api* - token de acesso
Body
client_id - ID do cliente
state_id - ID do negócio (se não for especificado, o método retornará o ID da etapa do negócio atual)
Quais outras funcionalidades estão disponíveis?
Verificar se um número de telefone tem WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
URL da solicitação: https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
Para usar este método, o WhatsApp deve estar conectado ao Mavibot.
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Pode ser chamado usando GET ou POST. O número de telefone pode ser fornecido em qualquer formato.
Caminho
chave api* - token de acesso
Body
phone - número de telefone para verificar
Obter a lista de mensageiros conectados ao projeto
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
URL da requisição: https://chatter.mavibot.ai/api/<api_key>/connected_channels
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
A função retorna o parâmetro group_id para cada mensageiro, que deve ser usado ao importar clientes.
Para o WhatsApp, também retorna um status campo, que pode ter os seguintes valores:
NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3
Caminho
chave api* - token de acesso
Recuperar a lista de blocos do fluxo do bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
URL da solicitação: https://chatter.mavibot.ai/api/<api_key>/get_messages
Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".
Caminho
chave api* - token de acesso
Recuperar dados aninhados do cliente
delimiter
Para recuperar client_id e/ou o número de telefone do cliente a partir de dicionários aninhados (não no primeiro nível), use o parâmetro delimiter.
Adicione o seguinte à URL da sua requisição:
?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
onde:
?delimiter=1 – o valor do delimitador que separa as chaves {key1}1{key2}1{key3}
delimiter_value_client_id={key1}1{key2} – para recuperar o ID do cliente
delimiter_value_phone={key1}1{key2} – para recuperar o número de telefone do cliente
{key1}, {key2}, … – chaves que contêm os valores (podem incluir quaisquer caracteres, exceto o delimitador). Você pode ter uma quantidade ilimitada de chaves: ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. As chaves são passadas sem chaves curvas.
Use o delimitador entre as chaves. Por exemplo, se delimiter=2, então {key1}2{key2}2{key3}; se delimiter=5, então {key1}5{key2}5{key3}. Certifique-se de que a chave não contenha o caractere do delimitador.
Exemplo:
https://chatter.mavibot.a/aipi/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
Você também pode recuperar apenas o ID ou apenas o número de telefone:
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2} - apenas o ID do cliente;
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1delimiter_value_phone={key1}1{key2} - apenas o número de telefone;
Métodos da API:
Iniciar bot: https://chatter.mavibotbot.ai/api/<api_key>/callback
Iniciar bot pelo número do WhatsApp: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_callback
Iniciar bot pelo ID do Telegram: https://chatter.mavibotbot.ai/api/<api_key>/tg_callback
Enviar mensagem de callback para cliente por e-mail: https://chatter.mavibotbot.ai/api/<api_key>/email_callback
Enviar mensagem para o cliente: https://chatter.mavibotbot.ai/api/<api_key>/message
Enviar mensagem do WhatsApp: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_message
Envio em massa: https://chatter.mavibotbot.ai/api/<api_key>/broadcast
Atribuir variáveis: https://chatter.mavibotbot.ai/api/<api_key>/save_variables
Se você precisar de métodos adicionais, entre em contato com o suporte.
Atualizado