API Maxbot v1.0
Documentação da API
Este documento relaciona a documentação referente à utilização da API Maxbot. A API Maxbot permite integração do Maxbot com sistemas externos como RPs e CRMs. A API permite fazer o download dos dados dos contatos, protocolos, diálogo do protocolo, bem como o disparo de mensagens de texto, imagem, arquivo e áudio.
Ativação da API
Para ativar a API Maxbot faça o login em sua conta Maxbot e vá para Configuração/API Maxbot. Clique no botão de ativação. Um token de identificação da conta será gerado e a API será ativada para a sua conta. Caso precise gerar um novo token de identificação, clique no botão Gerar Novo Token. O token informado na tela será o token de identificação de conta que será usado na validação de comunicação com a API Maxbot.
Apresentação
A API (sigla em inglês para Interface de Programação de Aplicativos) é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A plataforma Maxbot oferece uma API REST de comunicação que permite a integração do Maxbot com sistemas externos, possibilitando:
- Disparo de mensagens de texto, áudio (mp3), imagem (jpg, jpeg ou png) e arquivo (pdf, doc, docx, xls, xlsx, ppt e pptx);
- Download da base de contatos dentro de um período de tempo;
- Download dos protocolos de atendimento juntamente com todo o diálogo trocado (apenas protocolos concluídos);
- Situação atual da API indicando se está ativa ou inativa;
A documentação está organizada de forma a apresentar de maneira sucinta as orientações técnicas necessárias para a integração. Os exemplos operacionais estão disponíveis na linguagem PHP 7.3 que servem de modelo de entendimento de como a integração externa com o Maxbot pode ser feita. Ela deve ser adaptada conforme a necessidade.
Requisitos
Cada cliente pode realizar até 10 requisições por segundo.
Se sua aplicação precisar de um limite maior, por favor contate o suporte para avaliação e ajuste.
- O limite de 10 requisições por segundo (10 RPS) é contabilizado por cliente/token.
- Chamadas acima desse limite podem retornar HTTP 429 — Too Many Requests.
- O contador é reiniciado a cada segundo.
Exemplo: Se sua aplicação enviar 15 requisições no mesmo segundo, apenas 10 serão processadas.
URL:
https://app.maxbot.com.br/api/v1.php
- O cliente (solicitante) monta uma requisição em JSON, informando os parâmetros necessários.
- A requisição deve ser enviada via HTTP POST para a URL da API Maxbot.
- A API valida os dados recebidos, processa a solicitação e retorna a resposta em JSON.
- Disparo de mensagens: Retorna sucesso ou falha.
- Consulta de dados: Retorna sucesso ou falha, juntamente com a massa de dados solicitada.
- Todo retorno é feito em estrutura JSON, que deve ser tratado pelo cliente.
- O idioma padrão da API Maxbot é inglês (en_US).
Endpoints
Geral
- get_statusRequisita a situação atual da API Maxbot
- get_channelRequisita dados dos canais
- get_account_instagramRequisita dados das contas do Instagram
- get_page_facebookRequisita dados das páginas do Facebook
- get_balance_gupshupRequisita saldo Gupshup
- get_menu_callsRequisita quantidade de chamadas de menu por período
Contato
Segmentação
Protocolo
Atendimento
Template
Quadro Ágil
- get_cfx_typeRequisita listagem de tipos de processos da conta Maxbot
- get_cfx_stageRequisita listagem de etapas do processo da conta Maxbot
- get_cfx_process_listRequisita listagem de processos da conta Maxbot
- get_cfx_processRequisita dados do processo indicado do quadro ágil
- put_cfx_processRequisita registro ou atualização da ficha do processo do quadro ágil da conta Maxbot
- set_cfx_processRequisita atualização da ficha do processo do quadro ágil da conta Maxbot
Agendamento
- get_scheduleRequisita listagem de agendamentos do módulo agendamento da conta Maxbot
- get_schedule_typeRequisita listagem dos tipos de agendamentos do módulo agendamento da conta Maxbot
- get_schedule_professionalRequisita listagem dos profissionais de agendamentos do módulo agendamento da conta Maxbot
- get_schedule_hourRequisita listagem dos horários de agendamentos do módulo agendamento da conta Maxbot
- insert_scheduleInserir agendamento
- update_scheduleInserir agendamento
- delete_scheduleDeletar agendamento
- schedule_automationRequisita Agendamento de Automação
Cobrança
Envio de Mensagens
- send_noticeRequisita disparo de template de aviso ou template de autenticação
- send_template_integrationRequisita disparo de template de aviso avulso
- open_followupRequisita abertura de protocolo de follow up com disparo de template de follow up ou template de autenticação
- get_message_statusRequisita o status de envio de uma mensagem WABA (sent/delivered/read/failed)
- send_textRequisita disparo de mensagem de texto
- send_text_integrationRequisita disparo de mensagem de texto avulso
- send_chat_msgRequisita disparo de mensagem.
- send_chat_audioRequisita disparo de áudio.
- send_chat_annexRequisita disparo de anexo.
- send_smsRequisita disparo de sms
- send_emailRequisita disparo de E-mail
- send_imageRequisita disparo de imagem
- send_fileRequisita disparo de documento
- send_soundRequisita disparo de áudio
CRM / Negócios
Campos Personalizados
PipeDrive
Webhooks
- Visão geralReceba eventos do Maxbot (mensagens, contatos, cobranças) na sua URL
- Mensagem RecebidaRetorno do Webhook de recebimento de mensagens recebidas
- Mensagem Recebida em AtendimentoRetorno do Webhook de recebimento de mensagens de protocolos em atendimento
- Novo ContatoRetorno do Webhook de recebimento de novo contato
- Contato AtualizadoRetorno do Webhook de recebimento de contato atualizado
- Charge (Cobrança)Retorno do Webhook da situação de cada envio da cobrança
- Status da MensagemRetorno do Webhook com o status de envio de mensagens WABA (Gupshup/Meta)