Construtor de API

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.

Por favor, note: quaisquer parâmetros que você passar adicionalmente serão salvos na variável

O método de 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

api key* - token de acesso

Corpo

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 builder

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 determinado de segundos a partir da hora 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 hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.salebot.pro/api/{token}/callback'
requests.post(url, json=params)

URL da requisição: https://chatter.mavibot.ai/api/\<api_key>/whatsapp_callback>

Este método pode acionar o bot do WhatsApp após um cliente se registrar no site ou enviar uma solicitação com seu número de telefone.

Atenção: quaisquer parâmetros adicionais que você passar serão salvos em variáveis

Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

URL da requisiçã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.

Atenção: quaisquer parâmetros adicionais que você passar serão salvos em variáveis.

Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - token de acesso

Body

message - texto da mensagem
user_id - ID do usuário do 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

URL da requisição: https://chatter.mavibot.ai/api/#{api\_key}/send\_callback\_by\_platform\_id

Quando clientes com um platform_id da lista são encontrados no projeto, um callback será enviado com o texto do campo callback_text.
\ Limite: 1 requisição = máximo de 300 envios

Exemplo de parâmetros da requisiçã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".

Path

api key* - token de acesso

Body

platform_ids - Lista de IDs dos 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

URL da requisição: https://chatter.mavibot.ai/api/#{api\_key}/email\_callback

Este método pode acionar o bot de e-mail após um cliente se registrar no site ou enviar uma solicitação com seu e-mail. 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".

Atenção: quaisquer parâmetros adicionais que você passar serão salvos em variáveis

Path

api key* - 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

URL da requisiçã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".

Path

api key* - 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

import requests
import json

# Enviando uma mensagem de texto
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Enviando um anexo
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Em 'attachment_type', especifique 'video', 'image' ou 'file'
# dependendo do tipo de anexo: vídeo, imagem ou documento.

URL da requisiçã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 único do construtor.

Permissão de acesso ao gerar uma chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - token de acesso

Body

message_id - número do bloco para envio
whatsapp_bot_id - ID do bot do WhatsApp do qual 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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

URL da requisiçã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:

1. parâmetro list — a transmissão será enviada para a lista especificada de clientes.
2. parâmetro clients — a transmissão será enviada para um array de IDs de clientes.
3. parâmetros platform_ids e group_id — a transmissão será enviada para um array de platform_ids (IDs do mensageiro) para o bot especificado (group_id).
4. 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".

Path

api key* - token de acesso

Body

list - número da lista para a qual a transmissão deve ser enviada

clients - IDs dos 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 para os platform_ids fornecidos

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 de segundos fornecido a partir do horário atual.

send_time - data e hora no formato "%Y-%m-%d %H:%M:%S" (ex.: "2024-10-16 13:15:59"). Isso define a data e hora para o envio da mensagem. Se ambos time_shift e send_time forem especificados, time_shift terá precedência.

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

URL request: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

O parâmetro client_id pode ser obtido aqui. link

Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente".

Path

api key* - 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 de início do período de seleção (obrigatório se stop_date for especificado), formato: dd.mm.yyyy

stop_date - data de fim do período de seleção (obrigatório se start_date for especificado), formato: dd.mm.yyyy

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "Meow meow",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true",
      "manager_id": 12486,
      "manager_email": "[email protected]"
    },
  ]
}

URL request: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Exclui o histórico do chat

Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do cliente".

Path

api key* - token de acesso

Body

client_id - ID do cliente

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

URL request: 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 email for fornecido, o sistema atribuirá o cliente de acordo com seu algoritmo.

Permissão de acesso ao gerar a chave: "Permissão para modificar/excluir informações do cliente".

Path

api key* - token de acesso

Body

client_id - ID do cliente
email - email do funcionário (opcional)

import requests
import json

params = {"client_id":"#{client_id}","email":"[email protected]"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

URL request: 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 fornecer 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: ""). link

O tipo de mensageiro do qual o cliente veio (client_type) pode ser encontrado AQUI. link

Exemplo: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - 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

import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'
params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# se bem-sucedido, a função retornará um ID e um status de adição para cada item
# exemplo de resposta
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

URL request: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

Adiciona clientes a uma lista

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - 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]}

URL request: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

Remove clientes de uma lista

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - token de acesso

Body

list_id - número da lista
clients - array de números de clientes no construtor Mavibot (valores de client_id)

URL request: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - 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 novo). Este parâmetro funciona apenas se a lista não for especificada.

Retorna o status e um array de itens.

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

URL request: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Recupera informações do cliente de um mensageiro selecionado.

Nota! Este método não retorna variáveis.

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - token de acesso

Body

page
tag – Tag especificada na página de assinatura
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 especificado, todos os clientes serão retornados

[  
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "vk_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Anna Smith",
    "vk_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

URL request: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Nenhum limite se aplica a esta solicitação.

Permite salvar variáveis tanto no lead quanto no cliente.
Por padrão, a solicitação de atribuição de variável as adiciona às variáveis do negócio.
Para atualizar variáveis no perfil do cliente, use o prefixo client.. Por exemplo, para telefone: client.phone.

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Atualização: O parâmetro clients permite atribuir variáveis em massa.
Exemplo: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Path

api key* - 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)

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

URL request: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Exemplo: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Path

api key* - token de acesso

Body

client_id - ID do cliente

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

URL request: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

Path

api key* - token de acesso

Body

