A API do software de edição

Quais requisições o software de edição suporta e como realizá-las

• Como obter mensagens na URL do Webhook especificada nas configurações do projeto

• Como usar um webhook universal

• Como iniciar o bot

• Como trabalhar com mensagens

• Como distribuir os clientes

• Como trabalhar com variáveis

• Como obter client_id

• Quais outras possibilidades existem

As requisições são feitas com o método POST na URL, ou seja, https://chatter.mavibot.ai/api/{api_key}/{action}

Onde ele está localizado: api_key é a chave de acesso à API, obtida nas configurações do projeto:

Você pode obter a chave de acesso usando a variável #{api_key}. Ela contém a chave gerada correspondente. Não se esqueça de gerar uma antes de usá-la.

Ao copiar a URL da consulta desta página, é inserido um espaço que deve ser removido ao fazer a chamada

Um exemplo de cópia incorreta do link: https://chatter.mavibot.ai/api/callback

O espaço após .pro é fácil de passar despercebido, mas, se ele for mantido, a consulta não funcionará

Ao enviar a requisição com o método GET, não use palavras proibidas. Veja a formação correta das requisições GET

Como obter mensagens na URL do Webhook especificada nas configurações do projeto

As configurações do projeto

Toda mensagem recebida ou enviada vem com as seguintes requisições POST em JSON:

{
    'id': o identificador da mensagem no sistema,
    'client': {
        'id': o identificador do cliente no sistema,
        'recepient': o identificador do cliente no mensageiro,
        'client_type': o tipo do mensageiro,
        'name': o nome do cliente,
        'avatar': o avatar do cliente,
        'created_at': a data em que o cliente foi criado,
        'tag': a chave de assinatura,
        'group': o bot ao qual o cliente está vinculado,
    },
    'message': o texto da mensagem,
    'attachments': o array de links para arquivos,
    'message_id': o id do bloco de onde a mensagem foi enviada,
    'project_id': o id do projeto,
    'is_input': 1 se a mensagem for de um cliente, 0 se for do bot,
    'delivered': 1 se a mensagem foi enviada com sucesso, 0 se houve um erro,,
    'error_message': a mensagem que explica o erro
}

Se a requisição retornar com erro, ela não será reenviada. Se o servidor retornar com erro, as notificações ainda assim serão recebidas.

Como usar um webhook universal

Agora, esses métodos podem ser acionados tanto com a requisição POST quanto com a GET.

• callback

• whatsapp_callback

• message

• whatsapp_message

Anteriormente, os parâmetros (com os quais os métodos dos clientes eram iniciados, ou seja, client_id) eram escritos de forma muito rígida em nossos métodos, o que impunha algumas restrições ao usá-los com serviços de terceiros.

Agora você pode indicar em qual parâmetro da requisição o Mavibot vai procurar o identificador do usuário: para isso, usa-se um parâmetro com o prefixo value_ como value_user_id e value_group_id.

Além disso, o método para enviar o callback callback pode ser iniciado transmitindo um e-mail (client_email) e um número de telefone do cliente (client_phone).

Métodos callback e whatsapp_callback não estão vinculados aos nomes dos parâmetros. Você pode especificar qual parâmetro conterá o número de telefone, o e-mail e o id do cliente.

Isso é útil quando você está configurando o recebimento do webhook por meio de outro site.

Para especificar qual variável contém client_id você precisa passar value_client_id e indicar o nome do parâmetro com esse valor nele

Para especificar qual variável contém phone você precisa passar value_phone e indicar o nome do parâmetro com esse valor nele

Para especificar qual variável contém email você precisa passar value_email e indicar o nome do parâmetro com esse valor nele

Para especificar qual variável contém user_id você precisa passar value_user_id e indicar o nome do parâmetro com esse valor nele

Para especificar qual variável contém group_id você precisa passar value_group_id e indicar o nome do parâmetro com esse valor nele

Exemplo:

Digite no endereço value_client_id = meu_cliente

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client {"my_client":49177759, "message":"Olá mundo"}

A consulta será equivalente à consulta abaixo:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback {"client_id":49177759, "message":"Olá mundo"}

Como você pode ver, o nome do parâmetro que contém o nome é diferenciado pelo prefixo value_

Como iniciar o bot

A inicialização do bot

POST https://chatter.mavibot.ai/api/<api_key>/callback

O método pode ser usado para iniciar o fluxo de trabalho do cliente ou para aprovar a ação em um serviço de terceiros. Esta mensagem não ficará visível para o cliente. Os parâmetros transferidos adicionalmente são salvos nas variáveis. O método para enviar o callback agora pode ser ativado compartilhando um e-mail (client_email) ou o número de telefone do cliente (client_phone)

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Corpo da requisição

Name	Tipo	Descrição
client_phone	de string	número de telefone pelo qual o cliente é encontrado
client_email	de string	e-mail pelo qual o cliente é encontrado
client_id	de string	id do cliente no editor
message	de string	o texto da mensagem

200: OK

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

Inicialização do bot por meio do número no WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Este método inicia o bot no WhatsApp depois que o cliente se cadastra pelo site ou depois que ele deixa uma solicitação com o número de telefone Os parâmetros transferidos adicionalmente são salvos nas variáveis

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Corpo da requisição

Name	Tipo	Descrição
name	de string	o nome do cliente
message	de string	o texto da mensagem
phone	de string	o número de telefone do cliente
bot_id	de string	o id do bot

200: OK

{
    // Resposta
}

Inicialização do bot por meio do id do Telegram

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

O método pode ser usado para iniciar o fluxo de trabalho ou confirmar ações em um site de terceiros. Esta mensagem não ficará visível para o cliente.

Os parâmetros transferidos adicionalmente são salvos nas variáveis

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Corpo da requisição

Name	Tipo	Descrição
message	de string	o texto da mensagem
user_id	de string	o id do usuário no Telegram
group_id	de string	o nome do bot (deve terminar em bot)

200: OK

{
    // Resposta
}

Como trabalhar com mensagens

Parâmetros para envio de mensagens

attachment_type pode assumir estes valores: imagem, vídeo, link, arquivo, áudio Ao enviar anexos, o parâmetro message não é obrigatório

buttons identifica os botões que serão anexados à mensagem. O formato dos botões é comparável às configurações avançadas do botão. São possíveis duas variantes de envio dos botões: uma com a dica em mensageiros sem botões e outra sem ela

Aqui está um exemplo do parâmetro buttons:

"buttons": {"hint": "Este texto será mostrado no WhatsApp",
 "buttons": [
    {"type": "reply", 
     "text": "Quais serviços podemos oferecer", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Informações de pagamento", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "Nossas informações de contato", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Deixar uma solicitação", 
     "line": 1, "index_in_line": 1}
   ] 
}

Enviando a mensagem ao cliente

POST https://chatter.mavibot.ai/api/<api_key>/message

Este método pode ser usado para enviar mensagens com notificações. O parâmetro message é obrigatório se você não estiver enviando um arquivo. Se estiver, o texto não é necessário

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
message_id	de string	o número do bloco de envio
message	de string	o texto da mensagem
client_id	de string	o id do cliente no editor
attachment_type	de string	o tipo de exibição do arquivo
attachment_url	de string	a URL do arquivo
buttons	objeto	buttons

200: OK

import requests
import json

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

Enviando mensagens no WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Permite enviar uma mensagem, em nome do bot conectado, para o número mencionado whatsapp_bot_id deve ser obtido na seção “Mensageiros e chats”. Cada página do WhatsApp conectada recebe uma identificação única

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
message_id	de string	o número do bloco de envio
whatsapp_bot_id	número	o bot do WhatsApp que envia a mensagem
attachment_url	de string	a url do arquivo
attachment_type	de string	o tipo de exibição do arquivo
message	de string	o texto da mensagem
phone	de string	o número de telefone do destinatário

200: OK

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)

Envio de mensagens em massa

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