platform_ids - Array de IDs em um mensageiro
group_id - ID do bot

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"ОЛЬГА БЕЛИК",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@belik"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"John Smith",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@jsmith61"}
}]

URL request: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Este método permite integrar um site com um bot de chat. Por exemplo, se um usuário visitar uma página de promoção, você pode enviar imediatamente uma mensagem no chat com uma oferta personalizada.

Permissão de acesso ao gerar a chave: "Permissão para modificar ou excluir informações do cliente".

URL da requisição: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Este método retorna o ID do cliente para fazer requisições à API se você souber o número de telefone do WhatsApp do cliente.
Se nenhum cliente existir 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

api key* - token de acesso

Corpo

phone - número de telefone
group_id - ID do bot

URL da requisição: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Este método retorna o ID do cliente para fazer requisições à 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

api key* - token de acesso

Corpo

phone - número de telefone

URL da requisição: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

Este método retorna o ID do cliente para fazer requisiçõ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

api key* - token de acesso

Corpo

email - e-mail para busca

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 requisições à API.

Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"

Caminho

api key* - token de acesso

Corpo

var - nome da variável para busca
val - valor da variável
group_id - ID do grupo
search_in - passe o valor 'order' para pesquisar em variáveis de negócio; pesquisa até três variáveis para clientes do projeto e retorna uma lista de clientes que possuem todas as variáveis especificadas.

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 requisiçõ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

api key* - token de acesso

Corpo

var - nome da variável para busca
val - valor da variável

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

api key* - token de acesso

Corpo

var - nome da variável para busca
val - valor da variável

{
    // Resposta
}

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

Corpo

variable1 - Valor1

variable2 - Valor2

variable3 - Valor3

{
 "status":"success","client_ids":[93891114]
}

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 pesquisa é realizada nas variáveis do cliente (recomendado): {"q": {"result": "ok", "var": "home", "var": "60"}} – o cliente deve ter todas as variáveis especificadas

Pesquisar em 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"}}}

Nota: A comparação de números funciona apenas se todos os clientes tiverem valores numéricos na variável pesquisada. Se pelo menos um cliente tiver uma string, a requisição falhará.

Permissão de acesso ao gerar a chave: "Permissão para ler informações do cliente"

Parâmetros

Caminho

api key* - token de acesso

Corpo

q – parâmetro obrigatório, contém as condições da consulta para pesquisar variáveis

search_in – especifica em qual entidade as variáveis devem ser pesquisadas; se não for fornecido, a pesquisa é feita nas variáveis do cliente. Pode assumir o valor order.

include_all – se todas as condições em q devem ser atendidas;

False – se pelo menos uma condição corresponder, a entidade é selecionada

Sucesso
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Erro
{"status":"fail","message":"Something went wrong"}

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

Resposta de sucesso: {"status":"success","order_id":40632}, onde
order_id - ID do negócio atual
Resposta de erro: {"status":"client_not_found"}

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

order_status - estágio do negócio:
0 - negócios ativos
1 - negócios bem-sucedidos
2 - negócios malsucedidos

Resposta de sucesso: {"status":"success","order_id":[40338,40340,40341]} 
Resposta de erro: {"status":"client_not_found"}

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

order_id - ID do negócio

Resposta de sucesso: 
{"status":"success","state_id":37}, onde 
state_id - ID do estágio no MavibotCRM 
Resposta de erro: 
{"status":"client_not_found"}

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

order_id - ID do negócio

variables - array de variáveis
(formato:["var_name1", "var_name2"])

Resposta de sucesso: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Exemplo de erro: 
{"status":"client_not_found"}

URL da requisiçã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

api key* - token de acesso

Corpo

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_value"})

Resposta de sucesso: {"status":"success"} 
Resposta de erro: {"status":"order 12345 not found"}

URL da requisiçã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

api key* - token de acesso

Corpo

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 nenhum cliente existir com esse número de telefone ou e-mail, um novo cliente será criado.

Resposta de sucesso: {"status":"success","order_id":40654}, 
onde order_id é o ID do novo negócio ativo.
Resposta de erro: {"status":"client_not_found"}

Mover um negócio para um estágio no MavibotCRM

**POST** https://chatter.mavibot.ai/api/#{api_key}/set_order_state

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

state_id - número do estágio para o qual o negócio do cliente deve ser movido

Recuperar o ID do estágio do funil no Mavibot CRM

**GET** https://chatter.mavibot.ai/api/#{api_key}/get_order_state

URL da requisiçã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

api key* - token de acesso

Corpo

client_id - ID do cliente

state_id - ID do negócio (se não for especificado, o método retornará o ID do estágio do negócio atual)

Exemplo de resposta bem-sucedida:
{'status': 'success', 'state_id': 123456}

Exemplo de resposta mal-sucedida:
{'status': 'order not found'}

Que outras capacidades 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 requisiçã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

api key* - token de acesso

Corpo

phone - número de telefone a 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 WhatsApp, também retorna um campo status, que pode ter os seguintes valores:

NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Caminho

api key* - token de acesso

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [], 
'avito': [], 
'ok': [], 
'vkontakte': [{
        'id': 33, 
        'group': '143414131',
        'group_id': '143414131'}]
}

Recuperar a lista de blocos do fluxo do bot

**GET** https://chatter.mavibot.ai/api/<api_key>/get_messages

URL da requisiçã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

api key* - token de acesso

Recuperar dados aninhados do cliente

Se precisar de métodos adicionais, entre em contato com o suporte.