O método permite a distribuição de mensagens. Se o parâmetro clients não for mencionado, o broadcast será enviado para todos os usuários. É necessário enviar um arquivo ou um texto

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
message_id	de string	o número do bloco de envio
list	de string	a lista de números dos destinatários
shift	de string	a quantidade de segundos entre as mensagens. 0,2 por padrão
message	de string	o texto da mensagem
clients	array	os ids dos destinatários
attachment_type	de string	o tipo de exibição do arquivo
attachment_url	de string	a URL do arquivo
buttons	de string	buttons

200: OK

{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)

Obtendo o histórico de mensagens

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Obtendo o histórico de mensagens. Você pode obter o client_id parâmetro AQUI

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Parâmetros da consulta

Name	Tipo	Descrição
client_id	de string	o id do cliente

200: OK

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "CouCou",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true"
    },
  ]
}

Limpando o histórico de mensagens

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Parâmetros da consulta

Name	Tipo	Descrição
client_id	de string	o id do cliente

200: OK

import requests
import json


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

Como distribuir os clientes

Atribuindo um cliente a um funcionário

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

O método permite atribuir um cliente a um funcionário. O parâmetro de e-mail é opcional. Se o e-mail não for informado, ele será distribuído pelo algoritmo do sistema

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Parâmetros da consulta

Name	Tipo	Descrição
client_id	String	o id do cliente
e-mail	String	o e-mail do atendente (opcional)

200: OK

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)

Carregando clientes no sistema

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

O método permite carregar clientes no sistema. Ao enviar clientes do WhatsApp, você pode passar o número livremente com o @s.whatsapp.net no final ou sem ele.

Você pode obter o id do grupo (group_id) aqui por meio de /api/<api_key>/connected_channels

(se client_type=13 (telefonia), então group_id="")

Você pode ver o tipo de mensageiro de onde o cliente veio (client_type)

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

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
platform_id	String	o número de telefone
group_id	String	o id do grupo
client_type	String	o tipo de mensageiro de onde o cliente veio

200: OK

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)
# em caso de sucesso, a função retorna para cada elemento seu id e status adicional
# exemplo de resposta
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Adicionando clientes à lista

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
list_id	número inteiro	o número da lista
clients	array	o array dos números dos clientes

200: OK

{
    // Resposta
}

Removendo clientes da lista

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
list_id	número inteiro	o número da lista
clients	array	o array dos números dos clientes

200: OK

{
    // Resposta
}

Obtendo a lista de clientes

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Parâmetros da consulta

Name	Tipo	Descrição
offset	de string	deslocamento a partir do primeiro elemento
limit	número inteiro	a quantidade de elementos na resposta. 500 por padrão, máx. 500
list	de string	o número da lista

200: OK Retorna o status dos elementos e o array

{
"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
    }
]
}

Obtendo a lista de assinantes em qualquer mensageiro

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Obtendo informações sobre os clientes no mensageiro escolhido

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Parâmetros da consulta

Name	Tipo	Descrição
page	número inteiro
tag	de string	a tag mencionada na página de inscrição
group	número inteiro	o id do grupo ao qual o assinante está vinculado
date_from	número inteiro	timestamp da data após a qual eles se inscreveram
date_to	número inteiro	timestamp da data até a qual eles se inscreveram
client_type	número inteiro	o id do mensageiro para o qual você precisa carregar a lista. se não alterar nada, todos os clientes serão exibidos

200: OK

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

Permissão para excluir clientes

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Permissão de acesso ao gerar a chave: “Permissão para excluir clientes”

Parâmetros

Caminho api key* — token de acesso

Corpo client_ids — lista de IDs de clientes a serem excluídos. Máximo de 500. Exemplo: [199571, 199707, 1935722]

Como trabalhar com variáveis

Atribuição de variáveis

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Permite salvar variáveis na aplicação e no cliente. A requisição de atribuição de variáveis, por padrão, adiciona às variáveis da transação. Se você precisar alterar as variáveis no perfil, é necessário adicionar o prefixo client. Ex.: para mobile: client.phone

O parâmetro clients permite atribuir variáveis em massa

Ex.: {"client_id":49177759, "variables": {"client.phone":"1234567890"}}

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
clients	array	array de ids de clientes para atribuição de variáveis
client_id	de string	id do cliente
variáveis	objeto	hash da variável (valor da chave)

200: OK

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)

Obtendo variáveis

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
client_id	de string	id do cliente

200: OK

import requests
import json


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

Como obter client_id

Obtendo client_id pelo valor platform_id

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

O método retorna o id do cliente para executar requisições à API

Exemplo de parâmetros: {"platform_ids": ["571830542", "256865200"]}

Parâmetros de caminho

Name	Tipo	Descrição
	de string	chave de acesso

Corpo da requisição

Name	Tipo	Descrição
platform_ids	de string	array de ids no mensageiro

200: OK

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\\/\\/files.salebot.pro\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Salebotpro_bot",
"variables":{"tg_username":"@wildeo"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.salebot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Salebotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]

Como obter o id do cliente no chat online

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Este método permite integrar o site e o chatbot, ou seja, se uma pessoa acessar a página com a oferta especial, você pode enviar instantaneamente uma mensagem sobre a oferta no chat

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
tag	de string	tag do cliente
name	de string	o nome do cliente
recipient	de string	o id do diálogo no site

200: OK

{ "client_id": 36553 }

Onde você obtém o recipient? No site que usa o chat online “Mavibot.ai”, você precisa obter a propriedade SaleBotPro.recipient_id com a ajuda de JS.

Como obter o id do cliente pelo número do WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

O método retorna o id do cliente para executar requisições à API se você souber o número de telefone do cliente no WhatsApp. Se não houver nenhum cliente com esse número, você receberá um 404.

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
phone	de string	o número de telefone

200: OK

{
    // Resposta
}

Obtendo o id do cliente pelo número de telefone

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

O método retorna o id do cliente para executar requisições à API. A busca ocorre pelos clientes do WhatsApp, bem como pelas variáveis.

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
phone	de string	o número de telefone

200: OK

{
    // Resposta
}

Obtendo o id do cliente por e-mail

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

O método retorna o id do cliente para executar requisições à API. A busca ocorre por meio das variáveis.

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
email	de string	e-mail para busca

200: OK

{
    // Resposta
}

Obtendo o id do cliente pelo valor da variável

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

O método retorna o id do cliente para executar requisições à API

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Parâmetros da consulta

Name	Tipo	Descrição
var	de string	o nome da variável pela qual a busca será feita
val	de string	o valor da variável

200: OK

{
    // Resposta
}

Quais outras possibilidades existem

Movendo a transação para o status MavibotCRM

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

O número da transação pode ser obtido na janela de edição do fluxo de trabalho do MavibotCRM.

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
client_id	de string	id do cliente
state_id	de string	o número do status para o qual a transação do cliente será transferida

200: OK

{
    // Resposta
}

Verificando se a pessoa segue a conta do Instagram

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

Pode ser chamado tanto com o método POST quanto com o método GET

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	a chave de acesso

Corpo da requisição

Name	Tipo	Descrição
user_name	de string	o nome de usuário do cliente que você deseja verificar
login	de string	o login do bot que está sendo verificado

200: OK O campo is_follower é o que contém a informação sobre se a pessoa o segue ou não

{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}

Verificando se o número de telefone usa WhatsApp

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

Para usar o método, você PRECISA ter o WhatsApp e o Mavibot conectados

Pode ser chamado tanto com o método POST quanto com o método GET O número de telefone pode ser passado em qualquer formato

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

Corpo da requisição

Name	Tipo	Descrição
phone	de string	o número de telefone

200: OK

{
    // Resposta
}

Obtendo a lista de mensageiros conectados ao projeto (incluindo group_id)

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

A função retorna o parâmetro group_id para cada mensageiro e ele é o que precisa ser passado ao carregar os clientes

O campo status também retorna para o WhatsApp, e ele contém um valor de: NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

200: OK

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'salebotstage', 
        'name': 'salebotstage', 
        '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': [] 
}

Obtendo a lista de blocos do schema do bot

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

Parâmetros de caminho

Name	Tipo	Descrição
api_key	de string	token de acesso

200: OK

{
    // Resposta
}

Se você precisar de métodos adicionais, entre em contato com o suporte ao cliente