DOCUMENTAÇÃO API MAXBOT
Bem-vindo!
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
Ativação
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
Versão: 1.0A 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
- URL da API V1: https://app.maxbot.com.br/api/v1.php
- O solicitante prepara uma requisição à API em uma estrutura JSON informando os parâmetros para processamento;
- O solicitante realiza um POST em formato JSON para a URL da API Maxbot;
- A API valida os dados informados, processa a requisição e retorna o resultado em formato JSON;
- Requisições de disparo de mensagens retornarão sucesso ou falha;
- Requisições de dados retornarão sucesso ou falha, juntamente com a massa de dados;
- Todo o retorno é feito em uma estrutura JSON que deverá ser processada de volta pelo solicitante;
- Obs.: O idioma padrão da API Maxbot é o inglês (us_EN);
Métodos
- add_segmentation Adiciona Segmentação ao Maxbot;
- add_contact_segmentation Adiciona Segmentação ao Contato Maxbot;
- get_status Retorna a situação atual da API Maxbot;
- get_segmentation Retorna a lista de segmentações da conta;
- get_template_category Retorna a lista de categorias de templates;
- get_template Retorna a lista de templates da conta;
- get_service_sector Retorna a lista de setores de atendimento da conta;
- get_attendant Retorna a lista de atendentes da conta;
- get_cfx_type Retorna a lista de tipos de processos do controle de fluxo da conta;
- get_cfx_stage Retorna a lista de etapas do tipo de processo indicado do controle de fluxo da conta;
- get_cfx_process_list Retorna a lista de processos do controle de fluxo da conta;
- get_cfx_process Retorna os dados do processo indicado do controle de fluxo da conta;
- get_contact Retorna os dados da ficha cadastral dos contatos dentro do período indicado;
- get_prot Retorna os dados dos protocolos concluídos, juntamente com todo o diálogo trocado, dentro do período indicado;
- get_channel Requisita dados dos canais;
- get_protocol_annotation Requisita listagem de anotações do protocolo;
- get_account_instagram Requisita dados das contas do Instagram;
- get_page_facebook Requisita dados das páginas do Facebook;
- get_balance_gupshup Requisita saldo Gupshup;
- get_menu_calls Requisita quantidade de chamadas de menu por período;
- put_cfx_process Registra ou atualiza os dados da ficha cadastral do processo do controle de fluxo;
- set_cfx_process Atualiza dados da ficha cadastral do processo do controle de fluxo;
- put_contact Registra os dados da ficha cadastral do contato;
- set_contact Atualiza dados da ficha cadastral do contato;
- delete_contact Deleta registro do contato no maxbot;
- open_followup Abre um protocolo de atendimento para um contato;
- terminate_prot Encerrar protocolo;
- get_charge_list Retorna a lista de cobranças;
- get_charge Retorna os dados da cobrança;
- insert_charge Adicionar Cobrança;
- update_charge Atualizar Cobrança;
- delete_charge Deletar Cobrança;
- send_notice Disparo de template de aviso;
- send_chat_msg Dispara mensagem no protocolo em atendimento no chat;
- send_chat_audio Dispara áudio no protocolo em atendimento no chat;
- send_chat_annex Dispara anexos no protocolo em atendimento no chat;
- send_text Dispara uma mensagem de texto;
- send_sms Dispara uma mensagem de texto para sms;
- send_email Dispara para email;
- send_image Dispara uma imagem no formato jpg, jpeg ou png;
- send_file Dispara um documento no formato pdf, doc, docx, xls, xlsx, ppt ou pptx;
- send_sound Dispara um áudio no formato mp3;
Exemplos de Uso
add_contact_segmentation Requisição de inclusão de uma nova segmentação no Contato Maxbot
Utilize a requisição de inclusão de uma nova segmentação no Contato Maxbot, para adcionar uma segmentação ao Contato Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "add_contact_segmentation",
"segmentation_ids": "113, 211",
"contact_id": "1155",
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: add_contact_segmentation
- segmentation_ids - ID da segmentação
- Obs.: Para adicionar múltiplas segmentações, faça o uso da vírgula ao final de cada segmentação;
- EX: "113, 211";
- Obs.: Para adicionar múltiplas segmentações, faça o uso da vírgula ao final de cada segmentação;
- contact_id - ID do Contato Maxbot
Retorno:
{
"status": 1,
"msg": "Success",
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'add_contact_segmentation';
$_SEGMENTATION_ID = '123';
$_ID_CONTACT = '1155';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " segmentation_ids => ".$_SEGMENTATION_ID."<br/>";
$_TXT .= " contact_id => ".$_ID_CONTACT."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"segmentation_ids" => "$_SEGMENTATION_ID",
"contact_id" => "$_ID_CONTACT",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
add_segmentation Requisita criação de Segmentação no Maxbot
Utilize a requisição de criação de Segmentação no Maxbot, para criar uma nova Segmentação no maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "add_segmentation",
"segmentation_name": "Texto Segmentação, Texto Segmentação 2",
"type": "0",
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: add_segmentation
- segmentation_name - Nome da Segmentação
- Obs.: Para adicionar múltiplas segmentações, faça o uso da vírgula ao final de cada segmentação;
- EX: "Texto Segmentação, Texto Segmentação 2";
- Obs.: Para adicionar múltiplas segmentações, faça o uso da vírgula ao final de cada segmentação;
- type - Tipo da Segmentação
- Obs.: 0 - Segmentar Contato, 1 - Segmentar Protocolo;
Retorno:
{
"status": 1,
"msg": "Success",
"seg_id": "1",
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- seg_id - Retorno do id da Segmentação criada;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'add_segmentation';
$_SEGMENTATION_NAME = 'teste segmentação';
$_TYPE = '0';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " segmentation_name => ".$_SEGMENTATION_NAME."<br/>";
$_TXT .= " type => ".$_TYPE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"segmentation_name" => "$_SEGMENTATION_NAME",
"type" => "$_TYPE",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_status Requisita a situação atual da API Maxbot
Utilize a requisição de situação para verificar a situação atual da API Maxbot para verificação e monitoramento da condição atual da API.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_status"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_status
Retorno:
{
"status": 1,
"msg": "Success",
"data":[{
"created_at": "2020-08-22",
"status": "Active",
"last_execution_at": "2020-08-29 21:21:32",
"last_operation": "Sound Shooting"
}]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- created_at - Data de criação da API;
- status - Situação da API;
- last_execution_at - Data da última execução;
- last_operation - Última operação executada pela API;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_status';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_segmentation Requisita listagem de segmentações da conta Maxbot
Utilize a requisição de listagem de segmentações para importar a relação de segmentações cadastradas na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_segmentation"
"type": "0"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_segmentation
- type - Filtrar pelo Tipo da segmentação (0-Contato, 1-Protocolo).
- Obs.: Segmentações devem ser incluidas no Maxbot em Atendimento/Segmentação;
Retorno:
{
"status": 1,
"msg": "Success",
"segmentation": [
{
"id": 1452,
"type": "0",
"title": "Negocia\u00e7\u00e3o"
},
{
"id": 2267,
"type": "0",
"title": "Proposta Enviada"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- segmentation - Lista de Segmentação;
- id - ID da segmentação;
- type - Tipo da segmentação (0-Contato, 1-Protocolo);
- title - Título da segmentação;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_segmentation';
$_TYPE = '0';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " type => ".$_TYPE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"type" => "$_TYPE"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_template_category Lista de categorias de templates
Utilize a requisição de listagem de categorias de templates para importar a relação das categorias cadastradas na conta Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_template_category"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_template_category
Retorno:
{
"status": 1,
"msg": "Success",
"template_categories": [
{
"category_id": 0,
"category_title": "Geral"
},
{
"category_id": 2,
"category_title": "DETALHES DE PLANO"
},
{
"category_id": 1,
"category_title": "INFORMA\u00c7\u00d5ES"
},
{
"category_id": 3,
"category_title": "NEGOCIA\u00c7\u00c3O"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- template_categories - Lista de categorias de templates;
- category_id - ID da categoria;
- category_title - Título da categoria;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_template_category';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN"
"cmd" => "$_CMD",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_template Requisita listagem dos templates da conta Maxbot
Utilize a requisição de listagem de templates para importar a relação de templates cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_template"
"type": ""
"category_id": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_template
- type - Filtrar pelo Tipo do template (C - chat, F - followup, A - aviso, O - autenticação).
- category_id - Filtrar pela Categoria do template.
- Obs.: Templates devem ser incluidos no Maxbot em Atendimento/Template;
Retorno:
{
"status": 1,
"msg": "Success",
"template": [
{
"id": 1,
"type": "C",
"category_id": "0",
"category_title": "Geral",
"title": "Negocia\u00e7\u00e3o",
"msg": "Ol\u00e1, [NOME], tudo bem? \ud83d\ude03\ud83d\ude03",
"img1": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd35291043c5.png",
"img2": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529344422.png",
"img3": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529108457.png",
"img4": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529106535.png",
"img5": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529105753.png",
"img6": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529105473.png",
"arq1": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529145665.pdf",
"arq2": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529145656.pdf",
"arq3": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529149986.pdf",
"waba_category": "",
"waba_language": "",
"waba_status": "",
"for_use": 0
},
{
"id": 2,
"type": "F",
"category_id": "0",
"category_title": "Geral",
"title": "Abertura de Protocolo",
"msg": "Bom dia.",
"img1": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd35291043c5.png",
"img2": "",
"img3": "",
"img4": "",
"img5": "",
"img6": "",
"arq1": "https://app.maxbot.com.br/anexos_docs/534404093e4ff33534bffd3529145665.pdf",
"arq2": "",
"arq3": "",
"waba_category": "",
"waba_language": "",
"waba_status": "",
"for_use": 1
},
{
"id": 3,
"type": "A",
"category_id": "0",
"category_title": "Geral",
"title": "Aviso de Postado nos Correios",
"msg": "",
"img1": "",
"img2": "",
"img3": "",
"img4": "",
"img5": "",
"img6": "",
"arq1": "",
"arq2": "",
"arq3": "",
"waba_category": "",
"waba_language": "",
"waba_status": "",
"for_use": 1
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- template - Lista de templates;
- id - ID do template;
- type - Tipo do template;
- C - chat - Templates utilizados apenas no chat de atendimento;
- F - followup - Templates utilizados apenas para abertura de protocolos de followup;
- A - aviso - Templates utilizados apenas para disparo de avisos (avisos não abrem protocolos, apenas disparam a mensagem do template. Avisos são disparados apenas para contatos com o WhatsApp validado, constando com o indicador verde no número do WhatsApp. Este controle é para diminuir riscos de bloqueio do WhatsApp.);
- Obs.: Avisos não abrem protocolos, apenas disparam a mensagem do template. Avisos são disparados apenas para contatos com o número de WhatsApp validado. Números de WhatsApp validados constam na relação de contatos com o indicador verde no número do WhatsApp. Um número de WhatsApp é validado quando o contato dispara a primeira mensagem dele para o número configurado no Maxbot. Este controle é para diminuir riscos de bloqueio do número de WhatsApp;
- O - autenticação - Os templates de autenticação permitem que você autentique usuários com senhas únicas, possivelmente em várias etapas do processo de login (por exemplo, verificação de conta, recuperação de conta, desafios de integridade).;
- title - Título do template;
- msg - Texto do template;
- img1 - Foto 1 do template;
- img2 - Foto 2 do template;
- img3 - Foto 3 do template;
- img4 - Foto 4 do template;
- img5 - Foto 5 do template;
- img6 - Foto 6 do template;
- arq1 - Arquivo 1 do template;
- arq2 - Arquivo 2 do template;
- arq3 - Arquivo 3 do template;
- waba_category - Categoria WABA: Categoria padrão cadastrada na API Oficial do WhatsApp;
- waba_language - Idioma do template WABA;
- waba_status - Status do template WABA;
- Obs.: Só serão listados templates WABA com waba_status igual Aprovado (Apenas para Clientes WABA);
- for_use - Indica se o template está liberado para uso (1 - Liberado para uso, 0 - Não liberado para uso);
- Obs.: Templates não liberados para uso não serão disparados pelo Maxbot;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_template';
$_TYPE = '';
$_CATEGORY_ID = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " type => ".$_TYPE."<br/>";
$_TXT .= " category_id => ".$_CATEGORY_ID."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD"
"type" => "$_TYPE"
"category_id" => "$_CATEGORY_ID"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_service_sector Requisita listagem dos setores de atendimento da conta Maxbot
Utilize a requisição de listagem de setores de atendimento para importar a relação de setores de atendimento cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_service_sector"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_service_sector
- Obs.: Setores de Atendimento devem ser incluidos no Maxbot em Administrativo/Setor de Atendimento;
Retorno:
{
"status": 1,
"msg": "Success",
"service_sector": [
{
"id": 1,
"code": "CO",
"name": "Comercial",
"responsible_name": "Rodrigo Gomide",
"responsible_email": "rodrigo@email.com",
"responsible_whatsapp": "553111116666",
"responsible_mobile_phone": "553111116666",
"responsible_phone_extension": "5454",
"operation_monday_answer": 1,
"operation_monday_shift1": "08:00-12:00",
"operation_monday_shift2": "13:00-18:00",
"operation_tuesday_answer": 1,
"operation_tuesday_shift1": "08:00-12:00",
"operation_tuesday_shift2": "13:00-18:00",
"operation_wednesday_answer": 1,
"operation_wednesday_shift1": "08:00-12:00",
"operation_wednesday_shift2": "13:00-18:00",
"operation_thursday_answer": 1,
"operation_thursday_shift1": "08:00-12:00",
"operation_thursday_shift2": "13:00-18:00",
"operation_friday_answer": 1,
"operation_friday_shift1": "08:00-12:00",
"operation_friday_shift2": "13:00-18:00",
"operation_saturday_answer": 1,
"operation_saturday_shift1": "08:00-12:00",
"operation_saturday_shift2": "13:00-18:00",
"operation_sunday_answer": 1,
"operation_sunday_shift1": "08:00-12:00",
"operation_sunday_shift2": "13:00-18:00",
"allow_service_with_unavailable_attendants": 0
},
{
"id": 2,
"code": "LO",
"name": "Log\u00edstica",
"responsible_name": "Romulo Balga",
"responsible_email": "romulo@email.com",
"responsible_whatsapp": "553122226666",
"responsible_mobile_phone": "553122226666",
"responsible_phone_extension": "5451",
"operation_monday_answer": 1,
"operation_monday_shift1": "08:00-12:00",
"operation_monday_shift2": "13:00-18:00",
"operation_tuesday_answer": 1,
"operation_tuesday_shift1": "08:00-12:00",
"operation_tuesday_shift2": "13:00-18:00",
"operation_wednesday_answer": 1,
"operation_wednesday_shift1": "08:00-12:00",
"operation_wednesday_shift2": "13:00-18:00",
"operation_thursday_answer": 1,
"operation_thursday_shift1": "08:00-12:00",
"operation_thursday_shift2": "13:00-18:00",
"operation_friday_answer": 1,
"operation_friday_shift1": "08:00-12:00",
"operation_friday_shift2": "13:00-18:00",
"operation_saturday_answer": 1,
"operation_saturday_shift1": "08:00-12:00",
"operation_saturday_shift2": "13:00-18:00",
"operation_sunday_answer": 1,
"operation_sunday_shift1": "08:00-12:00",
"operation_sunday_shift2": "13:00-18:00",
"allow_service_with_unavailable_attendants": 1
},
{
"id": 2,
"code": "MA",
"name": "Manuten\u00e7\u00e3o",
"responsible_name": "Dilson Lana",
"responsible_email": "dilson@email.com",
"responsible_whatsapp": "553122227766",
"responsible_mobile_phone": "",
"responsible_phone_extension": "5400",
"operation_monday_answer": 2,
"operation_monday_shift1": "08:00-12:00",
"operation_monday_shift2": "13:00-18:00",
"operation_tuesday_answer": 2,
"operation_tuesday_shift1": "08:00-12:00",
"operation_tuesday_shift2": "13:00-18:00",
"operation_wednesday_answer": 2,
"operation_wednesday_shift1": "08:00-12:00",
"operation_wednesday_shift2": "13:00-18:00",
"operation_thursday_answer": 2,
"operation_thursday_shift1": "08:00-12:00",
"operation_thursday_shift2": "13:00-18:00",
"operation_friday_answer": 2,
"operation_friday_shift1": "08:00-12:00",
"operation_friday_shift2": "13:00-18:00",
"operation_saturday_answer": 2,
"operation_saturday_shift1": "08:00-12:00",
"operation_saturday_shift2": "13:00-18:00",
"operation_sunday_answer": 0,
"operation_sunday_shift1": "08:00-12:00",
"operation_sunday_shift2": "13:00-18:00",
"allow_service_with_unavailable_attendants": 1
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- service_sector - Lista de setores de atendimento;
- id - ID do setor;
- code - Código do setor;
- name - Nome do setor;
- responsible_name - Nome do responsável pelo setor;
- responsible_email - Email do responsável pelo setor;
- responsible_whatsapp - Número do whatsapp do responsável pelo setor;
- responsible_mobile_phone - Número do celular do responsável pelo setor;
- responsible_phone_extension - Número do ramal do responsável pelo setor;
- operation_monday_answer - Se há atendimento nas segundas-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_monday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_monday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_tuesday_answer - Se há atendimento nas terças-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_tuesday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_tuesday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_wednesday_answer - Se há atendimento nas quartas-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_wednesday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_wednesday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_thursday_answer - Se há atendimento nas quintas-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_thursday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_thursday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_friday_answer - Se há atendimento nas sextas-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_friday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_friday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_saturday_answer - Se há atendimento nos sábados (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_saturday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_saturday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- operation_monday_answer - Se há atendimento nos domingos (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas);
- operation_monday_shift1 - Horário do 1º turno (Hora:Minuto-Hora:Minuto);
- operation_monday_shift2 - Horário do 2º turno (Hora:Minuto-Hora:Minuto);
- allow_service_with_unavailable_attendants - Se permite atendimento quando não houver nenhum atendente on-line (0 - Não, 1 - Sim);
- Obs.: Se o atendimento para o dia da semana estiver configurado para 24 horas, os horários dos turnos serão ignorados.
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_service_sector';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_attendant Requisita listagem dos atendentes da conta Maxbot
Utilize a requisição de listagem de atendentes para importar a relação de atendentes cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_attendant"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_attendant
- Obs.: Atendentes devem ser incluidos no Maxbot em Administrativo/Atendente de Setor;
Retorno:
{
"status": 1,
"msg": "Success",
"attendant": [
{
"id": 1,
"service_sector_id": [1],
"collaborator_id": 1,
"name": "Pedro Silva",
"status": 1
},
{
"id": 2,
"service_sector_id": [2,3],
"collaborator_id": 2,
"name": "Jos\u00e9 Nogueira",
"status": 0
},
{
"id": 3,
"service_sector_id": [1,3,8,29],
"collaborator_id": 3,
"name": "Ant\u00f4nio Prado",
"status": 1
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- get_attendant - Lista de atendentes;
- id - ID do atendente;
- service_sector_id - Lista de IDs dos setores de atendimento aos quais o atendente está associado;
- collaborator_id - ID do colaborador amarrado no registro de atendente;
- name - Nome do atendente;
- status - Situação do atendente (0 - Inativo, 1 - Ativo);
- Obs.: Apenas atendentes ativos conseguem acessar o chat de atendimento do Maxbot.
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_attendant';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_cfx_type Requisita listagem de tipos de processos da conta Maxbot
Utilize a requisição de listagem de tipos de processos do controle de fluxo para importar a relação de tipos cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_cfx_type"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_cfx_type
- Obs. 1: Tipos de processos devem ser incluidos no Maxbot em Controle de Fluxo/Tipo;
- Obs. 2: Só serão listado Tipos de processos com status de Uso Liberado igual a Sim;
Retorno:
{
"status": 1,
"msg": "Success",
"cfx_type_list": [
{
"id": 1,
"title": "COMERCIAL",
"ind_display_value": 1
},
{
"id": 2,
"title": "SUPORTE T\u00c9CNICO N1",
"ind_display_value": 0
},
{
"id": 3,
"title": "IMPORTA\u00c7\u00c3O DE CONTATOS",
"ind_display_value": 1
},
"id": 4,
"title": "SEMANA DE ATENDIMENTO AO Cliente",
"ind_display_value": 0
{
"id": 5,
"title": "TESTE RODRIGO",
"ind_display_value": 0
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- cfx_type_list - Lista de tipos;
- id - ID do tipo;
- title - Título do tipo;
- ind_display_value - Indicador para exibir o valor no processo (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim o valor passa a ser uma informação obrigatória no processo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_cfx_type';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_cfx_stage Requisita listagem de etapas do processo da conta Maxbot
Utilize a requisição de listagem de etapas do processo do controle de fluxo para importar a relação de tipos cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_cfx_stage",
"cfx_type_id": "1"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_cfx_stage
- cfx_type_id - ID do Tipo para buscar suas etapas (Para pegar o cfx_type_id utilize a requisição: get_cfx_type)
- Obs. 1: Etapas do processo devem ser incluidas no Maxbot em Controle de Fluxo/Etapa;
- Obs. 2: Só serão listado Etapas do processo com status de Uso Liberado igual a Sim;
Retorno:
{
"status": 1,
"msg": "Success",
"cfx_stage_list": [
{
"id": 1,
"code": "C01",
"title": "PROSPECTO"
},
{
"id": 2,
"code":"C02",
"title": "LEVANTAMENTO DE DEMANDA"
},
{
"id": 3,
"code":"C03",
"title": "DEMONSTRA\u00c7\u00c3O"
},
{
"id": 4,
"code":"C04",
"title": "PER\u00cdODO DE TESTES"
},
{
"id": 5,
"code":"C05",
"title": "NEGOCIA\u00c7\u00c3O"
},
{
"id": 6,
"code":"C06",
"title": "CONTRATADO"
},
{
"id": 7,
"code":"C07",
"title": "PERDIDO"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- cfx_stage_list - Lista de etapas;
- id - ID da etapa;
- code - Código da etapa;
- title - Título da etapa;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_cfx_stage';
$_CFX_TYPE_ID = '1';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "cfx_type_id => ".$_CFX_TYPE_ID."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"cfx_type_id" => "$_CFX_TYPE_ID"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_cfx_process_list Requisita listagem de processos da conta Maxbot
Utilize a requisição de listagem de processos do controle de fluxo para importar a relação dos processos cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_cfx_process_list",
"date_start": "2021-10-01",
"date_stop": "2021-10-16",
"focus_of_period": "1",
"cfx_type_id": "",
"cfx_stage_id": "",
"number": "",
"prot_num": "",
"contact_id": "",
"collaborator_id": "",
"title": "",
"external_id_1": "",
"external_id_2": "",
"value": "",
"archived": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_cfx_process_list
- date_start - Data de início da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2021-10-01)
- date_stop - Data fim da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2021-10-16);
- focus_of_period - Indica qual a data que será usada para realização da busca dos registros (1-Data de Abertura, 2-Data de Entrega, 3-Data de Encerramento, 4-Data de Arquivo);
- cfx_type_id - Filtrar processos do Tipo de processo indicado (Para pegar o cfx_type_id utilize a requisição: get_cfx_type).
- cfx_stage_id - Filtrar processos da Etapa de processo indicada (Para pegar o cfx_stage_id utilize a requisição: get_cfx_stage)
- Obs.: Usando a busca dos processos com uma etapa, o Tipo de processo deverá ser informado a qual ela faz parte;
- number - Número do processo
- prot_num - Número do protocolo vinculado (Protocolo deve ter até 10 dígitos)
- contact_id - ID do contato
- collaborator_id - ID do colaborador responsável pelo processo. (Para pegar o collaborator_id utilize a requisição: get_attendant)
- title - Título do processo (Título deve ter até 255 caracteres )
- external_id_1 - ID Externo #1 vinculado (ID Externo #1 deve ter até 255 caracteres)
- external_id_2 - ID Externo #2 vinculado (ID Externo #2 deve ter até 255 caracteres)
- value - Valor financeiro relacionado ao processo (O valor deve ser informado do tipo decimal ex.: 100.00. E deve ter até 22 dígitos)
- archived - Arquivado (0-Não, 1-Sim).
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": 128,
"title": "INTERESSADO NO MAXBOT",
"cfx_type_id": 1,
"cfx_stage_id": 2,
"number": "96",
"code": "202110-959E-8C3B-6119",
"token": "202110538BEAA0EB43-7F934A-B06CFF",
"type": "COMERCIAL",
"stage_title": "DEMANDA",
"stage_actual_term_min": "15 Minutos",
"activity": "2",
"realized": "0%",
"name_contact": "EDUARDO GON\u00c7ALVES",
"name_resp": "EDUARDO GON\u00c7ALVES FILHO",
"prot_num": "1400",
"external_id_1": "126",
"external_id_2": "96",
"ind_display_value": 1,
"value": "407.00",
"date_last_evolution": "2021-10-16 09:54:12",
"opening_date": "2021-10-16 00:00:00",
"notes": "1",
"annex": "6",
"delivery_date": "2021-10-20 00:00:00",
"closing_date": "2021-11-01 00:00:00",
"archived": 0,
"archived_date": "0000-00-00 00:00:00"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- id - ID do processo;
- title - Título do processo;
- cfx_type_id - ID do tipo;
- cfx_stage_id - ID da etapa;
- number - Número do processo;
- code - Código do processo;
- token - Token do processo;
- type - Tipo do processo;
- stage_title - Título da etapa;
- stage_actual_term_min - Prazo;
- activity - Quantidade de atividades;
- realized - Realizado;
- name_contact - Nome do contato vinculado;
- name_resp - Nome do responsável vinculado;
- prot_num - Número do protocolo vinculado;
- external_id_1 - ID Externo #1 vinculado;
- external_id_2 - ID Externo #2 vinculado;
- ind_display_value - Indicador para exibir o valor no processo (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim o valor passa a ser uma informação obrigatória no processo;
- value - Valor financeiro relacionado ao processo;
- date_last_evolution - Data última evolução;
- opening_date - Data Abertura;
- notes - Quantidade de Anotações;
- annex - Quantidade de Anexos;
- delivery_date - Data Entrega;
- closing_date - Data Encerramento;
- archived - Arquivado (0-Não, 1-Sim);
- archived_date - Data Arquivado;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_cfx_process_list';
$_DATE_START = '2021-10-01';
$_DATE_STOP = '2021-10-16';
$_FOCUS_OF_PERIOD = '1';
$_CFX_TYPE_ID = '';
$_CFX_STAGE_ID = '';
$_NUMBER = '';
$_PROT_NUM = '';
$_CONTACT_ID = '';
$_COLLABORATOR_ID = '';
$_TITLE = '';
$_EXTERNAL_ID_1 = '';
$_EXTERNAL_ID_2 = '';
$_VALUE = '';
$_ARCHIVED = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " date_start => ".$_DATE_START."<br/>";
$_TXT .= " date_stop => ".$_DATE_STOP."<br/>";
$_TXT .= " focus_of_period => ".$_FOCUS_OF_PERIOD."<br/>";
$_TXT .= " cfx_type_id => ".$_CFX_TYPE_ID."<br/>";
$_TXT .= " cfx_stage_id => ".$_CFX_STAGE_ID."<br/>";
$_TXT .= " number => ".$_NUMBER."<br/>";
$_TXT .= " prot_num => ".$_PROT_NUM."<br/>";
$_TXT .= " contact_id => ".$_CONTACT_ID."<br/>";
$_TXT .= " collaborator_id => ".$_COLLABORATOR_ID."<br/>";
$_TXT .= " title => ".$_TITLE."<br/>";
$_TXT .= " external_id_1 => ".$_EXTERNAL_ID_1."<br/>";
$_TXT .= " external_id_2 => ".$_EXTERNAL_ID_2."<br/>";
$_TXT .= " value => ".$_VALUE."<br/>";
$_TXT .= " archived => ".$_ARCHIVED_IAQ."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"date_start" => "$_DATE_START",
"date_stop" => "$_DATE_STOP",
"focus_of_period" => "$_FOCUS_OF_PERIOD",
"cfx_type_id" => "$_CFX_TYPE_ID",
"cfx_stage_id" => "$_CFX_STAGE_ID",
"number" => "$_NUMBER",
"protocol" => "$_PROTOCOL",
"contact_id" => "$_CONTACT_ID",
"collaborator_id" => "$_COLLABORATOR_ID",
"title" => "$_TITLE",
"external_id_1" => "$_EXTERNAL_ID_1",
"external_id_2" => "$_EXTERNAL_ID_2",
"value" => "$_VALUE",
"archived" => "$_ARCHIVED_IAQ"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_cfx_process Requisita dados do processo indicado do controle de fluxo
Utilize a requisição de dados do processo para importar os dados do processo indicado do controle de fluxo da conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_cfx_process",
"for_process_id": "128"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_cfx_process
- for_process_id - Indica o ID do processo no Maxbot para consulta (ID pode ser obtido através do get_cfx_process_list, put_cfx_process ou set_cfx_process)
Retorno:
{
"status": 1,
"msg": "Success",
"process": [
{
"id": 128,
"number": "96",
"code": "202110-959E-8C3B-6119",
"type": "COMERCIAL",
"name_contact": "EDUARDO GON\u00c7ALVES",
"name_resp": "EDUARDO GON\u00c7ALVES FILHO",
"title": "INTERESSADO NO MAXBOT",
"prot_num": "1400",
"external_id_1": "126",
"external_id_2": "96",
"description": "Descri\u00e7\u00e3o",
"ind_display_value": 0,
"value": "407.00",
"delivery_date": "2021-10-20 00:00:00",
"closing_date": "2021-11-01 00:00:00",
"opening_date": "2021-10-16 00:00:00",
"archived": 0,
"archived_date": "0000-00-00 00:00:00",
"obs": "Observa\u00e7\u00e3o",
"last_update_user": "eduardoatendente",
"last_update_date": "2021-10-16 09:54:12"
}
],
"notes": [
{
"note_date": "16\/10\/21 09h50",
"note_resp": "EDUARDO GON\u00c7ALVES FILHO",
"note_text": "Marcado demostra\u00e7\u00e3o para Cliente dia 18\/10\/2021."
}
],
"annexes": [
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 1",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/bc4b65e1e3b4805a28ec837f22b159f2.jpg",
"annex_info": "bc4b65e1e3b4805a28ec837f22b159f2.jpg",
"annex_size": "1.28M"
},
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 2",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/d977a35386915f754cce9c805ff63cbf.jpg",
"annex_info": "d977a35386915f754cce9c805ff63cbf.jpg",
"annex_size": "2.83M"
},
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 3",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/34d4d9d9705aa01713841b949724da02.jpg",
"annex_info": "34d4d9d9705aa01713841b949724da02.jpg",
"annex_size": "1.34M"
},
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 4",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/6bb3b947e93d70532b9ae237be8b27bd.jpg",
"annex_info": "6bb3b947e93d70532b9ae237be8b27bd.jpg",
"annex_size": "2.59M"
},
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 5",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/25c2c6fb5593c6a992b3b4b9697e99d4.jpg",
"annex_info": "25c2c6fb5593c6a992b3b4b9697e99d4.jpg",
"annex_size": "2.93M"
},
{
"annex_date": "16\/10\/21 09h53",
"annex_resp": "EDUARDO GON\u00c7ALVES FILHO",
"annex_title": "TESTE ARQUIVO 6",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/491e82c1420052a6be2ff9dda13dc0e5.jpg",
"annex_info": "491e82c1420052a6be2ff9dda13dc0e5.jpg",
"annex_size": "2.75M"
}
],
"stages": [
{
"stage_id": 1,
"stage_current": 0,
"stage_code": "C01",
"stage_title": "PROSPECTO",
"activity": [
{
"activity_id": 1,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Completar ficha cadastral",
"activity_descr": "Completar a ficha do contato.",
"activity_term": "5 Minutos",
"activity_exe": "16\/10\/2021 09:50",
"activity_exe_resp": "Eduardo Gon\u00e7alves Filho",
"activity_exe_obs_pub": "Observa\u00e7\u00e3o p\u00fablica da execu\u00e7\u00e3o da atividade. A informa\u00e7\u00e3o \u00e9 mostrada para todos.",
"activity_exe_obs_int": "Observa\u00e7\u00e3o interna da execu\u00e7\u00e3o da atividade. A informa\u00e7\u00e3o \u00e9 mostrada apenas para a equipe interna da empresa."
}
]
},
{
"stage_id": 2,
"stage_current": 1,
"stage_code": "C02",
"stage_title": "DEMANDA",
"activity": [
{
"activity_id": 2,
"activity_current": 1,
"activity_code": "E1",
"activity_title": "Determinar a \u00e1rea de atua\u00e7\u00e3o",
"activity_descr": "Descobrir qual a \u00e1rea de atua\u00e7\u00e3o do Cliente.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 3,
"activity_current": 1,
"activity_code": "E2",
"activity_title": "Levantar limites de conta (CT, AT, CB adicional)",
"activity_descr": "Perguntar a qtde de contatos, atendentes para a conta.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
},
{
"stage_id": 3,
"stage_current": 0,
"stage_code": "C03",
"stage_title": "DEMONSTRA\u00c7\u00c3O",
"activity": [
{
"activity_id": 4,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Apresentar Maxbot com foco no neg\u00f3cio do Cliente",
"activity_descr": "Apresentar a plataforma focada no neg\u00f3cio do Cliente.",
"activity_term": "40 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 5,
"activity_current": 0,
"activity_code": "E2",
"activity_title": "Iniciar per\u00edodo de teste gratu\u00edto de 3 dias",
"activity_descr": "Criar o cadastro do Cliente, orientando a criar um username comercial para a empresa. Ajudar na configura\u00e7\u00e3o inicial para que ele comece o per\u00edodo de teste.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
},
{
"stage_id": 4,
"stage_current": 0,
"stage_code": "C04",
"stage_title": "PER\u00cdODO DE TESTES",
"activity": [
{
"activity_id": 6,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Configura\u00e7\u00e3o inicial",
"activity_descr": "Ajudar na configura\u00e7\u00e3o inicial para que ele comece os testes.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 7,
"activity_current": 0,
"activity_code": "E2",
"activity_title": "Entrar em contato no dia 2",
"activity_descr": "Entrar em contato para ver se est\u00e1 tudo ok e se os testes est\u00e3o caminhando bem.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 8,
"activity_current": 0,
"activity_code": "E3",
"activity_title": "Entrar em contato no dia 3",
"activity_descr": "Entrar em contato para ver se est\u00e1 tudo ok. Come\u00e7ar a levantar a demanda final do Cliente para or\u00e7amento da solu\u00e7\u00e3o.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
},
{
"stage_id": 5,
"stage_current": 0,
"stage_code": "C05",
"stage_title": "NEGOCIA\u00c7\u00c3O",
"activity": [
{
"activity_id": 9,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Negocia\u00e7\u00e3o da licen\u00e7a",
"activity_descr": "Fechar com o Cliente a licen\u00e7a Maxbot com os limites, canais e m\u00f3dulos que ele necessita.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 10,
"activity_current": 0,
"activity_code": "E2",
"activity_title": "Tentar fechar anuidade",
"activity_descr": "Tentar fechar anuidade com o Cliente com pagamentos mensais.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 11,
"activity_current": 0,
"activity_code": "E3",
"activity_title": "Definir melhor dia de vencimento",
"activity_descr": "Definir com o Cliente o dia de vencimento que melhor se encaixa no financeiro dele.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 12,
"activity_current": 0,
"activity_code": "E4",
"activity_title": "Fechamento do neg\u00f3cio",
"activity_descr": "Fechar o neg\u00f3cio com o Cliente orientando ele at\u00e9 a gera\u00e7\u00e3o da contrata\u00e7\u00e3o.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
},
{
"stage_id": 6,
"stage_current": 0,
"stage_code": "C06",
"stage_title": "CONTRATADO",
"activity": [
{
"activity_id": 13,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Avisar no grupo a nova contratacao",
"activity_descr": "Jogar GIF animado no grupo e comemorar hehhe.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 14,
"activity_current": 0,
"activity_code": "E2",
"activity_title": "Avisar CS da nova contrata\u00e7\u00e3o",
"activity_descr": "Avisar o CS da nova contrata\u00e7\u00e3o.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 15,
"activity_current": 0,
"activity_code": "E3",
"activity_title": "Entrar em contato com o Cliente ap\u00f3s 30 dias",
"activity_descr": "CS deve entrar em contato com o Cliente ap\u00f3s o primeiro m\u00eas para levantamento da satisfa\u00e7\u00e3o e ader\u00eancia \u00e0 plataforma.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
},
{
"stage_id": 7,
"stage_current": 0,
"stage_code": "C07",
"stage_title": "PERDIDO",
"activity": [
{
"activity_id": 16,
"activity_current": 0,
"activity_code": "E1",
"activity_title": "Segmentar o contato como perdido",
"activity_descr": "Segmentar o contato como perdido para tratamento futuro.",
"activity_term": "5 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
},
{
"activity_id": 17,
"activity_current": 0,
"activity_code": "E2",
"activity_title": "Entrar em contato para 2a tentativa",
"activity_descr": "Entrar em contato 1 semana depois para nova tentativa de negocia\u00e7\u00e3o.",
"activity_term": "10 Minutos",
"activity_exe": "Pendente",
"activity_exe_resp": "",
"activity_exe_obs_pub": "",
"activity_exe_obs_int": ""
}
]
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- process - Retorno da requisição;
- id - ID do processo;
- number - Número do processo;
- code - Código do processo;
- type - Tipo do processo;
- name_contact - Nome do contato vinculado;
- name_resp - Nome do responsável vinculado;
- title - Título do processo;
- prot_num - Número do protocolo vinculado;
- external_id_1 - ID Externo #1 vinculado;
- external_id_2 - ID Externo #2 vinculado;
- description - Descrição do processo;
- ind_display_value - Indicador para exibir o valor no processo (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim o valor passa a ser uma informação obrigatória no processo;
- value - Valor financeiro relacionado ao processo;
- opening_date - Data Abertura;
- delivery_date - Data Entrega;
- closing_date - Data Encerramento;
- obs - Observação do processo;
- last_update_user - Username do usuário que fez a última atualização do processo;
- last_update_date - Data da última atualização do processo;
- notes - Anotações do processo;
- note_date - Data da anotação;
- note_resp - Nome do responsável pela anotação;
- note_text - Texto da anotação;
- annexes - Anexos do processo;
- annex_date - Data do anexo;
- annex_resp - Nome do responsável pelo anexo;
- annex_title - Título do anexo;
- annex_url - Url do anexo;
- annex_info - Informação do anexo;
- annex_size - Tamanho do anexo;
- stages - Etapas do processo;
- stage_id - ID da etapa;
- stage_current - Indicador de etapa atual (0- Não é a próxima etapa do processo, 1- É a próxima etapa do processo);
- stage_code - Título do anexo;
- stage_title - Url do anexo;
- activity - Atividades da etapa;
- activity_id - ID da atividade;
- activity_current - Indicador da atividade atual da etapa do processo (0- Não é a próxima atividade da etapa, 1- É a próxima atividade da etapa);
- activity_code - Código da atividade;
- activity_title - Título da atividade;
- activity_descr - Descrição da atividade;
- activity_term - Prazo da atividade;
- activity_exe - Execução da atividade;
- activity_exe_resp - Responsável pela execução da atividade;
- activity_exe_obs_pub - Observação pública da execução da atividade. A informação é mostrada para todos;
- activity_exe_obs_int - Observação interna da execução da atividade. A informação é mostrada apenas para a equipe interna da empresa;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_cfx_process';
$_FOR_PROCESS_ID = '128';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " for_process_id => ".$_FOR_PROCESS_ID."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"for_process_id" => "$_FOR_PROCESS_ID"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_contact Requisita dados dos contatos
Utilize a requisição de dados do contato para importar a ficha de cadastro do contato. Todos os dados existentes na ficha cadastral serão retornados. Desta forma, um sistema externo (RP, CRM, etc) poderá importar os contatos novos que entraram no atendimento, bem como obter os dados mais atuais de contatos já existentes.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_contact",
"focus_period": "0",
"date_start": "2020-08-01",
"date_stop": "2020-08-01",
"datetime_focus": "",
"datetime_start": "",
"datetime_stop": "",
"waba_session": "",
"messenger_session": "",
"instagram_session": "",
"validated_whatsapp": "",
"whatsapp": "5511999998888",
"channel_whatsapp": ""
"channel_telegram": ""
"channel_messenger": ""
"channel_instagram": ""
"mobile_phone": "5511999998888",
"email": "fulano@mail.com",
"external_id": "1234"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_contact
- focus_period - Indica qual a data que será usada para realização da busca dos registros (0-Data de Cadastro, 1-Data da Última Atualização. Se não indicar o focus_period, será considerada a data de cadastro como o foco padrão);
- date_start - Data de início da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2020-08-01)
- date_stop - Data fim da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2020-08-01)
- datetime_focus Indica o foco da consulta se será em cima da data de criação do registro ou em cima da data de atualização do registro. (1 - Filtra por data e hora de criação, 2 - Filtra por data e hora de atualização).
- datetime_start - Data e Hora de início da consulta no padrão AAAA-MM-DD HH:MM:SS (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos, Hora com 2 digitos, Minutos com 2 digitos, Segundos com 2 digitos. Ex.: 2020-08-01 08:00:00)
- datetime_stop - Data e Hora fim da consulta no padrão AAAA-MM-DD HH:MM:SS (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos, Hora com 2 digitos, Minutos com 2 digitos, Segundos com 2 digitos. Ex.: 2020-08-01 08:30:00)
- waba_session - Sessão WABA de 24 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 24 Horas estiver Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA).
- messenger_session - Sessão FACEBOOK MESSENGER de 168 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 168 Horas estiver Fechada! Só é possível o envio de templates de FACEBOOK MESSENGER. Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes de FACEBOOK MESSENGER).
- instagram_session - Sessão INSTAGRAM de 168 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 168 Horas estiver Fechada! Só é possível o envio de templates de INSTAGRAM. Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes de INSTAGRAM ).
- validated_whatsapp - WhatsApp Validado (0-Não, 1-Sim).
- Obs. 1: WhatsApp é validado quando o contato envia alguma mensagem para o Maxbot.
- Obs. 2: Mesmo retornando 1-Sim, isso não garante que seja um número de WhatsApp valido, se for um contato antigo ele pode ter alterado seu número no WhatsApp.
- whatsapp - Número do WhatsApp existente na ficha cadastral do contato.
- channel_whatsapp - Canal do Whatsapp.
- channel_telegram - Canal do Telegram.
- channel_messenger - Canal do Facebook Messenger.
- channel_instagram - Canal do Instagram.
- mobile_phone - Número do celular existente na ficha cadastral do contato.
- email - E-Mail existente na ficha cadastral do contato.
- external_id - ID Externo existente na ficha cadastral do contato.
- Obs. 1: Você pode informar a mesma data de início e fim para trazer os contatos do dia, ou informar uma data de início e outra data diferente para o fim para trazer os contatos dentro de um período;
- Obs. 2: Se você informar whatsapp ou mobile_phone ou email ou external_id, o informe do período (date_start e date_stop) fica opicional. Ou seja, você pode fazer uma consulta apenas informando o whatsapp, ou o email por exemplo. O Maxbot irá localizar o registro com base nos parâmetros informados.;
- Obs. 3: Para realizar busca pela data e hora, você deve informar datetime_start, datetime_stop e datetime_focus. A consulta pela data e hora só será realizada, se o campo date_start e date_stop estiver vazio. Se o date_start e date_stop estiverem indicados, o sistema irá ignorar o datetime_star, datetime_stop e datetime_focus;
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": "1",
"created_at": "2020-06-08 08:07:16",
"updated_at": "2020-06-08 08:07:16",
"segmentation": [],
"tag": "THER",
"tag2": "THER2",
"name": "Rodrigo",
"surname": "Funda\u00e7\u00e3o Ther",
"gender": "M",
"gender_info": "",
"birth": "1974-10-22",
"age": "46",
"br_person_type": "J",
"br_cpf": "11122233344",
"br_cnpj": "11222333000144",
"company": "Ther Sistemas Ltda",
"email": "rodrigo@maxbot.com.br",
"channel_whatsapp": "5531911111444",
"whatsapp": "5531911112222",
"channel_telegram": "",
"telegram_id": "",
"channel_fbmessenger": "",
"fbmessenger_id": "",
"channel_instagram": "",
"instagram_id": "",
"mobile_phone": "5531922223333",
"phone": "3132324455",
"country": "BR",
"state": "MG",
"city": "Vi\u00e7osa",
"profession": "",
"external_id": "5678",
"ind_client": "0",
"client_code": "",
"avatar_url": "",
"obs": "",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": "",
"waba_session": "",
"messenger_session": "",
"instagram_session": "",
"in_attendance": "0",
"current_protocol": "",
"current_attendant": ""
},
{
"id": "2",
"created_at": "2020-06-08 08:07:16",
"updated_at": "2020-06-08 08:07:16",
"segmentation": [],
"tag": "",
"tag2": "",
"name": "Dilson",
"surname": "Lana",
"gender": "M",
"gender_info": "",
"birth": "",
"age": "",
"br_person_type": "F",
"br_cpf": "",
"br_cnpj": "",
"company": "",
"email": "",
"channel_whatsapp": "5531911111333",
"whatsapp": "5531911114324",
"channel_telegram": "",
"telegram_id": "",
"channel_fbmessenger": "",
"fbmessenger_id": "",
"channel_instagram": "",
"instagram_id": "",
"mobile_phone": "5531922223333",
"phone": "",
"country": "BR",
"state": "SP",
"city": "Campinas",
"profession": "",
"external_id": "",
"telegram_id": "",
"fbmessenger_id": "",
"instagram_id": "",
"ind_client": "0",
"client_code": "",
"avatar_url": "",
"obs": "Cliente VIP",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": "",
"waba_session": "",
"messenger_session": "",
"instagram_session": "",
"in_attendance": "1",
"current_protocol": "2345",
"current_attendant": "Keli Marchi"
},
{
"id": "3",
"created_at": "2020-06-08 08:07:16",
"updated_at": "2020-06-08 08:07:16",
"segmentation": ["Negocia\u00e7\u00e3o", "Proposta Enviada"],
"tag": "Atd Romulo",
"tag2": "Atd Romulo2",
"name": "Keli",
"surname": "Marchi",
"gender": "F",
"gender_info": "",
"birth": "1990-06-15",
"age": "30",
"br_person_type": "F",
"br_cpf": "11122233300",
"br_cnpj": "",
"company": "",
"email": "keli@email.com",
"channel_whatsapp": "5531911111222",
"whatsapp": "5531911116666",
"channel_telegram": "",
"telegram_id": "",
"channel_fbmessenger": "",
"fbmessenger_id": "",
"channel_instagram": "",
"instagram_id": "",
"mobile_phone": "5531911116666",
"phone": "",
"country": "BR",
"state": "RJ",
"city": "Rio de Janeiro",
"profession": "Ci\u00eancias Cont\u00e1beis",
"external_id": "keli-09",
"telegram_id": "",
"fbmessenger_id": "",
"instagram_id": "",
"ind_client": "0",
"client_code": "",
"avatar_url": "https:\/\/maxbot.com.br\/anexos_docs\/f434cd6b295984e3a0c05d8d67ae173d_small.jpg",
"obs": "ENVIAR PROPOSTA COMERCIAL NA SEGUNDA",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": "",
"waba_session": "",
"messenger_session": "",
"instagram_session": "",
"in_attendance": "0",
"current_protocol": "",
"current_attendant": ""
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- id - ID do contato;
- created_at - Data de Cadastro;
- updated_at - Data da Última atualização;
- segmentation - Lista de Segmentação;
- tag - Tag de atendimento exibido na fila de espera do atendimento;
- tag2 - Tag de atendimento exibido na fila de espera do atendimento;
- name - Nome;
- surname - Sobrenome;
- gender - Sexo (M-Masculino, F-Feminino ou O-Outro);
- gender_info - Informação do Sexo O-Outro;
- birth - Data de Nascimento;
- age - Idade;
- br_person_type - Tipo de Pessoa do padrão brasileiro (F-Física ou J-Jurídica);
- br_cpf - Número do CPF do padrão brasileiro;
- br_cnpj - Número do CNPJ do padrão brasileiro;
- company - Razão Social da Empresa;
- email - Email do contato;
- channel_whatsapp - Canal Whatsapp do contato;
- whatsapp - Número do WhatsApp;
- channel_telegram - Canal Telegram do contato;
- telegram_id - ID Telegram do contato;
- channel_fbmessenger - Canal Facebook Messenger do contato;
- fbmessenger_id - ID Facebook Messenger do contato;
- channel_instagram - Canal Instagram do contato;
- instagram_id - ID Instagram do contato;
- mobile_phone - Número do Celular;
- phone - Número do Telefone Fixo;
- country - País (padrão ISO com sigla de 2 caracteres. Ex.: BR, US, PT, FR, etc);
- state - Nome do Estado;
- city - Nome da Cidade;
- profession - Nome da profissão indicada no cadastro;
- external_id - ID Externo para cruzamento com sistemas externos como RPs, CRMs ou softwares de gestão da empresa;
- ind_client - Indicador se o contato já é um Cliente da empresa (0-Não, 1-Sim);
- client_code - Código do Cliente usado no sistema interno da empresa;
- avatar_url - Link do avatar do contato;
- obs - Texto do campo de observação da ficha de cadastro do contato;
- Tags INFO - Os campos de [INFO1], [INFO2], [INFO3], [INFO4], [INFO5] e [INFO6] é utilizado para entrada de texto livre a ser utilizado no disparo de templates. Permite texto livre, incluíndo EMOJIS, até 1.000 caracteres;
- tag_info1 - Tag Info 1, [INFO1];
- tag_info2 - Tag Info 2, [INFO2];
- tag_info3 - Tag Info 3, [INFO3];
- tag_info4 - Tag Info 4, [INFO4];
- tag_info5 - Tag Info 5, [INFO5];
- tag_info6 - Tag Info 6, [INFO6];
- Obs.: As Tags devem ser cadastradas no contato e no template para serem substituídas no envio de template.
- waba_session - Sessão WABA de 24 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 24 Horas estiver Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA).
- messenger_session - Sessão FACEBOOK MESSENGER de 168 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 168 Horas estiver Fechada! Só é possível o envio de templates de FACEBOOK MESSENGER. Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes de FACEBOOK MESSENGER).
- instagram_session - Sessão INSTAGRAM de 168 Horas (0-Fechada, 1-Aberta).
- Obs.: Se a Sessão de 168 Horas estiver Fechada! Só é possível o envio de templates de INSTAGRAM. Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes de INSTAGRAM ).
- in_attendance - Indica se o contato está sendo atendido no momento (0-Não, 1-Sim);
- current_protocol - Número do protocolo em atendimento;
- current_attendant - Nome do atendente em atendimento;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_contact';
$_FOCUS_PERIOD = '0';
$_DATA_INI = '2020-01-01';
$_DATA_FIM = '2020-08-25';
$_WABA_SESSION = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "focus_period => ".$_FOCUS_PERIOD."<br/>";
$_TXT .= " date_start => ".$_DATA_INI."<br/>";
$_TXT .= " date_stop => ".$_DATA_FIM."<br/>";
$_TXT .= "waba_session => ".$_WABA_SESSION."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"date_start" => "$_DATA_INI",
"date_stop" => "$_DATA_FIM",
"waba_session" => "$_WABA_SESSION"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_prot Requisita dados dos protocolos
Utilize a requisição de dados do protocolo para importar os protocolos concluídos em um determinado período. Todos os dados existentes na ficha do protocolo serão retornados. Desta forma, um sistema externo (RP, CRM, etc) poderá importar os dados do atendimento. A requisição retorna todos os dados do protocolo, bem como todo o diálogo trocado pelo atendente com o contato. Obs.: Retorna dados apenas de protocolos concluídos!
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_prot",
"date_focus": "1",
"date_start": "2022-06-22",
"date_stop": "2022-06-22",
"sector_id": "",
"attendant_id": "",
"contact_id": "",
"situation": "2",
"br_cpf": "",
"br_cnpj": "",
"company_name": "",
"segmentation_contact": "",
"segmentation_protocol": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado:
- get_prot - Dados do Protocolo + Anotações + Diálogo
- get_prot_full - Dados do Protocolo + Dados da Ficha do Contato + Anotações + Diálogo
- ignore_period - Ignorar o envio do período, Informe 1 para que não precise fornecer na busca o date_focus, date_start e date_stop;
- date_focus - Indica qual a data que será usada para realização da busca dos registros (2-Data de Abertura do protocolo, 1-Data de Início do Atendimento, 0-Data de Conclusão do Atendimento. Se não indicar o date_focus, será considerada a Data de Conclusão do Atendimento como o foco padrão);
- date_start - Data de início da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2020-08-01);
- date_stop - Data fim da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2020-08-01);
- protocol_number_start - Número de protocolo inicial a partir do qual os registros serão filtrados;
- protocol_number_stop - Número de protocolo final a partir do qual os registros serão filtrados;
- Obs. 1: O período indicado será sobre a data de conclusão do protocolo;
- Obs. 2: Você pode informar a mesma data de início e fim para trazer os protocolos concluídos do dia, ou informar uma data de início e outra data diferente para o fim para trazer os protocolos concluídos dentro de um período;
- Obs. 3: Se você informar o número de protocolo inicial e final, o Maxbot trará os registros dentro do intervalo indicado. Ex.: Protocolos entre o 100 e o 150;
- sector_id - ID do setor de atendimento
- attendant_id - ID do atendente
- contact_id - ID do contato;
- situation - Situação do Protocolo (0-Aguardando Atendimento, 2-Em Atendimento, 3-Encerrado);
- br_cpf - Número do CPF do padrão brasileiro;
- br_cnpj - Número do CNPJ do padrão brasileiro;
- company - Razão Social da Empresa;
- segmentation_contact - Segmentação Contato;
- segmentation_protocol - Segmentação Protocolo;
- set_dialog_off - Desativar retorno do Diálogo do Protocolo (Obs.: Opcional). Ex.: 0 - Retorna Diálogo, 1 - Oculta Diálogo; (Obs. #2: Não informar set_dialog_off é o mesmo que indicar set_dialog_off=0)
- set_notes_off - Desativar retorno das Anotações do Protocolo (Obs.: Opcional). Ex.: 0 - Retorna Anotações, 1 - Oculta Anotações; (Obs. #2: Não informar set_notes_off é o mesmo que indicar set_notes_off=0)
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": "143",
"origin": "2",
"protocol_number": "143",
"segmentation": [
{
"id": "60",
"title": "SAC"
}
],
"service_sector": "Suporte T\u00e9cnico",
"attendant_name": "Rodrigo Gomide",
"contact_info": "553195551111",
"contact_name": "Roberto Fulano",
"contact_whatsapp": "553195551111",
"contact_email": "",
"contact_cpf": "",
"contact_cnpj": "",
"contact_company_name": "",
"situation": "3",
"created_date": "2020-08-31",
"started_date": "2020-08-31 14:33:39",
"concluded_date": "2020-08-31 14:37:52",
"duration": "00:00:04",
"obs": "Atendimento encerrado pelo atendente.",
"notes": [
{
"id": "11",
"date": "2020-08-31 14:36:47",
"attendant_name": "Rodrigo Gomide",
"note": "Cliente pede urg\u00eancia, pois precisa da internet para realizar uma live. Pedir urg\u00eancia \u00e0 equipe t\u00e9cnica."
},
{
"id": "10",
"date": "2020-08-31 14:34:25",
"attendant_name": "Rodrigo Gomide",
"note": "Cliente reclama que est\u00e1 sem acesso \u00e0 internet. Solicita suporte t\u00e9cnico para reestabelecimento do servi\u00e7o."
}
],
"dialog": [
{
"id": "769",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "reply",
"type": "T",
"sent_by": "Roberto Fulano",
"received_by": "Rodrigo Gomide",
"msg_id": "3EB03C160CBC1BC9B9D9",
"msg_text": "[Abertura de Protocolo #0000000143]\n\n[Orienta\u00e7\u00e3o]:\n\n1. Solicitar ao contato:\n- Nome\n- Sobrenome\n- Email\n\n2. Segmentar a ficha do contato como prospect\n3. Atualizar a ficha do contato com o ID Externo\n\nN\u00e3o esque\u00e7a de sorrir hehehe\n",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "770",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "sent",
"type": "T",
"sent_by": "Rodrigo Gomide",
"received_by": "Roberto Fulano",
"msg_id": "",
"msg_text": "Ol\u00e1 Roberto, meu nome \u00e9 Rodrigo, como posso ajudar?",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "771",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "reply",
"type": "T",
"sent_by": "Roberto Fulano",
"received_by": "Rodrigo Gomide",
"msg_id": "3EB0F5D5A370A2A28F76",
"msg_text": "Ol\u00e1, estou sem acesso \u00e0 internet. Preciso de suporte t\u00e9cnico.",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "772",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "sent",
"type": "T",
"sent_by": "Rodrigo Gomide",
"received_by": "Roberto Fulano",
"msg_id": "",
"msg_text": "Ok. Registrei a sua reclama\u00e7\u00e3o. Vou solicitar \u00e0 equipe t\u00e9cnica que veja o que est\u00e1 ocorrendo. Tempo de resolu\u00e7\u00e3o do problema \u00e9 de cerca de 2 horas. Posso ajudar em algo mais?",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "773",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "reply",
"type": "T",
"sent_by": "Roberto Fulano",
"received_by": "Rodrigo Gomide",
"msg_id": "3EB09B22C2C2BADE917F",
"msg_text": "Teria como resolver mais r\u00e1pido? Preciso da internet para fazer uma live pelo YouTube.",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "774",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "sent",
"type": "T",
"sent_by": "Rodrigo Gomide",
"received_by": "Roberto Fulano",
"msg_id": "",
"msg_text": "Vou pedir urg\u00eancia para a resolu\u00e7\u00e3o do seu caso. Posso ajudar em algo mais?",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "775",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "reply",
"type": "T",
"sent_by": "Roberto Fulano",
"received_by": "Rodrigo Gomide",
"msg_id": "3EB0A1C5728C56BBA05E",
"msg_text": "N\u00e3o, seria somente isso mesmo. Agrade\u00e7o.",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
},
{
"id": "776",
"date": "2020-08-31",
"internal_communication": "0",
"flux": "sent",
"type": "T",
"sent_by": "Rodrigo Gomide",
"received_by": "Roberto Fulano",
"msg_id": "",
"msg_text": "Perfeitamente. Chame sempre que precisar.",
"msg_sound": "",
"msg_image": "",
"msg_file": "",
"msg_video": "",
"msg_location_preview": "",
"msg_location_lat": "",
"msg_location_lng": "",
"msg_contact": [],
"quoted_msg_id": "",
"quoted_msg_text": "",
"quoted_msg_sound": "",
"quoted_msg_image": "",
"quoted_msg_file": "",
"quoted_msg_video": "",
"quoted_msg_location_preview": "",
"quoted_msg_location_lat": "",
"quoted_msg_location_lng": "",
"quoted_msg_contact": ""
}
]
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- id - ID do Protocolo;
- origin - Origem do contato (0-Chat Web, 1-MaxChat (App), 2-WhatsApp, 3-WhatsApp Oficial, 4-Telegram, 5-Facebook Messenger, 6-Instagram).
- protocol_number - Número do Protocolo;
- segmentation - Segmentações do protocolo;
- service_sector - Setor de Atendimento;
- attendant_name - Nome do Atendente;
- contact_info - Informação do Contato (Ex.: Número do WhatsApp, e-mail do Chat Web, Usuário do Telegram, Usuário Maxchat);
- contact_name - Nome do Contato;
- contact_whatsapp - Número de WhatApp do Contato;
- contact_email - Email do Contato;
- contact_cpf - CPF do Contato;
- contact_cnpj - CNPJ do Contato;
- contact_company_name - Razão Social do Contato;
- created_date - Data de Criação do Protocolo;
- started_date - Data de Início de Atendimento do Protocolo;
- concluded_date - Data de Concusão do Atendimento do Protocolo;
- duration - Duração do Atendimento em Horas (horasM:minutos:segundos);
- obs - Texto de Observação do Protocolo;
- notes - Anotações Feitas pelo Atendente;
- id - ID da Anotação;
- date - Data da Anotação;
- attendant_name - Nome do Atendente;
- note - Texto da Anotação;
- dialog - Diálogo entre o Atendente e o Contato;
- id - ID da Mensagem;
- date - Data da Mensagem;
- internal_communication - Indicador de Comunicação Interna (0-Não, 1-Sim). Obs.: O Maxbot permite que um atendente converse com outro atendente através de um chat de comunicação interna. Esse indicador mostra se o diálogo é uma comunicação interna ou um chat externo;
- flux - Fluxo da Mensagem (S-Enviado, R-Respondido);
- type - Tipo de Mensagem (T-Texto, S-Audio, I-Imagem, F-Documento, L-Localização);
- sent_by - Nome de Quem Enviou a Mensagem;
- received_by - Nome de Quem Recebeu a Mensagem;
- msg_id - ID da Mensagem;
- msg_text - Texto da Mensagem;
- msg_sound - URL do Áudio;
- msg_image - URL da Imagem;
- msg_file - URL do Documento;
- msg_video - URL do Vídeo;
- msg_location_preview - URL da Imagem de Preview;
- msg_location_lat - Latitude da Localização;
- msg_location_lng - Longitude da Localização;
- msg_contact - Contato Recebido, Dados do contato em array;
- quoted_msg_id - ID da Mensagem Comentada (Quando Disponível);
- quoted_msg_text - Texto da Mensagem Comentada (Quando Disponível);
- quoted_msg_sound - URL do Áudio da Mensagem Comentada (Quando Disponível);
- quoted_msg_image - URL da Imagem da Mensagem Comentada (Quando Disponível);
- quoted_msg_file - URL do Documento da Mensagem Comentada (Quando Disponível);
- quoted_msg_video - URL do Vídeo da Mensagem Comentada (Quando Disponível);
- quoted_msg_location_preview - URL da Imagem de Preview da Mensagem Comentada (Quando Disponível);
- quoted_msg_location_lat - Latitude da Mensagem Comentada (Quando Disponível);
- quoted_msg_location_lng - Longitude da Mensagem Comentada (Quando Disponível);
- quoted_msg_contact - Contato Recebido (Quando Disponível);
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_prot';
$_DATA_INI = '2020-08-31';
$_DATA_FIM = '2020-08-31';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "date_start => ".$_DATA_INI."<br/>";
$_TXT .= " date_stop => ".$_DATA_FIM."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"date_start" => "$_DATA_INI",
"date_stop" => "$_DATA_FIM"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_channel Requisita dados dos canais
Utilize a requisição de listagem de canais para importar a relação de canais cadastrados na conta Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_channel"
"channel": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_channel
- channel - Canal Maxbot (0- WhatsApp Web, 1- WhatsApp Oficial (WABA), 2-Telegram, 3- Facebook Messenger, 4- Instagram);
- Obs.: Caso o channel não for informado todos os canais maxbot cadastrados serão listados.
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"token": "202304B53BF66DB8C0-364F9B-15CBAD",
"title": "WhatsApp Web",
"info": [
"whatsapp": "553182096315"
]
},
{
"token": "2023047C66A1138D57-D7096D-DC39B4",
"title": "Telegram",
"info": [
"user": "usuario01_maxbot"
]
},
{
"token": "202304FE471FF7A477-5FA8BA-E72F90",
"title": "Facebook",
"info": [
"pages": "page1, page2, page3"
]
}
]
}
- token - Token Único;
- title - Titulo;
- info - Informações complementar;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_channel';
$_CHANNEL = '1';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel => ".$_CHANNEL."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel" => "$_CHANNEL",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_protocol_annotation Requisita listagem de anotações do protocolo
Utilize a requisição de listagem de anotações do protocolo para importar a relação de anotações cadastradas em um determinado protocolo.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_protocol_annotation"
"prot_id": "123"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_protocol_annotation
- prot_id - ID do Protocolo
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": "1",
"date": "2023-04-17 08:00:00",
"attendant_name": "Rodrigo Gomide",
"text": "Anotação 01",
},
{
"id": "2",
"date": "2023-04-17 09:00:00",
"attendant_name": "Dilson Lana",
"text": "Anotação 02",
},
{
"id": "3",
"date": "2023-04-17 10:00:00",
"attendant_name": "Romulo Balga",
"text": "Anotação 03",
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- id - ID Anotação do procolo;
- date - Data de registro de Anotação;
- attendant_name - Nome e Sobrenome do Atendente;
- text - Texto Anotação do protocolo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_protocol_annotation';
$_PROT_ID = '1234';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"prot_id" => "$_PROT_ID",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_account_instagram Requisita dados das contas do Instagram
Utilize a requisição de listagem de contas do Instagram para importar a relação de contas cadastradas na plataforma Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_account_instagram"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_account_instagram
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": "12345678901234542",
"title": "account_title_1"
},
{
"id": "09876543211234567",
"title": "account_title_2"
},
{
"id": "45678901234567897",
"title": "account_title_3"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- id - ID do instagram;
- title - Titulo do Instagram;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_account_instagram';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_page_facebook Requisita dados das páginas do Facebook
Utilize a requisição de listagem de páginas do Facebook para importar a relação de páginas cadastradas na conta Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_page_facebook"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_page_facebook
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"id": "283905712023100",
"title": "page_title_1"
},
{
"id": "567829013457896",
"title": "page_title_2"
},
{
"id": "874651089034901",
"title": "page_title_3"
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- id - ID da Página;
- title - Título da Página;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_page_facebook';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_balance_gupshup Requisita saldo Gupshup
Utilize a requisição de saldo Gupshup para obter o saldo da sua conta Gupshup.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "get_balance_gupshup"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_balance_gupshup
Retorno:
{
"status": 1,
"msg": "Success",
"currency_balance": "99.00 USD",
"balance": "99.00",
"currency": "USD",
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- currency_balance - Saldo e moeda Gupshup;
- balance - Saldo Gupshup;
- currency - Moeda Gupshup;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_balance_gupshup';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
put_cfx_process Requisita registro ou atualização da ficha do processo do controle de fluxo da conta Maxbot
Utilize a requisição de registro ou atualização da ficha do processo do controle de fluxo na conta Maxbot para criar novo processo em um tipo de fluxo específico ou para atualizar os dados do processo.
Requisição JSON:
{
"token": "xxxx",
"cmd": "put_cfx_process",
"contact_id": "792",
"collaborator_id": "126",
"cfx_type_id": "4",
"cfx_stage_id": "1",
"title": "MAXBOT SAC 2021",
"prot_num": "",
"external_id_1": "",
"external_id_2": "",
"ind_display_value": "0",
"value": "",
"description": "",
"opening_date": "2024-12-18",
"delivery_date": "2024-12-18",
"closing_date": "2024-12-18",
"obs": "SAC 2021 OBS",
"archived": "0",
"archived_date": "2024-12-18"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: put_cfx_process
- contact_id - ID do contato
- collaborator_id - ID do colaborador responsável pelo processo. (Para pegar o collaborator_id utilize a requisição: get_attendant)
- cfx_type_id - ID do tipo do processo (Para pegar o cfx_type_id utilize a requisição: get_cfx_type)
- cfx_stage_id - ID da etapa do processo (Para pegar o cfx_stage_id utilize a requisição: get_cfx_stage)
- title - Título do processo (Título deve ter até 255 caracteres )
- prot_num - Número do protocolo vinculado (Protocolo deve ter até 10 dígitos)
- external_id_1 - ID Externo #1 vinculado (ID Externo #1 deve ter até 255 caracteres)
- external_id_2 - ID Externo #2 vinculado (ID Externo #2 deve ter até 255 caracteres)
- ind_display_value - Indicador para exibir o valor no processo (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim o valor passa a ser uma informação obrigatória no processo. (Para pegar o ind_display_value utilize a requisição: get_cfx_type)
- value - Valor financeiro relacionado ao processo (O valor deve ser informado do tipo decimal ex.: 100.00. E deve ter até 22 dígitos)
- description - Descrição do processo (Descrição deve ter até 3000 caracteres )
- opening_date - Data Abertura no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- delivery_date - Data Entrega no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- closing_date - Data Encerramento no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- opening_date - Data Abertura no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- obs - Observação (Observação deve ter até 4000 caracteres )
- archived - Arquivado (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim a Data Arquivado passa a ser uma informação obrigatória no processo;
- archived_date - Data de arquivamento do processo no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18). Processos arquivados caem no arquivo morto e deixam de serem exibidos no kanban de controle.
- Obs.: Etapas do processo devem ser incluidas no Maxbot em Controle de Fluxo/Etapa;
Retorno:
{
"status": 1,
"msg": "Success",
"process_id": 111,
"process_num": "84"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- process_id - ID do processo;
- process_num - Código do processo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'put_cfx_process';
$_CONTACT_ID = '792';
$_COLLABORATOR_ID = '126';
$_CFX_TYPE_ID = '4';
$_CFX_STAGE_ID = '17';
$_TITLE = 'MAXBOT SAC 2021';
$_PROT_NUM = '1351';
$_EXTERNAL_ID_1 = '1';
$_EXTERNAL_ID_2 = '2';
$_IND_DISPLAY_VALUE = '1';
$_VALUE = '100.00';
$_DESCRIPTION = ' ';
$_OPENING_DATE = "2024-12-18";
$_DELIVERY_DATE = "2024-12-18";
$_CLOSING_DATE = "2024-12-18";
$_OBS = 'SAC 2021 OBS';
$_ARCHIVED = '1';
$_ARCHIVED_DATE = "2024-12-18";
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " contact_id => ".$_CONTACT_ID."<br/>";
$_TXT .= " collaborator_id => ".$_COLLABORATOR_ID."<br/>";
$_TXT .= " cfx_type_id => ".$_CFX_TYPE_ID."<br/>";
$_TXT .= " cfx_stage_id => ".$_CFX_STAGE_ID."<br/>";
$_TXT .= " title => ".$_TITLE."<br/>";
$_TXT .= " prot_num => ".$_PROT_NUM."<br/>";
$_TXT .= " external_id_1 => ".$_EXTERNAL_ID_1."<br/>";
$_TXT .= " external_id_2 => ".$_EXTERNAL_ID_2."<br/>";
$_TXT .= "ind_display_value => ".$_IND_DISPLAY_VALUE."<br/>";
$_TXT .= " value => ".$_VALUE."<br/>";
$_TXT .= " description => ".$_DESCRIPTION."<br/>";
$_TXT .= " opening_date => ".$_OPENING_DATE."<br/>";
$_TXT .= " delivery_date => ".$_DELIVERY_DATE."<br/>";
$_TXT .= " closing_date => ".$_CLOSING_DATE."<br/>";
$_TXT .= " obs => ".$_OBS."<br/>";
$_TXT .= " archived => ".$_ARCHIVED."<br/>";
$_TXT .= " archived_date => ".$_ARCHIVED_DATE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"contact_id" => "$_CONTACT_ID",
"collaborator_id" => "$_COLLABORATOR_ID",
"cfx_type_id" => "$_CFX_TYPE_ID",
"cfx_stage_id" => "$_CFX_STAGE_ID",
"title" => "$_TITLE",
"prot_num" => "$_PROT_NUM",
"external_id_1" => "$_EXTERNAL_ID_1",
"external_id_2" => "$_EXTERNAL_ID_2",
"ind_display_value" => "$_IND_DISPLAY_VALUE",
"value" => "$_VALUE",
"description" => "$_DESCRIPTION",
"opening_date" => "$_OPENING_DATE",
"delivery_date" => "$_DELIVERY_DATE",
"closing_date" => "$_CLOSING_DATE",
"obs" => "$_OBS",
"archived" => "$_ARCHIVED",
"archived_date" => "$_ARCHIVED_DATE"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
set_cfx_process Requisita atualização da ficha do processo do controle de fluxo da conta Maxbot
Utilize a requisição atualização da ficha do processo do controle de fluxo na conta Maxbot para atualizar os dados do processo.
Requisição JSON:
{
"token": "xxxx",
"cmd": "set_cfx_process",
"for_process_id": "111"
"contact_id": "792",
"collaborator_id": "126",
"cfx_type_id": "4",
"cfx_stage_id": "1",
"title": "MAXBOT SAC 2021",
"prot_num": "",
"external_id_1": "",
"external_id_2": "",
"ind_display_value": "0",
"value": "",
"description": "",
"opening_date": "2024-12-18",
"delivery_date": "2024-12-18",
"closing_date": "2024-12-18",
"obs": "SAC 2021 OBS",
"archived": "0",
"archived_date": "2024-12-18"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: set_cfx_process
- for_process_id - Indica o ID do processo no Maxbot para atualização (ID pode ser obtido através do get_cfx_process_list);
- contact_id - ID do contato
- collaborator_id - ID do colaborador responsável pelo processo. (Para pegar o collaborator_id utilize a requisição: get_attendant)
- cfx_type_id - ID do tipo do processo (Para pegar o cfx_type_id utilize a requisição: get_cfx_type)
- cfx_stage_id - ID da etapa do processo (Para pegar o cfx_stage_id utilize a requisição: get_cfx_stage)
- title - Título do processo (Título deve ter até 255 caracteres )
- prot_num - Número do protocolo vinculado (Protocolo deve ter até 10 dígitos)
- external_id_1 - ID Externo #1 vinculado (ID Externo #1 deve ter até 255 caracteres)
- external_id_2 - ID Externo #2 vinculado (ID Externo #2 deve ter até 255 caracteres)
- ind_display_value - Indicador para exibir o valor no processo (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim o valor passa a ser uma informação obrigatória no processo. (Para pegar o ind_display_value utilize a requisição: get_cfx_type)
- value - Valor financeiro relacionado ao processo (O valor deve ser informado do tipo decimal ex.: 100.00. E deve ter até 22 dígitos)
- description - Descrição do processo (Descrição deve ter até 3000 caracteres )
- opening_date - Data Abertura no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- delivery_date - Data Entrega no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- closing_date - Data Encerramento no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- opening_date - Data Abertura no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18)
- obs - Observação (Observação deve ter até 4000 caracteres )
- archived - Arquivado (0-Não, 1-Sim). Sempre que o indicador for informado como 1-Sim a Data Arquivado passa a ser uma informação obrigatória no processo;
- archived_date - Data de arquivamento do processo no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2024-12-18). Processos arquivados caem no arquivo morto e deixam de serem exibidos no kanban de controle.
Retorno:
{
"status": 1,
"msg": "Success",
"process_id": 111,
"process_num": "84"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- process_id - ID do processo;
- process_num - Código do processo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'set_cfx_process';
$_FOR_PROCESS_ID = '111';
$_CONTACT_ID = '792';
$_COLLABORATOR_ID = '126';
$_CFX_TYPE_ID = '4';
$_CFX_STAGE_ID = '17';
$_TITLE = 'MAXBOT SAC 2021';
$_PROT_NUM = '1351';
$_EXTERNAL_ID_1 = '1';
$_EXTERNAL_ID_2 = '2';
$_IND_DISPLAY_VALUE = '1';
$_VALUE = '100.00';
$_DESCRIPTION = ' ';
$_OPENING_DATE = "2024-12-18";
$_DELIVERY_DATE = "2024-12-18";
$_CLOSING_DATE = "2024-12-18";
$_OBS = 'SAC 2021 OBS';
$_ARCHIVED = '1';
$_ARCHIVED_DATE = "2024-12-18";
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " for_process_id => ".$_FOR_PROCESS_ID."<br/>";
$_TXT .= " contact_id => ".$_CONTACT_ID."<br/>";
$_TXT .= " collaborator_id => ".$_COLLABORATOR_ID."<br/>";
$_TXT .= " cfx_type_id => ".$_CFX_TYPE_ID."<br/>";
$_TXT .= " cfx_stage_id => ".$_CFX_STAGE_ID."<br/>";
$_TXT .= " title => ".$_TITLE."<br/>";
$_TXT .= " prot_num => ".$_PROT_NUM."<br/>";
$_TXT .= " external_id_1 => ".$_EXTERNAL_ID_1."<br/>";
$_TXT .= " external_id_2 => ".$_EXTERNAL_ID_2."<br/>";
$_TXT .= "ind_display_value => ".$_IND_DISPLAY_VALUE."<br/>";
$_TXT .= " value => ".$_VALUE."<br/>";
$_TXT .= " description => ".$_DESCRIPTION."<br/>";
$_TXT .= " opening_date => ".$_OPENING_DATE."<br/>";
$_TXT .= " delivery_date => ".$_DELIVERY_DATE."<br/>";
$_TXT .= " closing_date => ".$_CLOSING_DATE."<br/>";
$_TXT .= " obs => ".$_OBS."<br/>";
$_TXT .= " archived => ".$_ARCHIVED."<br/>";
$_TXT .= " archived_date => ".$_ARCHIVED_DATE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"for_process_id" => "$_FOR_PROCESS_ID",
"contact_id" => "$_CONTACT_ID",
"collaborator_id" => "$_COLLABORATOR_ID",
"cfx_type_id" => "$_CFX_TYPE_ID",
"cfx_stage_id" => "$_CFX_STAGE_ID",
"title" => "$_TITLE",
"prot_num" => "$_PROT_NUM",
"external_id_1" => "$_EXTERNAL_ID_1",
"external_id_2" => "$_EXTERNAL_ID_2",
"ind_display_value" => "$_IND_DISPLAY_VALUE",
"value" => "$_VALUE",
"description" => "$_DESCRIPTION",
"opening_date" => "$_OPENING_DATE",
"delivery_date" => "$_DELIVERY_DATE",
"closing_date" => "$_CLOSING_DATE",
"obs" => "$_OBS",
"archived" => "$_ARCHIVED",
"archived_date" => "$_ARCHIVED_DATE"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
put_protocol_annotation Inserir anotação do protocolo
Utilize a requisição de criação de anotação de um protocolo para criar um nova anotação do protocolo no Maxbot.
Requisição JSON:
{
"token": "xxxxxx",
"cmd": "put_protocol_annotation"
"prot_id": "123"
"anot_text": "example annotation"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: put_protocol_annotation
- prot_id - ID do Protocolo
- anot_text - Texto da Anotação
- Obs.: Anotação deve ter no maximo 5000 caracteres.
Retorno:
{
"status": 1,
"msg": "Success",
"prot_id": "1",
"anot_id": "1"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- prot_id - ID do Protocolo;
- anot_id - ID da Anotação;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'put_protocol_annotation';
$_PROT_ID = '1234';
$_ANOT_TEXT = 'example annotation';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID."<br/>";
$_TXT .= " anot_text => ".$_ANOT_TEXT."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"prot_id" => "$_PROT_ID",
"anot_text" => "$_ANOT_TEXT",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
put_contact Requisita criação de ficha de contato
Utilize a requisição de criação de ficha de contato para criar um novo contato no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "put_contact",
"segmentation": "Negocia\u00e7\u00e3o, Proposta Enviada",
"tag": "VIP",
"tag2": "VIP2",
"name": "Jose",
"surname": "Silva",
"gender": "M",
"gender_info": "M",
"birth": "1974-06-15",
"br_person_type": "J",
"br_cpf": "11122233300",
"br_cnpj": "00111222000133",
"company": "Empresa Minha Ltda",
"email": "jose@email.com",
"whatsapp_channel": "AAAAAAAAAAAAAAAAA-BBBBBB-CCCCCC",
"whatsapp": "5531911111122",
"telegram_channel": "",
"telegram_id": "",
"fbmessenger_channel": "",
"fbmessenger_origem_page_id": "",
"fbmessenger_id": "",
"instagram_channel": "",
"instagram_origem_business_account_id": "",
"instagram_id": "",
"mobile_phone": "5531911111122",
"phone": "553155551122",
"country": "BR",
"state": "MG",
"city": "Belo Horizonte",
"profession": "ESPORTE",
"external_id": "667811",
"ind_client": "0",
"client_code": "",
"avatar_url": "https:\/\/www.meusite.com.br\/foto.jpg",
"obs": "Enviar proposta comercial na segunda",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: put_contact
- segmentation - Informe o título das segmentações separadas por vírgula (ex.: prospecto,apresentação,orçamento). Caso não exista no Maxbot, a segmentação será criada;
- tag - Tag que é apresentado na fila de espera do atendimento;
- tag2 - Tag que é apresentado na fila de espera do atendimento;
- name - Nome do contato (até 45 caracteres);
- surname - Sobrenome do contato (até 45 caracteres);
- gender - Sexo (M-Masculino, F-Feminino ou O-Outro);
- gender_info - Informação do Sexo O-Outro;
- birth - Data de Nascimento no formato Ano-Mês-Dia (Ex.: 2020-09-10);
- br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- company - Razão Social da Empresa (até 180 caracteres);
- email - E-Mail do contato (até 45 caracteres);
- whatsapp_channel - Token do canal Whatsapp cadastrado no Maxbot;
Informe o token do canal do WhatsApp cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- Obs.: Caso a whatsapp_channel não for informado, será utilizado o primeiro canal cadastrado no maxbot.
- whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- telegram_channel - Token do canal Telegram cadastrado no Maxbot; Informe o token do canal do Telegram cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- telegram_id - ID Telegram do contato;
- fbmessenger_channel - Token do canal Facebook Messenger cadastrado no Maxbot; Informe o token do canal do Facebook Messenger cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- fbmessenger_origem_page_id - ID da página do Facebook Messenger. Pode ser obtido através do endpoint get_page_facebook;
- fbmessenger_id - ID Facebook Messenger do contato;
- instagram_channel - Token do canal Instagram cadastrado no Maxbot; Informe o token do canal do Instagram cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- instagram_origem_business_account_id - ID da Conta do Instagram. Pode ser obtido através do endpoint get_account_instagram;
- instagram_id - ID Instagram do contato;
- mobile_phone - Número do celular com código de país e DDD (Ex.: 5511988887777);
- phone - Número do telefone fixo com código de país e DDD (Ex.: 551144446666);
- country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, US-Estados Unidos, ES-Espanha, PT-Portugal);
- state - Código do estado (Para país BR (Brasil), o código deve ser correspondente ao código de um dos estados brasileiros. Ex.: MG-Minas Gerais, SP-São Paulo);
- city - Nome da cidade (Para país BR (Brasil), o nome da cidade deve ser igual ao nome indicado no padrão do IBGE (Instituto Brasileiro de Geografia e Estatística));
- profession - Nome da área profissional (Deve ser idêntico a uma das áreas profissionais existentes na ficha de cadastro do Maxbot);
- external_id - ID Externo do contato para cruzando de dados do Maxbot com outros sistemas (até 80 caracteres) (Ex.: um número de matrícula, um ID de registro de sistema, etc);
- ind_client - Indicador se o contato já é um Cliente da empresa (0-Não, 1-Sim);
- client_code - Código do Cliente usado no sistema interno da empresa;
- avatar_url - URL da imagem do avatar do contato em formato JPG;
- obs - Texto de observação para o registro do contato de até 255 caracteres;
- Tags INFO - Os campos de [INFO1], [INFO2], [INFO3], [INFO4], [INFO5] e [INFO6] é utilizado para entrada de texto livre a ser utilizado no disparo de templates. Permite texto livre, incluíndo EMOJIS, até 1.000 caracteres;
- tag_info1 - Tag Info 1, [INFO1];
- tag_info2 - Tag Info 2, [INFO2];
- tag_info3 - Tag Info 3, [INFO3];
- tag_info4 - Tag Info 4, [INFO4];
- tag_info5 - Tag Info 5, [INFO5];
- tag_info6 - Tag Info 6, [INFO6];
- Obs.: As Tags devem ser cadastradas no contato e no template para serem substituídas no envio de template.
- Atenção:
- A verificação de existência de registro é feita com base na existência dos campos: whatsapp, mobile_phone, email, br_cpf, telegram_id, fbmessenger_id, instagram_origem_business_account_id;
- Se o valor informado nestes campos for detectado, o Maxbot irá considerar a ficha como existente;
- Para atualização de ficha de contato, veja set_contact ;
Retorno:
{
"status": 1,
"msg": "Success",
"contact_id": 1234
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- contact_id - Retorna o ID do registro no Maxbot para atualizações posteriores;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'put_contact';
$_SEG_LIST = 'Negociação,Proposta Enviada';
$_TAG = 'VIP';
$_TAG2 = 'VIP2';
$_NOME = 'Jose';
$_SOBRENOME = 'Silva';
$_SEXO = 'M';
$_NASC = '1974-06-15';
$_PESSOA = 'J';
$_CPF = '87348769527';
$_CNPJ = '64420582000148';
$_EMPRESA = 'Empresa Minha Ltda';
$_EMAIL = 'jose@email.com';
$_WHATSAPP_CHANNEL = 'AAAAAAAAAAAAAAAAA-BBBBBB-CCCCCC';
$_WHATSAPP = '5531911111122';
$_TELEGRAM_CHANNEL = '';
$_TELEGRAM_ID = '';
$_FBMESSENGER_CHANNEL = '';
$_FBMESSENGER_ORIGEM_PAGE_ID = '';
$_FBMESSENGER_ID = '';
$_INSTAGRAM_CHANNEL = '';
$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID = '';
$_INSTAGRAM_ID = '';
$_CELULAR = '5531911111122';
$_FIXO = '553155551122';
$_PAIS = 'BR';
$_ESTADO = 'MG';
$_CIDADE = 'Belo Horizonte';
$_PROFISSAO = 'ESPORTE';
$_IDEXTERNO = '667811';
$_AVATAR_URL = 'https://www.meusite.com.br/foto.jpg';
$_OBS = 'Enviar proposta comercial na segunda';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " segmentation => ".$_SEG_LIST."<br/>";
$_TXT .= " tag => ".$_TAG."<br/>";
$_TXT .= " tag2 => ".$_TAG2."<br/>";
$_TXT .= " name => ".$_NOME."<br/>";
$_TXT .= " surname => ".$_SOBRENOME."<br/>";
$_TXT .= " gender => ".$_SEXO."<br/>";
$_TXT .= " birth => ".$_NASC."<br/>";
$_TXT .= " br_person_type => ".$_PESSOA."<br/>";
$_TXT .= " br_cpf => ".$_CPF."<br/>";
$_TXT .= " br_cnpj => ".$_CNPJ."<br/>";
$_TXT .= " company => ".$_EMPRESA."<br/>";
$_TXT .= " email => ".$_EMAIL."<br/>";
$_TXT .= " whatsapp_channel => ".$_WHATSAPP_CHANNEL."<br/>";
$_TXT .= " whatsapp => ".$_WHATSAPP."<br/>";
$_TXT .= " telegram_channel => ".$_TELEGRAM_CHANNEL."<br/>";
$_TXT .= " telegram_id => ".$_TELEGRAM_ID."<br/>";
$_TXT .= " fbmessenger_channel => ".$_FBMESSENGER_CHANNEL."<br/>";
$_TXT .= " fbmessenger_origem_page_id => ".$_FBMESSENGER_ORIGEM_PAGE_ID."<br/>";
$_TXT .= " fbmessenger_id => ".$_FBMESSENGER_ID."<br/>";
$_TXT .= " instagram_channel => ".$_INSTAGRAM_CHANNEL."<br/>";
$_TXT .= "instagram_origem_business_account_id => ".$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID."<br/>";
$_TXT .= " instagram_id => ".$_INSTAGRAM_ID."<br/>";
$_TXT .= " mobile_phone => ".$_CELULAR."<br/>";
$_TXT .= " phone => ".$_FIXO."<br/>";
$_TXT .= " country => ".$_PAIS."<br/>";
$_TXT .= " state => ".$_ESTADO."<br/>";
$_TXT .= " city => ".$_CIDADE."<br/>";
$_TXT .= " profession => ".$_PROFISSAO."<br/>";
$_TXT .= " external_id => ".$_IDEXTERNO."<br/>";
$_TXT .= " avatar_url => ".$_AVATAR_URL."<br/>";
$_TXT .= " obs => ".$_OBS."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"segmentation" => "$_SEG_LIST",
"tag" => "$_TAG",
"tag2" => "$_TAG2",
"name" => "$_NOME",
"surname" => "$_SOBRENOME",
"gender" => "$_SEXO",
"birth" => "$_NASC",
"br_person_type" => "$_PESSOA",
"br_cpf" => "$_CPF",
"br_cnpj" => "$_CNPJ",
"company" => "$_EMPRESA",
"email" => "$_EMAIL",
"whatsapp_channel" => "$_WHATSAPP_CHANNEL",
"whatsapp" => "$_WHATSAPP",
"telegram_channel" => "$_TELEGRAM_CHANNEL",
"telegram_id" => "$_TELEGRAM_ID",
fbmessenger_channel" => "$_FBMESSENGER_CHANNEL",
bmessenger_origem_page_id" => "$_FBMESSENGER_ORIGEM_PAGE_ID",
"fbmessenger_id" => "$_FBMESSENGER_ID",
"instagram_channel" => "$_INSTAGRAM_CHANNEL",
"instagram_origem_business_account_id" => "$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID",
"instagram_id" => "$_INSTAGRAM_ID",
"mobile_phone" => "$_CELULAR",
"phone" => "$_FIXO",
"country" => "$_PAIS",
"state" => "$_ESTADO",
"city" => "$_CIDADE",
"profession" => "$_PROFISSAO",
"external_id" => "$_IDEXTERNO",
"avatar_url" => "$_AVATAR_URL",
"obs" => "$_OBS"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
set_contact Requisita atualização de dados de contato
Utilize a requisição de atualização de dados de contato atualizar dados de ficha de um contato existente.
Requisição JSON:
{
"token": "xxxx",
"cmd": "set_contact",
"for_contact_id": "1234",
"segmentation": Negocia\u00e7\u00e3o, Proposta Enviada,
"tag": "VIP",
"tag2": "VIP2",
"name": "Jose",
"surname": "Silva",
"gender": "M",
"gender_info":"",
"birth": "1974-06-15",
"br_person_type": "J",
"br_cpf": "11122233300",
"br_cnpj": "00111222000133",
"company": "Empresa Minha Ltda",
"email": "jose@email.com",
"whatsapp_channel": "AAAAAAAAAAAAAAAAA-BBBBBB-CCCCCC",
"whatsapp": "5531911111122",
"telegram_channel": "",
"telegram_id": "",
"fbmessenger_channel": "",
"fbmessenger_origem_page_id": "",
"fbmessenger_id": "",
"instagram_channel": "",
"instagram_origem_business_account_id": "",
"mobile_phone": "5531911111122",
"phone": "553155551122",
"country": "BR",
"state": "MG",
"city": "Belo Horizonte",
"profession": "ESPORTE",
"external_id": "667811",
"ind_client":"1",
"client_code":"202104-e1b4e2",
"avatar_url": "https:\/\/www.meusite.com.br\/foto.jpg",
"obs": "Enviar proposta comercial na segunda",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: set_contact
- for_contact_id - Indica o ID do contato no Maxbot para atualização (ID pode ser obtido através do PUT_CONTACT, GET_CONTACT, GET_PROT ou GET_PROT_FULL);
- segmentation - Informe o título das segmentações separadas por vírgula (ex.: prospecto,apresentação,orçamento). Caso não exista no Maxbot, a segmentação será criada;
- tag - Tag que é apresentado na fila de espera do atendimento;
- tag2 - Tag que é apresentado na fila de espera do atendimento;
- name - Nome do contato (até 45 caracteres);
- surname - Sobrenome do contato (até 45 caracteres);
- gender - Sexo (M-Masculino, F-Feminino ou O-Outro);
- gender_info - Informação do Sexo O-Outro;
- birth - Data de Nascimento no formato Ano-Mês-Dia (Ex.: 2020-09-10);
- br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- company - Razão Social da Empresa;
- email - E-Mail do contato;
- whatsapp_channel - Token do canal Whatsapp cadastrado no Maxbot;
Informe o token do canal do WhatsApp cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- Obs.: Caso a whatsapp_channel não for informado, será utilizado o primeiro canal cadastrado no maxbot.
- whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- telegram_channel - Token do canal Telegram cadastrado no Maxbot; Informe o token do canal do Telegram cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- telegram_id - ID Telegram do contato;
- fbmessenger_channel - Token do canal Facebook Messenger cadastrado no Maxbot; Informe o token do canal do Facebook Messenger cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- fbmessenger_origem_page_id - ID da página do Facebook Messenger. Pode ser obtido através do endpoint get_page_facebook;
- fbmessenger_id - ID Facebook Messenger do contato;
- instagram_channel - Token do canal Instagram cadastrado no Maxbot; Informe o token do canal do Instagram cadastrado no Maxbot, o qual pode ser acessado em Configuração > Integração de Canal e obtido por meio do endpoint get_channel;
- instagram_origem_business_account_id - ID da Conta do Instagram. Pode ser obtido através do endpoint get_account_instagram;
- instagram_id - ID Instagram do contato;
- mobile_phone - Número do celular com código de país e DDD (Ex.: 5511988887777);
- phone - Número do telefone fixo com código de país e DDD (Ex.: 551144446666);
- country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, US-Estados Unidos, ES-Espanha, PT-Portugal);
- state - Código do estado (Para país BR (Brasil), o código deve ser correspondente ao código de um dos estados brasileiros. Ex.: MG-Minas Gerais, SP-São Paulo);
- city - Nome da cidade (Para país BR (Brasil), o nome da cidade deve ser igual ao nome indicado no padrão do IBGE (Instituto Brasileiro de Geografia e Estatística));
- profession - Nome da área profissional (Deve ser idêntico a uma das áreas profissionais existentes na ficha de cadastro do Maxbot);
- external_id - ID Externo do contato para cruzando de dados do Maxbot com outros sistemas (Ex.: um número de matrícula, um ID de registro de sistema, etc);
- ind_client - Indicador se o contato já é um Cliente da empresa (0-Não, 1-Sim);
- client_code - Código do Cliente usado no sistema interno da empresa;
- avatar_url - URL da imagem do avatar do contato em formato JPG;
- obs - Texto de observação para o registro do contato de até 255 caracteres;
- Tags INFO - Os campos de [INFO1], [INFO2], [INFO3], [INFO4], [INFO5] e [INFO6] é utilizado para entrada de texto livre a ser utilizado no disparo de templates. Permite texto livre, incluíndo EMOJIS, até 1.000 caracteres;
- tag_info1 - Tag Info 1, [INFO1];
- tag_info2 - Tag Info 2, [INFO2];
- tag_info3 - Tag Info 3, [INFO3];
- tag_info4 - Tag Info 4, [INFO4];
- tag_info5 - Tag Info 5, [INFO5];
- tag_info6 - Tag Info 6, [INFO6];
- Obs.: As Tags devem ser cadastradas no contato e no template para serem substituídas no envio de template.
- Atenção:
- Você deve informar ao menos um dos campos para atualização.
- Os campos informados terão seus valores atualizados pelos valores informados.
- Os campos whatsapp, mobile_phone, email, br_cpf, external_id, telegram_id, fbmessenger_id, instagram_origem_business_account_id não podem existir em nenhum outro registro (por exemplo, tentar atualizar um número de WhatsApp para um registro, sendo que o WhatsApp informado já existe em outra ficha de contato);
- Se o valor informado nestes campos for detectado, o Maxbot irá considerar a ficha como existente;
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'set_contact';
$_CONTATO_ID = '12345';
$_SEG_LIST = 'Negociação,Proposta Enviada';
$_TAG = 'VIP';
$_TAG2 = 'VIP2';
$_NOME = 'Jose';
$_SOBRENOME = 'Silva';
$_SEXO = 'M';
$_NASC = '1974-06-15';
$_PESSOA = 'J';
$_CPF = '87348769527';
$_CNPJ = '64420582000148';
$_EMPRESA = 'Empresa Minha Ltda';
$_EMAIL = 'jose@email.com';
$_WHATSAPP_CHANNEL = 'AAAAAAAAAAAAAAAAA-BBBBBB-CCCCCC';
$_WHATSAPP = '5531911111122';
$_TELEGRAM_CHANNEL = '';
$_TELEGRAM_ID = '';
$_FBMESSENGER_CHANNEL = '';
$_FBMESSENGER_ORIGEM_PAGE_ID = '';
$_FBMESSENGER_ID = '';
$_INSTAGRAM_CHANNEL = '';
$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID = '';
$_INSTAGRAM_ID = '';
$_CELULAR = '5531911111122';
$_FIXO = '553155551122';
$_PAIS = 'BR';
$_ESTADO = 'MG';
$_CIDADE = 'Belo Horizonte';
$_PROFISSAO = 'ESPORTE';
$_IDEXTERNO = '667811';
$_AVATAR_URL = 'https://www.meusite.com.br/foto.jpg';
$_OBS = 'Enviar proposta comercial na segunda';
$_TAG_INFO1 = '';
$_TAG_INFO2 = '';
$_TAG_INFO3 = '';
$_TAG_INFO3 = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " for_contact_id => ".$_CONTATO_ID."<br/>";
$_TXT .= " segmentation => ".$_SEG_LIST."<br/>";
$_TXT .= " tag => ".$_TAG."<br/>";
$_TXT .= " tag2 => ".$_TAG2."<br/>";
$_TXT .= " name => ".$_NOME."<br/>";
$_TXT .= " surname => ".$_SOBRENOME."<br/>";
$_TXT .= " gender => ".$_SEXO."<br/>";
$_TXT .= " birth => ".$_NASC."<br/>";
$_TXT .= " br_person_type => ".$_PESSOA."<br/>";
$_TXT .= " br_cpf => ".$_CPF."<br/>";
$_TXT .= " br_cnpj => ".$_CNPJ."<br/>";
$_TXT .= " company => ".$_EMPRESA."<br/>";
$_TXT .= " email => ".$_EMAIL."<br/>";
$_TXT .= " whatsapp_channel => ".$_WHATSAPP_CHANNEL."<br/>";
$_TXT .= " whatsapp => ".$_WHATSAPP."<br/>";
$_TXT .= " telegram_channel => ".$_TELEGRAM_CHANNEL."<br/>";
$_TXT .= " telegram_id => ".$_TELEGRAM_ID."<br/>";
$_TXT .= " fbmessenger_channel => ".$_FBMESSENGER_CHANNEL."<br/>";
$_TXT .= " fbmessenger_origem_page_id => ".$_FBMESSENGER_ORIGEM_PAGE_ID."<br/>";
$_TXT .= " fbmessenger_id => ".$_FBMESSENGER_ID."<br/>";
$_TXT .= " instagram_channel => ".$_INSTAGRAM_CHANNEL."<br/>";
$_TXT .= "instagram_origem_business_account_id => ".$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID."<br/>";
$_TXT .= " instagram_id => ".$_INSTAGRAM_ID."<br/>";
$_TXT .= " mobile_phone => ".$_CELULAR."<br/>";
$_TXT .= " phone => ".$_FIXO."<br/>";
$_TXT .= " country => ".$_PAIS."<br/>";
$_TXT .= " state => ".$_ESTADO."<br/>";
$_TXT .= " city => ".$_CIDADE."<br/>";
$_TXT .= " profession => ".$_PROFISSAO."<br/>";
$_TXT .= " external_id => ".$_IDEXTERNO."<br/>";
$_TXT .= " avatar_url => ".$_AVATAR_URL."<br/>";
$_TXT .= " obs => ".$_OBS."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"for_contact_id" => "$_CONTATO_ID",
"segmentation" => "$_SEG_LIST",
"tag" => "$_TAG",
"tag2" => "$_TAG2",
"name" => "$_NOME",
"surname" => "$_SOBRENOME",
"gender" => "$_SEXO",
"birth" => "$_NASC",
"br_person_type" => "$_PESSOA",
"br_cpf" => "$_CPF",
"br_cnpj" => "$_CNPJ",
"company" => "$_EMPRESA",
"email" => "$_EMAIL",
"whatsapp_channel" => "$_WHATSAPP_CHANNEL",
"whatsapp" => "$_WHATSAPP",
"telegram_channel" => "$_TELEGRAM_CHANNEL",
"telegram_id" => "$_TELEGRAM_ID",
fbmessenger_channel" => "$_FBMESSENGER_CHANNEL",
bmessenger_origem_page_id" => "$_FBMESSENGER_ORIGEM_PAGE_ID",
"fbmessenger_id" => "$_FBMESSENGER_ID",
"instagram_channel" => "$_INSTAGRAM_CHANNEL",
"instagram_origem_business_account_id" => "$_INSTAGRAM_ORIGEM_BUSINESS_ACCOUNT_ID",
"instagram_id" => "$_INSTAGRAM_ID",
"mobile_phone" => "$_CELULAR",
"phone" => "$_FIXO",
"country" => "$_PAIS",
"state" => "$_ESTADO",
"city" => "$_CIDADE",
"profession" => "$_PROFISSAO",
"external_id" => "$_IDEXTERNO",
"avatar_url" => "$_AVATAR_URL",
"obs" => "$_OBS"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
delete_contact Deletar Contato
Utilize a requisição de deletar contato para excluir uma lista de contatos no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "delete_contact",
"contact_id": [123,134,532,874]
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: delete_contact;
- contact_id - Informe um array com id dos contatos ex.: "[123,134,532,874]".
- Obs.: Não é possível excluir contatos que estejam em atendimento.
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = "xxxxxx";
$_CMD = "delete_contact";
$_CONTACT_ID = array(123,134,532,874);
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " contact_id => ".print_r($_CONTACT_ID, true)."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"contact_id" => (array) $_CONTACT_ID
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
open_followup Requisita abertura de protocolo de follow up com disparo de template de follow up ou template de autenticação
Utilize a requisição de abertura de protocolo de follow up para enviar um template de follow up ou template de autenticação seguido da abertura automática de um protocolo de atendimento para um contato. Você pode disparar templates para qualquer contato previamente existente na sua base de contatos.
Requisição JSON:
{
"token": "xxxx",
"cmd": "open_followup",
"channel_token": "202304FE471FF7A477-5FA8BA-E72F90",
"contact_id": 1234,
"template_id": 1234,
"sector_id": 1234,
"attendant_id": 0,
"scheduled": 1,
"scheduled": 1,
"date_time": "2020-12-01 13:00:00",
"user_otp_code": "12345678"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: open_followup
- channel_token - Informe o token do canal. Pode ser obtido através do endpoint get_channel.
- Obs.: Caso a channel_token não for informado, será utilizado o primeiro canal cadastrado no maxbot.
- contact_id - ID do contato
- template_id - ID do template (Tipo Follow-Up ou Tipo Autenticação)
- Obs. 1: Tipo Autenticação - Os templates de autenticação permitem que você autentique usuários com senhas únicas, possivelmente em várias etapas do processo de login (por exemplo, verificação de conta, recuperação de conta, desafios de integridade).
- Obs. 2: Se a Sessão de 24 Horas estiver Fechada! Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA).
- sector_id - ID do setor de atendimento
- attendant_id - ID do atendente (Informe 0 como ID do atendente para que o contato caia na fila geral do setor e fique visível para qualquer atendente do setor. Indique o ID do atendente do setor para que o contato caia no box lateral do chat do atendente. Atenção: O ID de um atendente deve constar como um atendente do setor indicado. Do contrário o comando não será executado!)
- scheduled - Indicador de agendamento de disparo. (0 - Disparo imediato, 1 - Agendar disparo para uma data hora específica)
- date_time - Data hora para disparo agendado
- Obs.1: Deve ser uma data hora no formato AAAA-MM-DD HH:MM:SS. (Ex.: 2020-12-01 14:30:00)
- Obs.2: Hora deve ser um número de 2 dígitos de 00 a 23;
- Obs.3: Minuto deve ser 00 ou 30;
- Obs.4: Segundos devem ser sempre 00;
- Obs.5: Data hora fora do padrão causará falha na execução;
- user_otp_code - Código OTP do usuário para envio de template de autenticação com botões de senha única.
- Obs.1: O Indicador de agendamento de disparo deve ser 0 - Disparo imediato.
- Obs.2: O valor do user_otp_code deve ser entre 4 a 8 dígitos.
Retorno:
{
"status": 1,
"msg": "Success",
"prot_id": "1234",
"protocol": "1234"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- prot_id - ID do Protocolo;
- protocol - Número do Protocolo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'open_followup';
$_CT_ID = '1234';
$_TP_ID = '1234';
$_ST_ID = '1234';
$_AT_ID = '0';
$_SCHEDULED = '0';
$_DATE_TIME = '2020-12-01 08:30:00';
$_USER_OTP_CODE = '12345678';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " contact_id => ".$_CT_ID."<br/>";
$_TXT .= " template_id => ".$_TP_ID."<br/>";
$_TXT .= " sector_id => ".$_ST_ID."<br/>";
$_TXT .= " attendant_id => ".$_AT_ID."<br/>";
$_TXT .= " scheduled => ".$_SCHEDULED."<br/>";
$_TXT .= " date_time => ".$_DATE_TIME."<br/>";
$_TXT .= " user_otp_code => ".$_USER_OTP_CODE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"contact_id" => "$_CT_ID",
"template_id" => "$_TP_ID",
"sector_id" => "$_ST_ID",
"attendant_id" => "$_AT_ID",
"scheduled" => "$_SCHEDULED",
"date_time" => "$_DATE_TIME",
"user_otp_code" => "$_USER_OTP_CODE",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
terminate_prot Encerrar protocolo
Utilize a requisição de Encerrar protocolo para encerrar um protocolo.
Requisição JSON:
{
"token": "xxx",
"cmd": "terminate_prot",
"ind_env_msg": "1",
"prot_id": "1234"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: terminate_prot;
- ind_env_msg - Indica se é para enviar a mensagem de encerramento ao finalizar o protocolo - (0 - Não, 1 - Sim);
- prot_id - ID do protocolo;
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'terminate_prot';
$_IND_ENV_MSG = '1';
$_PROT_ID = '1234';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " ind_env_msg => ".$_IND_ENV_MSG."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID.""<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"ind_env_msg" => "$_IND_ENV_MSG",
"prot_id" => "$_PROT_ID"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_charge_list Requisita listagem de cobranças do módulo cobrança inteligente da conta Maxbot
Utilize a requisição de listagem de cobranças para importar todas as cobranças cadastrada no módulo cobrança inteligente.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_charge_list",
"date_start": "2021-10-01",
"date_stop": "2021-10-16",
"focus_of_period": "1",
"send": "",
"payment": "",
"invoice": "",
"whatsapp": "",
"mobile_phone": "",
"email": "",
"origin": "",
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_charge
- date_start - Data de início da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2021-10-01);
- date_stop - Data fim da consulta no padrão AAAA-MM-DD (Ano com 4 dígitos, Mês com 2 dígitos, Dia com 2 dígitos. Ex.: 2021-10-16);
- focus_of_period - Indica qual a data que será usada para realização da busca dos registros (0-Data de Vencimento, 1-Data de Envio da 1º Cobrança, 2-Data de Envio da 2º Cobrança, 3-Data de Envio do 1º Aviso, 4-Data de Envio do 2º Aviso, 5-Data de Envio da Nota Fiscal, 6-Data de Envio do Pagamento Efetuado, 7-Data de Envio da Cobrança Cancelada);
- send - Situação do Envio da Cobrança (0-Programado, 1-Sucesso, 2-Falha);
- payment - Situação do Pagamento da cobrança (0-Pendente, 1-Pago, 2-Cancelado);
- invoice - Número da cobrança;
- whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- mobile_phone - Número do telefone fixo com código de país e DDD (Ex.: 5511988887777);
- email - E-mail do Cliente;
- origin - Origem da Cobrança (M - Manual, A - API, I - Importação, IXC - IXC Soft, SGP - SGP Soft, RBX - RBX Soft, RADIUS - Sistema Radius, MK - MK Solutions);
Retorno:
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_charge
- charge_id - ID da Cobrança no Maxbot; (ID pode ser obtido através do get_charge_list ou insert_charge)
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"client_country": "BR",
"client_client_name": "Jose Silva",
"client_name": "Jose",
"client_last_name": "Silva",
"client_br_person_type": "J",
"client_br_cpf": "11122233300",
"client_br_cnpj": "00111222000133",
"client_company": "Empresa Minha Ltda",
"client_whatsapp": "5531911116666",
"client_mobile_phone": "5531911116666",
"client_email": "jose@email.com",
"client_code1": "1231",
"client_code2": "12321",
"client_code3": "AV930",
"charge_id": "2342",
"charge_origin": "Manual",
"charge_invoice": "12342",
"charge_due_date": "2022-07-13",
"charge_amount": "120.00",
"charge_link_pdf": "https:\/\/www.meusite.com.br\/charge.pdf",
"charge_bar_code": "11791.21928 50010.794810 63000.046902 7 90520000030100",
"ind_pg": "1",
"pg_date": "2022-07-13",
"pg_amount": "120.00",
"cnc_date": "",
"cnc_reason": "",
"nf_link_pdf": "https:\/\/www.meusite.com.br\/nfe.pdf",
"nf_link_xml": "https:\/\/www.meusite.com.br\/nfe.xml",
"msg_charge_1": [
{
"status": "5",
"date": "2022-07-11",
"info": "Late Date"
}
],
"msg_charge_2": [
{
"status": "1",
"date": "2022-07-29",
"info": ""
}
],
"msg_alert_1": [
{
"status": "1",
"date": "2022-08-29",
"info": ""
}
],
"msg_alert_2": [
{
"status": "1",
"date": "2022-09-29",
"info": ""
}
],
"msg_pg": [
{
"status": "2",
"date": "",
"info": "Waiting"
}
],
"msg_cnc": [
{
"status": "2",
"date": "",
"info": "Waiting"
}
],
"msg_nf": [
{
"status": "3",
"date": "2022-07-29",
"info": ""
}
]
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- client_country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, PE-Peru, US-Estados Unidos);
- client_client_name - Nome Completo do Cliente;
- client_name - Nome do Cliente;
- client_last_name - Sobrenome do Cliente;
- client_br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- client_br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_company - Razão Social da Empresa;
- client_whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- client_mobile_phone - Número do telefone celular com código de país e DDD (Ex.: 5511988887777);
- client_email - E-Mail do Cliente;
- client_code1 - Código do Cliente no sistema da empresa;
- client_code2 - Código do Cliente no sistema da empresa;
- client_code3 - Código do Cliente no sistema da empresa;
- charge_id - ID da Cobrança no Maxbot;
- charge_origin - Origem da Cobrança (M - Manual, A - API, I - Importação, IXC - IXC Soft, SGP - SGP Soft, RBX - RBX Soft, RADIUS - Sistema Radius, MK - MK Solutions);
- charge_invoice - Número da cobrança;
- charge_due_date - Data de Vencimento da cobrança;
- charge_amount - Valor da cobrança;
- charge_link_pdf - Link do pdf da cobrança;
- charge_bar_code - Código de Barras da cobrança;
- ind_pg - Situação do pagamento ( 0 - Pendente, 1 - Pago, 2 - Cancelado);
- pg_date - Data de pagamento da cobrança;
- pg_amount - Valor de pagameto da cobrança;
- cnc_date - Data do Cancelamento da cobrança;
- cnc_reason - Motivo do Cancelamento da cobrança;
- nf_link_pdf - Link pdf da Nota Fiscal da cobrança;
- nf_link_xml - Link xml da Nota Fiscal da cobrança;
- msg_charge_1
- status - Situação de Envio da 1ª Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 1ª Cobrança;
- info - Informação de Envio da 1ª Cobrança;
- msg_charge_2
- status - Situação de Envio da 2ª Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 2ª Cobrança;
- info - Informação de Envio da 2ª Cobrança;
- msg_alert_1
- status - Situação de Envio do 1º Aviso (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 1º Aviso;
- info - nformação de Envio do 1º Aviso;
- msg_alert_2
- status - Situação de Envio do 2º Aviso (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 2º Aviso;
- info - Informação de Envio do 2º Aviso;
- msg_pg
- status - Situação de Envio do Pagamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso , 5 - Falha);
- date - Data de Envio do Pagamento;
- info - Informação de Envio do Pagamento;
- msg_cnc
- status - Situação de Envio do Cancelamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio do Cancelamento;
- info - Informação de Envio do Cancelamento;
- msg_nf
- status - Situação de Envio da Nota Fiscal (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio da Nota Fiscal;
- info - Informação de Envio da Nota Fiscal;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_charge_list';
$_DATE_START = '2021-10-01';
$_DATE_STOP = '2021-10-16';
$_FOCUS_OF_PERIOD = '1';
$_SEND = '';
$_PAYMENT = '';
$_INVOICE = '';
$_WHATSAPP = '';
$_MOBILE_PHONE = '';
$_EMAIL = '';
$_ORIGIN = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " date_start => ".$_DATE_START."<br/>";
$_TXT .= " date_stop => ".$_DATE_STOP."<br/>";
$_TXT .= " focus_of_period => ".$_FOCUS_OF_PERIOD."<br/>";
$_TXT .= " send => ".$_SEND."<br/>";
$_TXT .= " payment => ".$_PAYMENT."<br/>";
$_TXT .= " invoice => ".$_INVOICE."<br/>";
$_TXT .= " whatsapp => ".$_WHATSAPP."<br/>";
$_TXT .= " mobile_phone => ".$_MOBILE_PHONE."<br/>";
$_TXT .= " email => ".$_EMAIL."<br/>";
$_TXT .= " origin => ".$_ORIGIN."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"date_start" => "$_DATE_START",
"date_stop" => "$_DATE_STOP",
"focus_of_period" => "$_FOCUS_OF_PERIOD",
"send" => "$_SEND",
"payment" => "$_PAYMENT",
"invoice" => "$_INVOICE",
"whatsapp" => "$_WHATSAPP",
"mobile_phone" => "$_MOBILE_PHONE",
"email" => "$_EMAIL",
"origin" => "$_ORIGIN",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
get_charge Requisita listagem de uma cobrança do módulo cobrança inteligente da conta maxbot
Utilize a requisição para importar os dados de uma cobrança indicado do cobrança inteligente da conta Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "get_charge",
"charge_id": "000"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: get_charge
- charge_id - ID da Cobrança no Maxbot; (ID pode ser obtido através do get_charge_list ou insert_charge)
Retorno:
{
"status": 1,
"msg": "Success",
"data": [
{
"client_country": "BR",
"client_client_name": "Jose Silva",
"client_name": "Jose",
"client_last_name": "Silva",
"client_br_person_type": "J",
"client_br_cpf": "11122233300",
"client_br_cnpj": "00111222000133",
"client_company": "Empresa Minha Ltda",
"client_whatsapp": "5531911116666",
"client_mobile_phone": "5531911116666",
"client_email": "jose@email.com",
"client_code1": "1231",
"client_code2": "12321",
"client_code3": "AV930",
"charge_id": "2342",
"charge_origin": "M",
"charge_invoice": "12342",
"charge_due_date": "2022-07-13",
"charge_amount": "120.00",
"charge_link_pdf": "https:\/\/www.meusite.com.br\/charge.pdf",
"charge_bar_code": "11791.21928 50010.794810 63000.046902 7 90520000030100",
"ind_pg": "1",
"pg_date": "2022-07-13",
"pg_amount": "120.00",
"cnc_date": "",
"cnc_reason": "",
"nf_link_pdf": "https:\/\/www.meusite.com.br\/nfe.pdf",
"nf_link_xml": "https:\/\/www.meusite.com.br\/nfe.xml",
"msg_charge_1": [
{
"status": "5",
"date": "2022-07-11",
"info": "Late Date"
}
],
"msg_charge_2": [
{
"status": "1",
"date": "2022-07-29",
"info": ""
}
],
"msg_alert_1": [
{
"status": "1",
"date": "2022-08-29",
"info": ""
}
],
"msg_alert_2": [
{
"status": "1",
"date": "2022-09-29",
"info": ""
}
],
"msg_pg": [
{
"status": "2",
"date": "",
"info": "Waiting"
}
],
"msg_cnc": [
{
"status": "3",
"date": "2022-07-29",
"info": ""
}
],
"msg_nf": [
{
"status": "3",
"date": "2022-07-29",
"info": ""
}
]
}
]
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- data - Retorno da requisição;
- client_country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, PE-Peru, US-Estados Unidos);
- client_name - Nome Completo do Cliente;
- client_name - Nome do Cliente;
- client_last_name - Sobrenome do Cliente;
- client_br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- client_br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_company - Razão Social da Empresa;
- client_whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- client_mobile_phone - Número do celular com código de país e DDD (Ex.: 5511988887777);
- client_email - E-Mail do Cliente;
- client_code1 - Código do Cliente no sistema da empresa;
- client_code2 - Código do Cliente no sistema da empresa;
- client_code3 - Código do Cliente no sistema da empresa;
- charge_id - ID da Cobrança no Maxbot;
- charge_origin - Origem da Cobrança (M - Manual, A - API, I - Importação, IXC - IXC Soft, SGP - SGP Soft, RBX - RBX Soft, RADIUS - Sistema Radius, MK - MK Solutions);
- charge_invoice - Número da cobrança;
- charge_due_date - Data de Vencimento da cobrança;
- charge_amount - Valor da cobrança;
- charge_link_pdf - Link do pdf da cobrança;
- charge_bar_code - Código de Barras da cobrança;
- ind_pg - Situação do pagamento (0-Pendente, 1-Pago, 2-Cancelado);
- pg_date - Data de pagamento da cobrança;
- pg_amount - Valor de pagameto da cobrança;
- cnc_date - Data do Cancelamento da cobrança;
- cnc_reason - Motivo do Cancelamento da cobrança;
- nf_link_pdf - Link pdf da Nota Fiscal da cobrança;
- nf_link_xml - Link xml da Nota Fiscal da cobrança;
- msg_charge_1
- status - Situação de Envio da 1ª Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 1ª Cobrança;
- info - Informação de Envio da 1ª Cobrança;
- msg_charge_2
- status - Situação de Envio da 2ª Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 2ª Cobrança;
- info - Informação de Envio da 2ª Cobrança;
- msg_alert_1
- status - Situação de Envio do 1º Aviso (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 1º Aviso;
- info - nformação de Envio do 1º Aviso;
- msg_alert_2
- status - Situação de Envio do 2º Aviso (0 - Desativado, 1 - Programado, 2 - Aguardando, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 2º Aviso;
- info - Informação de Envio do 2º Aviso;
- msg_pg
- status - Situação de Envio do Pagamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso , 5 - Falha);
- date - Data de Envio do Pagamento;
- info - Informação de Envio do Pagamento;
- msg_cnc
- status - Situação de Envio do Cancelamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio do Cancelamento;
- info - Informação de Envio do Cancelamento;
- msg_nf
- status - Situação de Envio da Nota Fiscal (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio da Nota Fiscal;
- info - Informação de Envio da Nota Fiscal;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'get_charge';
$_CHARGE_ID = '000';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " charge_id => ".$_CHARGE_ID."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"charge_id" => "$_CHARGE_ID",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
insert_charge Inserir Cobrança
Utilize a requisição de criação de cobrança para criar um nova cobrança no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "insert_charge",
"client_country": "BR",
"client_client_name": "Jose Silva",
"client_name": "Jose",
"client_last_name": "Silva",
"client_br_person_type": "J",
"client_br_cpf": "11122233300",
"client_br_cnpj": "00111222000133",
"client_company": "Empresa Minha Ltda",
"client_whatsapp": "5531911116666",
"client_mobile_phone": "5531911116666",
"client_email": "jose@email.com",
"client_code1": "1231",
"client_code2": "12321",
"client_code3": "AV930",
"charge_invoice": "12342",
"charge_due_date": "2022-07-13",
"charge_amount": "120.00",
"charge_link_pdf": "https:\/\/www.meusite.com.br\/charge.pdf",
"charge_bar_code": "11791.21928 50010.794810 63000.046902 7 90520000030100",
"ind_pg": "1",
"pg_date": "2022-07-13",
"pg_amount": "120.00",
"nf_link_pdf": "https:\/\/www.meusite.com.br\/nfe.pdf",
"nf_link_xml": "https:\/\/www.meusite.com.br\/nfe.xml",
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: insert_charge
- client_country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, PE-Peru, US-Estados Unidos);
- client_client_name - Nome Completo do Cliente (até 45 caracteres);
- client_name - Nome do Cliente (até 45 caracteres);
- client_last_name - Sobrenome do Cliente (até 45 caracteres);
- client_br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- client_br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_company - Razão Social da Empresa (até 180 caracteres);
- client_whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- client_mobile_phone - Número do celular com código de país e DDD (Ex.: 5511988887777);
- client_email - E-Mail do Cliente (até 45 caracteres);
- client_code1 - Código do Cliente no sistema da empresa;
- client_code2 - Código do Cliente no sistema da empresa;
- client_code3 - Código do Cliente no sistema da empresa;
- charge_invoice - Número da cobrança (até 100 caracteres);
- charge_due_date - Data de Vencimento da cobrança;
- charge_amount - Valor da cobrança;
- charge_link_pdf - Link do pdf da cobrança (até 255 caracteres);
- charge_bar_code - Código de Barras da cobrança (até 180 caracteres);
- ind_pg - Situação do pagamento (0-Pendente, 1-Pago, 2-Cancelado);
- pg_date - Data de pagamento da cobrança;
- pg_amount - Valor de pagameto da cobrança;
- cnc_date - Data do Cancelamento da cobrança;
- cnc_reason - Motivo do Cancelamento da cobrança;
- nf_link_pdf - Link pdf da Nota Fiscal da cobrança (até 255 caracteres);
- nf_link_xml - Link xml da Nota Fiscal da cobrança (até 255 caracteres);
- Atenção:
- Só será enviado o template de pagamento efetuado quando o status de pagamento for PAGO, data de pagamento preenchida e valor pago preenchido.
- Só será enviado o template de nota fiscal, quando o link do PDF ou o Link do XML ou ambos os links forem informados.
- Quando for atualizar os links, atualizar PDF e XML simultâneamente, pois assim que o link do PDF ou do XML estiverem presentes no registro, o sistema já irá disparar o template com os dados informados.
Retorno:
{
"status": 1,
"msg": "Success",
"charge_id": "123",
"created_at": "2022-07-13 08:20:10"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- charge_id - ID da cobrança no Maxbot;
- created_at - Data e Hora de cadastro da cobrança;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'insert_charge';
$_CLIENT_COUNTRY = 'BR';
$_CLIENT_NOME = 'Jose';
$_CLIENT_LAST_NAME = 'Silva';
$_CLIENT_CPF = '13022720637';
$_CLIENT_PESSOA = 'F';
$_CLIENT_WHATSAPP = '5531911116666';
$_CHARGE_INVOICE = '23542';
$_CHARGE_DUE_DATE = '2022-07-12';
$_CHARGE_AMOUNT = '120.00';
$_CHARGE_LINK_PDF = 'https://www.meusite.com.br/charge.pdf';
$_IND_PG = '0';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " client_country => ".$_CLIENT_COUNTRY."<br/>";
$_TXT .= " client_name => ".$_CLIENT_NOME."<br/>";
$_TXT .= " client_last_name => ".$_CLIENT_LAST_NAME."<br/>";
$_TXT .= " client_br_person_type => ".$_CLIENT_PESSOA."<br/>";
$_TXT .= " client_br_cpf => ".$_CLIENT_CPF."<br/>";
$_TXT .= " client_whatsapp => ".$_CLIENT_WHATSAPP."<br/>";
$_TXT .= " charge_invoice => ".$_CHARGE_INVOICE."<br/>";
$_TXT .= " charge_due_date => ".$_CHARGE_DUE_DATE."<br/>";
$_TXT .= " charge_amount => ".$_CHARGE_AMOUNT."<br/>";
$_TXT .= " charge_link_pdf => ".$_CHARGE_LINK_PDF."<br/>";
$_TXT .= " ind_pg => ".$_IND_PG."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"charge_invoice" => "$_CHARGE_INVOICE",
"client_country" => "$_CLIENT_COUNTRY",
"client_name" => "$_CLIENT_NOME",
"client_last_name" => "$_CLIENT_LAST_NAME",
"client_br_person_type" => "$_CLIENT_PESSOA",
"client_br_cpf" => "$_CLIENT_CPF",
"client_whatsapp" => "$_CLIENT_WHATSAPP",
"charge_due_date" => "$_CHARGE_DUE_DATE",
"charge_amount" => "$_CHARGE_AMOUNT",
"charge_link_pdf" => "$_CHARGE_LINK_PDF",
"ind_pg" => "$_IND_PG",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
update_charge Atualizar Cobrança
Utilize a requisição de atualização de cobrança para atualizar uma cobrança no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "update_charge",
"charge_id": "123",
"client_country": "BR",
"client_client_name": "Jose Silva",
"client_name": "Jose",
"client_last_name": "Silva",
"client_br_person_type": "J",
"client_br_cpf": "11122233300",
"client_br_cnpj": "00111222000133",
"client_company": "Empresa Minha Ltda",
"client_whatsapp": "5531911116666",
"client_mobile_phone": "5531911116666",
"client_email": "jose@email.com",
"client_code1": "1231",
"client_code2": "12321",
"client_code3": "AV930",
"charge_invoice": "12342",
"charge_due_date": "2022-07-13",
"charge_amount": "120.00",
"charge_link_pdf": "https:\/\/www.meusite.com.br\/charge.pdf",
"charge_bar_code": "11791.21928 50010.794810 63000.046902 7 90520000030100",
"ind_pg": "1",
"pg_date": "2022-07-13",
"pg_amount": "120.00",
"nf_link_pdf": "https:\/\/www.meusite.com.br\/nfe.pdf",
"nf_link_xml": "https:\/\/www.meusite.com.br\/nfe.xml",
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: insert_charge
- charge_id - ID da Cobrança no Maxbot;
- client_country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, PE-Peru, US-Estados Unidos);
- client_client_name - Nome Completo do Cliente (até 45 caracteres);
- client_name - Nome do Cliente (até 45 caracteres);
- client_last_name - Sobrenome do Cliente (até 45 caracteres);
- client_br_person_type - Tipo de pessoa do padrão brasileiro (F-Física, J-Jurídica);
- client_br_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_br_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro (Informar apenas os números. Deve ser um número válido.);
- client_company - Razão Social da Empresa (até 180 caracteres);
- client_whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- client_mobile_phone - Número do celular com código de país e DDD (Ex.: 5511988887777);
- client_email - E-Mail do Cliente (até 45 caracteres);
- client_code1 - Código do Cliente no sistema da empresa;
- client_code2 - Código do Cliente no sistema da empresa;
- client_code3 - Código do Cliente no sistema da empresa;
- charge_invoice - Número da cobrança (até 100 caracteres);
- charge_due_date - Data de Vencimento da cobrança;
- charge_amount - Valor da cobrança;
- charge_link_pdf - Link do pdf da cobrança (até 255 caracteres);
- charge_bar_code - Código de Barras da cobrança (até 180 caracteres);
- ind_pg - Situação do pagamento (0-Pendente, 1-Pago, 2-Cancelado);
- pg_date - Data de pagamento da cobrança;
- pg_amount - Valor de pagameto da cobrança;
- cnc_date - Data do Cancelamento da cobrança;
- cnc_reason - Motivo do Cancelamento da cobrança;
- nf_link_pdf - Link pdf da Nota Fiscal da cobrança (até 255 caracteres);
- nf_link_xml - Link xml da Nota Fiscal da cobrança (até 255 caracteres);
- Exemplo de Requisição:
Requisição JSON para realizar baixa no pagamento de uma cobrança no Maxbot:
{ "token": "xxxx", "cmd": "update_charge", "charge_id": "123", "ind_pg": "1", "pg_date": "2022-07-13", "pg_amount": "120.00", }
Requisição JSON para realizar o cancelamento de uma cobrança no Maxbot:
{ "token": "xxxx", "cmd": "update_charge", "charge_id": "123", "ind_pg": "2", "cnc_date": "2022-07-13", "cnc_reason": "Cobran\u00e7a com dados incorretos.", }
Requisição JSON para atualizar o link pdf ou link xml de uma nota fiscal no Maxbot:
{ "token": "xxxx", "cmd": "update_charge", "charge_id": "123", "nf_link_pdf": "https:\/\/www.meusite.com.br\/nfe.pdf", "nf_link_xml": "https:\/\/www.meusite.com.br\/nfe.xml", }
- Atenção:
- Os campos token, cmd e charge_id são obrigatórios.
- Só será enviado o template de pagamento efetuado quando o status de pagamento for PAGO, data de pagamento preenchida e valor pago preenchido.
- Só será enviado o template de nota fiscal, quando o link do PDF ou o Link do XML ou ambos os links forem informados.
- Quando for atualizar os links, atualizar PDF e XML simultâneamente, pois assim que o link do PDF ou do XML estiverem presentes no registro, o sistema já irá disparar o template com os dados informados.
Retorno:
{
"status": 1,
"msg": "Success",
"updated_at": "2022-07-13 08:20:10"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- updated_at - Data e Hora de atualização da cobrança;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'update_charge';
$_CLIENT_COUNTRY = 'BR';
$_CLIENT_NOME = 'Jose';
$_CLIENT_LAST_NAME = 'Silva';
$_CLIENT_CPF = '13022720637';
$_CLIENT_PESSOA = 'F';
$_CLIENT_WHATSAPP = '5531911116666';
$_CHARGE_ID = '123';
$_CHARGE_INVOICE = '23542';
$_CHARGE_DUE_DATE = '2022-07-12';
$_CHARGE_AMOUNT = '120.00';
$_CHARGE_LINK_PDF = 'https://www.meusite.com.br/charge.pdf';
$_IND_PG = '0';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " client_country => ".$_CLIENT_COUNTRY."<br/>";
$_TXT .= " client_name => ".$_CLIENT_NOME."<br/>";
$_TXT .= " client_last_name => ".$_CLIENT_LAST_NAME."<br/>";
$_TXT .= " client_br_person_type => ".$_CLIENT_PESSOA."<br/>";
$_TXT .= " client_br_cpf => ".$_CLIENT_CPF."<br/>";
$_TXT .= " client_whatsapp => ".$_CLIENT_WHATSAPP."<br/>";
$_TXT .= " charge_id => ".$_CHARGE_ID."<br/>";
$_TXT .= " charge_invoice => ".$_CHARGE_INVOICE."<br/>";
$_TXT .= " charge_due_date => ".$_CHARGE_DUE_DATE."<br/>";
$_TXT .= " charge_amount => ".$_CHARGE_AMOUNT."<br/>";
$_TXT .= " charge_link_pdf => ".$_CHARGE_LINK_PDF."<br/>";
$_TXT .= " ind_pg => ".$_IND_PG."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"client_country" => "$_CLIENT_COUNTRY",
"client_name" => "$_CLIENT_NOME",
"client_last_name" => "$_CLIENT_LAST_NAME",
"client_br_person_type" => "$_CLIENT_PESSOA",
"client_br_cpf" => "$_CLIENT_CPF",
"client_whatsapp" => "$_CLIENT_WHATSAPP",
"charge_id" => "$_CHARGE_ID",
"charge_invoice" => "$_CHARGE_INVOICE",
"charge_due_date" => "$_CHARGE_DUE_DATE",
"charge_amount" => "$_CHARGE_AMOUNT",
"charge_link_pdf" => "$_CHARGE_LINK_PDF",
"ind_pg" => "$_IND_PG",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
delete_charge Deletar Cobrança
Utilize a requisição de deletar cobrança para excluir uma cobrança no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "delete_charge",
"charge_id": [123,134,532,874]
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: delete_charge;
- charge_id - Informe um array com id das cobrança ex.: "[123,134,532,874]".
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = "xxxxxx";
$_CMD = "delete_charge";
$_CHARGE_ID = array(123,134,532,874);
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " charge_id => ".print_r($_CHARGE_ID, true)."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"charge_id" => (array) $_CHARGE_ID
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_notice Requisita disparo de template de aviso ou template de autenticação
Utilize a requisição de envio de template de aviso ou template de autenticação. Envio de aviso só é permitido para contatos que trocaram mensagem no Maxbot.
Requisição JSON:
{
"token": "xxxx",
"cmd": "send_notice",
"channel_token": "202304FE471FF7A477-5FA8BA-E72F90",
"contact_id": 1234,
"template_id": 1234,
"scheduled": 1,
"date_time": "2020-12-01 13:00:00",
"user_otp_code": "12345678"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_notice
- channel_token - Informe o token do canal. Pode ser obtido através do endpoint get_channel.
- Obs. 1: channel_token não for informado, será utilizado o primeiro canal cadastrado no maxbot.
- Obs. 2: Envio feito pelo canal SMS, use no channel_token o valor --SMS--.
- Obs. 3: Envio feito pelo canal E-MAIL, use no channel_token o valor --EMAIL--.
- contact_id - ID do contato
- Obs. 1: Envio de aviso só é permitido para contatos que trocaram mensagem no Maxbot.
- Obs. 2: Se em get_contact o validated_whatsapp retornar 1-Sim, esse contato pode receber aviso.
- template_id - ID do template (Tipo Aviso ou Tipo Autenticação)
- Obs. 1: Tipo Autenticação - Os templates de autenticação permitem que você autentique usuários com senhas únicas, possivelmente em várias etapas do processo de login (por exemplo, verificação de conta, recuperação de conta, desafios de integridade).
- Obs. 2: Se a Sessão de 24 Horas estiver Fechada! Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA).
- scheduled - Indicador de agendamento de disparo. (0 - Disparo imediato, 1 - Agendar disparo para uma data hora específica)
- date_time - Data hora para disparo agendado
- Obs.1: Deve ser uma data hora no formato AAAA-MM-DD HH:MM:SS. (Ex.: 2020-12-01 14:30:00)
- Obs.2: Hora deve ser um número de 2 dígitos de 00 a 23;
- Obs.3: Minuto deve ser 00 ou 30;
- Obs.4: Segundos devem ser sempre 00;
- Obs.5: Data hora fora do padrão causará falha na execução;
- user_otp_code - Código OTP do usuário para envio de template de autenticação com botões de senha única.
- Obs.1: O Indicador de agendamento de disparo deve ser 0 - Disparo imediato.
- Obs.2: O valor do user_otp_code deve ser entre 4 a 8 dígitos.
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_notice';
$_CHANNEL_TOKEN = '202304FE471FF7A477-5FA8BA-E72F90';
$_CT_ID = '1234';
$_TP_ID = '1234';
$_SCHEDULED = '0';
$_DATE_TIME = '2020-12-01 08:30:00';
$_USER_OTP_CODE = '12345678';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel_token => ".$_CHANNEL_TOKEN."<br/>";
$_TXT .= " contact_id => ".$_CT_ID."<br/>";
$_TXT .= " template_id => ".$_TP_ID."<br/>";
$_TXT .= " scheduled => ".$_SCHEDULED."<br/>";
$_TXT .= " date_time => ".$_DATE_TIME."<br/>";
$_TXT .= " user_otp_code => ".$_USER_OTP_CODE."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel_token" => "$_CHANNEL_TOKEN",
"contact_id" => "$_CT_ID",
"template_id" => "$_TP_ID",
"scheduled" => "$_SCHEDULED",
"date_time" => "$_DATE_TIME",
"user_otp_code" => "$_USER_OTP_CODE",
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_chat_msg Requisita disparo de mensagem.
Utilize a requisição de disparo de mensagem no chat em atendimento.
Requisição JSON:
{
"token": "xxx",
"cmd": "send_chat_msg",
"prot_id": "1234",
"msg": "Teste envio de emojis [EMOJI1]",
"msg_date_sql": "2024-12-18 23:39:43"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_chat_msg;
- prot_id - ID do protocolo (Utilize o open_followup para obter o prot_id).
- msg - Texto da mensagem para disparo.
- Emojis: Tags emoji serão substituídos pelo emoji correspondente no momento do disparo. Tags de emoji disponíveis:
- [EMOJI1] - 😃
- [EMOJI2] - 😁
- [EMOJI3] - 🤣
- [EMOJI4] - 😉
- [EMOJI5] - 😍
- [EMOJI6] - 🤩
- [EMOJI7] - 🤔
- [EMOJI8] - 😕
- [EMOJI9] - 👉
- [EMOJI10] - 👍
- [EMOJI11] - 😅
- [EMOJI12] - 🙂
- [EMOJI13] - 😱
- [EMOJI14] - 💥
- [EMOJI15] - ⏰
- [EMOJI16] - ⭐
- [EMOJI17] - 👏
- [EMOJI18] - 😎
- [EMOJI19] - 😉
- [EMOJI20] - 😊
- [EMOJI21] - 😔
- [EMOJI22] - 😬
- [EMOJI23] - 😘
- [EMOJI24] - 🥰
- [EMOJI25] - 🤦
- [EMOJI26] - 🙏
- [EMOJI27] - ❤️
- [EMOJI28] - 🍀
- [EMOJI29] - 🐶
- [EMOJI30] - 🐱
- [EMOJI31] - 🌹
- [EMOJI32] - 🐾
- [EMOJI33] - ⚠️
- [EMOJI34] - 🤝
- Emojis: Tags emoji serão substituídos pelo emoji correspondente no momento do disparo. Tags de emoji disponíveis:
- msg_date_sql - Data hora do envio da mensagem (no padrão mysql AAAA-MM-DD HH:MM:SS);
- Obs. 1: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 2: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Retorno:
{
"status": 1,
"msg": "Success",
"chat_id": "1234",
"msg_id": "3EB0737BBEAA8506A326"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha, 2-Processando;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- chat_id - ID único da mensagem na base de mensagens do Maxbot. É o ID real da mensagem no sistema Maxbot;
- msg_id - ID da mensagem da origem de envio até 100 caracteres (Quando for uma mensagem do WhatsApp, será o ID interno da mensagem no whatsapp);
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_chat_msg';
$_PROT_ID = '1234';
$_MSG = 'Teste envio de emojis [EMOJI1]';
$_MSG_DATE_SQL = '2024-12-18 23:39:43';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN.""<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID.""<br/>";
$_TXT .= " msg => ".$_MSG.""<br/>";
$_TXT .= " msg_date_sql => ".$_MSG_DATE_SQL.""<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"prot_id" => "$_PROT_ID",
"msg" => "$_MSG",
"msg_date_sql" => "$_MSG_DATE_SQL"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_chat_audio Requisita disparo de áudio.
Utilize a requisição de disparo de áudio no chat em atendimento.
Requisição JSON:
{
"token": "xxx",
"cmd": "send_chat_audio",
"prot_id": "1234",
"audio_base64": "data:audio/ogg;base64,T2dnUwACAAAAAAAAAACjLWkxAAAAAGmzCm4BE09wdXNI...",
"audio_ext": "ogg",
"msg_date_sql": "2024-12-18 23:39:43"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_chat_audio;
- prot_id - ID do protocolo (Utilize o open_followup para obter o prot_id).
- audio_base64 - Código do áudio em base64.
- audio_ext - Extensão do áudio.
- Extensões de áudios: ("mp3","ogg", "oga");
- msg_date_sql - Data hora do envio da mensagem (no padrão mysql AAAA-MM-DD HH:MM:SS);
- Obs. 1: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 2: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Retorno:
{
"status": 1,
"msg": "Success",
"chat_id": "1234",
"msg_id": "3EB0737BBEAA8506A326",
"audio_name": "audio",
"audio_size": "24.91K",
"audio_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/bfe9fae7c3b356332d97920c6a8a5895.ogg"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha, 2-Processando;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- chat_id - ID único da mensagem na base de mensagens do Maxbot. É o ID real da mensagem no sistema Maxbot;
- msg_id - ID da mensagem da origem de envio até 100 caracteres (Quando for uma mensagem do WhatsApp, será o ID interno da mensagem no whatsapp);
- audio_name - Nome do áudio (O padrão retornado é "audio");
- audio_size - Tamanho do áudio em kb;
- audio_url - Url do áudio;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_chat_audio';
$_PROT_ID = '1234';
$_AUDIO_BASE64 = 'data:audio/ogg;base64,T2dnUwACAAAAAAAAAACjLWkxAAAAAGmzCm4BE09wdXNI...';
$_AUDIO_EXT = 'ogg';
$_MSG_DATE_SQL = '2024-12-18 23:39:43';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN.""<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID.""<br/>";
$_TXT .= " audio_base64 => ".$_AUDIO_BASE64.""<br/>";
$_TXT .= " audio_ext => ".$_AUDIO_EXT.""<br/>";
$_TXT .= " msg_date_sql => ".$_MSG_DATE_SQL.""<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"prot_id" => "$_PROT_ID",
"audio_base64" => "$_AUDIO_BASE64",
"audio_ext" => "$_AUDIO_EXT",
"msg_date_sql" => "$_MSG_DATE_SQL"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_chat_annex Requisita disparo de anexo.
Utilize a requisição de disparo de anexo no chat atendimento.
Requisição JSON:
{
"token": "xxx",
"cmd": "send_chat_annex",
"prot_id": "1234",
"annex_name": "nome-do-anexo.xls",
"annex_base64": "data:@file/msexcel;base64,0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAOwADAP7/...",
"annex_ext": "xls",
"annex_type": "F",
"msg_date_sql": "2024-12-18 23:39:43"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_chat_annex;
- prot_id - ID do protocolo (Utilize o open_followup para obter o prot_id).
- annex_name - Nome original do anexo.
- annex_base64 - Código do anexo em base64.
- annex_ext - Extensão do anexo.
- Extensões de imagens: ("jpg", "jpeg", "png");
- Extensões de arquivos: ("pdf", "doc", "docx", "odt", "epub", "xls", "xlsx", "csv", "ppt", "pptx", "zip", "rar", "dwg", "ai", "cdr", "vcf", "txt", "xml", "rtf", "svg", "torrent", "gz", "psd", "eps", "ps");
- Extensões de áudios: ("mp3","ogg", "oga");
- annex_type - Tipo do anexo a ser enviado ( I - Imagem; A - Audio; F - Arquivo);
- msg_date_sql - Data hora do envio da mensagem (no padrão mysql AAAA-MM-DD HH:MM:SS);
- Obs. 1: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 2: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Retorno:
{
"status": 1,
"msg": "Success",
"chat_id": "1234",
"msg_id": "3EB0737BBEAA8506A326",
"annex_name": "nome-do-anexo.xls",
"annex_url": "https:\/\/app.maxbot.com.br\/anexos_docs\/86c3af39f3c7bb067f256fad52fe8812.xls"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha, 2-Processando;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- chat_id - ID único da mensagem na base de mensagens do Maxbot. É o ID real da mensagem no sistema Maxbot;
- msg_id - ID da mensagem da origem de envio até 100 caracteres (Quando for uma mensagem do WhatsApp, será o ID interno da mensagem no whatsapp);
- annex_name - Nome original do anexo;
- annex_url - Url do anexo;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_chat_annex';
$_PROT_ID = '1234';
$_ANNEX_NAME = 'nome-do-anexo.xls';
$_ANNEX_BASE64 = 'data:@file/msexcel;base64,0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAOwADAP7/...';
$_ANNEX_EXT = 'xls';
$_ANNEX_TYPE = 'F';
$_MSG_DATE_SQL = '2024-12-18 23:39:43';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN.""<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " prot_id => ".$_PROT_ID.""<br/>";
$_TXT .= " annex_name => ".$_ANNEX_NAME.""<br/>";
$_TXT .= " annex_base64 => ".$_ANNEX_BASE64.""<br/>";
$_TXT .= " annex_ext => ".$_ANNEX_EXT.""<br/>";
$_TXT .= " annex_type => ".$_ANNEX_TYPE.""<br/>";
$_TXT .= " msg_date_sql => ".$_MSG_DATE_SQL.""<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"prot_id" => "$_PROT_ID",
"annex_name" => "$_ANNEX_NAME",
"annex_base64" => "$_ANNEX_BASE64",
"annex_ext" => "$_ANNEX_EXT",
"annex_type" => "$_ANNEX_TYPE",
"msg_date_sql" => "$_MSG_DATE_SQL"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_text Requisita disparo de mensagem de texto
Utilize a requisição de disparo de mensagem de texto para enviar uma mensagem de texto para um contato existente no Maxbot. Você pode disparar mensagens para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato na seguinte ordem: Número de WhatsApp, ID Externo, CPF do padrão brasileiro;
- Ao encontrar o contato na base, carrega o número de WhatsApp existente na ficha do contato;
- Valida se a API está on-line e se a integração com o WhatsApp está ativa;
- Tudo validado, dispara a mensagem de texto para o contato;
- Obs. 1: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 2: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Requisição JSON:
{
"token" : "xxxx",
"cmd" : "send_text",
"channel_token" : "202304FE471FF7A477-5FA8BA-E72F90"
"ct_whatsapp" : "554111113333",
"ct_telegram_id" : "",
"ct_messenger" : "",
"messenger_page_id" : "",
"ct_instagram" : "",
"instagram_account_id" : "",
"ct_external_id" : "",
"ct_br_cpf" : "11122233344",
"msg" : "Mensagem de Texto"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_text
- channel_token - Informe o token do canal cadastrado no maxbot. Pode ser obtido através do endpoint get_channel.
- Obs.: Caso a channel_token não for informado e ct_whatsapp está preenchido, será utilizado o primeiro canal cadastrado no maxbot.
- ct_whatsapp - Número do WhatsApp do Contato existente na ficha de cadastro
- ct_telegram_id - ID Telegram do Contato existente na ficha de cadastro
- ct_messenger - FB Messenger do Contato existente na ficha de cadastro
- messenger_page_id - ID da página do Facebook
- ct_instagram - Instagram do Contato existente na ficha de cadastro
- instagram_account_id - ID da conta do Instagram
- ct_external_id - ID Externo do Contato existente na ficha de cadastro
- ct_br_cpf - Número de CPF do padrão brasileiro do Contato existente na ficha de cadastro
- msg - Texto da mensagem para disparo
- Emojis: Tags emoji serão substituídos pelo emoji correspondente no momento do disparo. Tags de emoji disponíveis:
- [EMOJI1] - 😃
- [EMOJI2] - 😁
- [EMOJI3] - 🤣
- [EMOJI4] - 😉
- [EMOJI5] - 😍
- [EMOJI6] - 🤩
- [EMOJI7] - 🤔
- [EMOJI8] - 😕
- [EMOJI9] - 👉
- [EMOJI10] - 👍
- [EMOJI11] - 😅
- [EMOJI12] - 🙂
- [EMOJI13] - 😱
- [EMOJI14] - 💥
- [EMOJI15] - ⏰
- [EMOJI16] - ⭐
- [EMOJI17] - 👏
- [EMOJI18] - 😎
- [EMOJI19] - 😉
- [EMOJI20] - 😊
- [EMOJI21] - 😔
- [EMOJI22] - 😬
- [EMOJI23] - 😘
- [EMOJI24] - 🥰
- [EMOJI25] - 🤦
- [EMOJI26] - 🙏
- [EMOJI27] - ❤️
- [EMOJI28] - 🍀
- [EMOJI29] - 🐶
- [EMOJI30] - 🐱
- [EMOJI31] - 🌹
- [EMOJI32] - 🐾
- [EMOJI33] - ⚠️
- [EMOJI34] - 🤝
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha, 2-Processando;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_text';
$_CHANNEL_TOKEN = '202304FE471FF7A477-5FA8BA-E72F90';
$_CT_WHATSAPP = '553196668586';
$_CT_TELEGRAM = '';
$_CT_MESSENGER = '';
$_MESSENGER_PAGE_ID = '';
$_CT_INSTAGRAM = '';
$_INSTAGRAM_ACCOUNT_ID = '';
$_CT_CPF = '03104925640';
$_CT_IDEXTERNO = '1234';
$_MSG = "teste de disparo 001!";//\nEmojis: [EMOJI1] [EMOJI2] [EMOJI3] [EMOJI4] [EMOJI5] [EMOJI6] [EMOJI7] [EMOJI8] [EMOJI9] [EMOJI10] ";
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel_token => ".$_CHANNEL_TOKEN."<br/>";
$_TXT .= " ct_whatsapp => ".$_CT_WHATSAPP."<br/>";
$_TXT .= " ct_telegram_id => ".$_CT_TELEGRAM."<br/>";
$_TXT .= " ct_messenger => ".$_CT_MESSENGER."<br/>";
$_TXT .= " messenger_page_id => ".$_MESSENGER_PAGE_ID."<br/>";
$_TXT .= " ct_instagram => ".$_CT_INSTAGRAM."<br/>";
$_TXT .= "instagram_account_id => ".$_INSTAGRAM_ACCOUNT_ID."<br/>";
$_TXT .= " ct_br_cpf => ".$_CT_CPF."<br/>";
$_TXT .= " ct_external_id => ".$_CT_IDEXTERNO."<br/>";
$_TXT .= " msg => ".$_MSG."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel_token" => "$_CHANNEL_TOKEN",
"ct_whatsapp" => "$_CT_WHATSAPP",
"ct_telegram_id" => "$_CT_TELEGRAM",
"ct_messenger" => "$_CT_MESSENGER",
"messenger_page_id" => "$_MESSENGER_PAGE_ID",
"ct_instagram" => "$_CT_INSTAGRAM",
"instagram_account_id" => "$_INSTAGRAM_ACCOUNT_ID",
"ct_br_cpf" => "$_CT_CPF",
"ct_external_id" => "$_CT_IDEXTERNO",
"msg" => "$_MSG"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_sms Requisita disparo de sms
Utilize a requisição de disparo de sms para enviar uma mensagem de texto via sms para um contato existente no Maxbot. Você pode disparar mensagens para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato na seguinte ordem: Número de Celular, ID Externo, CPF do padrão brasileiro;
- Ao encontrar o contato na base, carrega o número do Telefone existente na ficha do contato;
- Tudo validado, dispara sms para o contato;
Requisição JSON:
{
"token" : "xxxx",
"cmd" : "send_sms",
"cell_phone" : "5531991234567"
"ct_external_id" : "",
"ct_br_cpf" : "11122233344",
"msg" : "Mensagem do sms"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_sms
- cell_phone - Informe o Numero de Celular para o disparo da mensagem via sms.
- ct_external_id - ID Externo do Contato existente na ficha de cadastro
- ct_br_cpf - Número de CPF do padrão brasileiro do Contato existente na ficha de cadastro
- msg - Texto da mensagem para disparo
Retorno:
{
"status": 1,
"msg": "Success"
"msg_id": "SMS-123"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- msg_id - Retorna ID da mensagen enviada;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_sms';
$_CELL_PHONE = '5531123456789';
$_CT_CPF = '03104925640';
$_CT_IDEXTERNO = '1234';
$_MSG = "teste de disparo 001!";//\nEmojis: [EMOJI1] [EMOJI2] [EMOJI3] [EMOJI4] [EMOJI5] [EMOJI6] [EMOJI7] [EMOJI8] [EMOJI9] [EMOJI10] ";
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " cell_phone => ".$_CELL_PHONE."<br/>";
$_TXT .= " ct_br_cpf => ".$_CT_CPF."<br/>";
$_TXT .= " ct_external_id => ".$_CT_IDEXTERNO."<br/>";
$_TXT .= " msg => ".$_MSG."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"cell_phone" => "$_CELL_PHONE",
"ct_br_cpf" => "$_CT_CPF",
"ct_external_id" => "$_CT_IDEXTERNO",
"msg" => "$_MSG"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_email Requisita disparo de E-mail
Utilize a requisição de disparo de E-mail para enviar uma mensagem via E-mail para um contato existente no Maxbot. Você pode disparar mensagens para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato pelo E-mail;
- Ao encontrar o contato na base, carrega o E-mail existente na ficha do contato;
- Tudo validado, dispara E-mail para o contato;
Requisição JSON:
{
"token" : "xxxx",
"cmd" : "send_email",
"from_email" : "romulo@email.com",
"from_name" : "romulo",
"subject" : "email de teste",
"body" : "texto da mesangem do email",
"footer" : "",
"to_name" : "jose",
"to_email" : "jose@email.com",
"img_url_1" : "https://www.meusite.com.br/foto.png",
"img_extension_1" : "png",
"img_url_2" : "",
"img_extension_2" : "",
"img_url_3" : "",
"img_extension_3" : "",
"img_url_4" : "",
"img_extension_4" : "",
"img_url_5" : "",
"img_extension_5" : "",
"img_url_6" : "",
"img_extension_6" : "",
"file_url_1" : "https://www.meusite.com.br/arquivo.pdf",
"file_extension_1" : "pdf",
"file_url_2" : "",
"file_extension_2" : "",
"file_url_3" : "",
"file_extension_3" : ""
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_email
- from_email - E-mail do remetente.
- from_name - Nome do remetente.
- subject - Assunto da Mensagem de E-mail.
- body - Mensagem do E-mail.
- footer - Rodapé do E-mail.
- to_name - Nome do Destinátario.
- to_email - E-mail do Destinátario.
- img_url_1 - URL da imagem (1).
- img_extension_1 - Extenção da imagem (1).
- img_url_2 - URL da imagem (2).
- img_extension_2 - Extenção da imagem (2).
- img_url_3 - URL da imagem (3).
- img_extension_3 - Extenção da imagem (3).
- img_url_4 - URL da imagem (4).
- img_extension_4 - Extenção da imagem (4).
- img_url_5 - URL da imagem (5).
- img_extension_5 - Extenção da imagem (5).
- img_url_6 - URL da imagem (6).
- img_extension_6 - Extenção da imagem (6).
- file_url_1 - URL do arquivo (1).
- file_extension_1 - Extenção do arquivo (1).
- file_url_2 - URL do arquivo (2).
- file_extension_2 - Extenção do arquivo (2).
- file_url_3 - URL do arquivo (3).
- file_extension_3 - Extenção do arquivo (3).
Retorno:
{
"status": 1,
"msg": "Success"
"msg_id": "EMAIL-123"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
- msg_id - Retorna ID da mensagen enviada;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_email';
$_FROM_EMAIL = 'romulo@email.com';
$_FROM_NAME = 'romulo';
$_SUBJECT = 'e-mail de teste';
$_BODY = 'mensagem do e-mail';
$_FOOTER = '';
$_TO_NAME = 'jose';
$_TO_EMAIL = 'jose@email.com';
$_IMG_URL_1 = 'https://www.meusite.com.br/foto.png';
$_IMG_EXTENSION_1 = 'png';
$_IMG_URL_2 = '';
$_IMG_EXTENSION_2 = '';
$_IMG_URL_3 = '';
$_IMG_EXTENSION_3 = '';
$_IMG_URL_4 = '';
$_IMG_EXTENSION_4 = '';
$_IMG_URL_5 = '';
$_IMG_EXTENSION_5 = '';
$_IMG_URL_6 = '';
$_IMG_EXTENSION_6 = '';
$_FILE_URL_1 = 'https://www.meusite.com.br/arquivo.pdf';
$_FILE_EXTENSION_1 = 'pdf';
$_FILE_URL_2 = '';
$_FILE_EXTENSION_2 = '';
$_FILE_URL_3 = '';
$_FILE_EXTENSION_3 = '';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " from_email => ".$_FROM_EMAIL."<br/>";
$_TXT .= " from_name => ".$_FROM_NAME."<br/>";
$_TXT .= " subject => ".$_SUBJECT."<br/>";
$_TXT .= " body => ".$_BODY."<br/>";
$_TXT .= " footer => ".$_FOOTER."<br/>";
$_TXT .= " to_name => ".$_TO_NAME."<br/>";
$_TXT .= " to_email => ".$_TO_EMAIL."<br/>";
$_TXT .= " img_url_1 => ".$_IMG_URL_1."<br/>";
$_TXT .= " img_extension_1 => ".$_IMG_EXTENSION_1."<br/>";
$_TXT .= " img_url_2 => ".$_IMG_URL_2."<br/>";
$_TXT .= " img_extension_2 => ".$_IMG_EXTENSION_2."<br/>";
$_TXT .= " img_url_3 => ".$_IMG_URL_3."<br/>";
$_TXT .= " img_extension_3 => ".$_IMG_EXTENSION_3."<br/>";
$_TXT .= " img_url_4 => ".$_IMG_URL_4."<br/>";
$_TXT .= " img_extension_4 => ".$_IMG_EXTENSION_4."<br/>";
$_TXT .= " img_url_5 => ".$_IMG_URL_5."<br/>";
$_TXT .= " img_extension_5 => ".$_IMG_EXTENSION_5."<br/>";
$_TXT .= " img_url_6 => ".$_IMG_URL_6."<br/>";
$_TXT .= " img_extension_6 => ".$_IMG_EXTENSION_6."<br/>";
$_TXT .= " file_url_1 => ".$_FILE_URL_1."<br/>";
$_TXT .= " file_extension_1 => ".$_FILE_EXTENSION_1."<br/>";
$_TXT .= " file_url_2 => ".$_FILE_URL_2."<br/>";
$_TXT .= " file_extension_2 => ".$_FILE_EXTENSION_2."<br/>";
$_TXT .= " file_url_3 => ".$_FILE_URL_3."<br/>";
$_TXT .= " file_extension_3 => ".$_FILE_EXTENSION_3."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
from_email => "$_FROM_EMAIL",
from_name => "$_FROM_NAME",
subject => "$_SUBJECT",
body => "$_BODY",
footer => "$_FOOTER",
to_name => "$_TO_NAME",
to_email => "$_TO_EMAIL",
img_url_1 => "$_IMG_URL_1",
img_extension_1 => "$_IMG_EXTENSION_1",
img_url_2 => "$_IMG_URL_2",
img_extension_2 => "$_IMG_EXTENSION_2",
img_url_3 => "$_IMG_URL_3",
img_extension_3 => "$_IMG_EXTENSION_3",
img_url_4 => "$_IMG_URL_4",
img_extension_4 => "$_IMG_EXTENSION_4",
img_url_5 => "$_IMG_URL_5",
img_extension_5 => "$_IMG_EXTENSION_5",
img_url_6 => "$_IMG_URL_6",
img_extension_6 => "$_IMG_EXTENSION_6",
file_url_1 => "$_FILE_URL_1",
file_extension_1 => "$_FILE_EXTENSION_1",
file_url_2 => "$_FILE_URL_2",
file_extension_2 => "$_FILE_EXTENSION_2",
file_url_3 => "$_FILE_URL_3",
file_extension_3 => "$_FILE_EXTENSION_3"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_image Requisita disparo de imagem
Utilize a requisição de disparo de imagem para enviar uma imagem (jpg, jpeg ou png) para um contato existente no Maxbot. Você pode disparar imagens para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato na seguinte ordem: Número de WhatsApp, ID Externo, CPF do padrão brasileiro;
- Ao encontrar o contato na base, carrega o número de WhatsApp existente na ficha do contato;
- Valida se a API está on-line e se a integração com o WhatsApp está ativa;
- Tudo validado, dispara a imagem para o contato;
- Obs. 1: Imagens até 1mb serão disparadas normalmente. Imagens acima de 1mb serão disparadas como uma mensagem de texto com o link para download da imagem. O tamanho máximo permitido é de 5mb. Acima de 5mb não haverá disparo retornando falha no disparo;
- Obs. 2: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 3: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Requisição JSON:
{
"token": "xxxx",
"cmd": "send_image",
"channel_token" : "202304FE471FF7A477-5FA8BA-E72F90"
"ct_whatsapp": "553191112222",
"ct_telegram_id" : "",
"ct_messenger" : "",
"messenger_page_id" : "",
"ct_instagram" : "",
"instagram_account_id" : "",
"ct_external_id": "1234",
"ct_br_cpf": "11122233344",
"image_url": "https://www.meusite.com.br/foto.png",
"image_extension": "png"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_image
- channel_token - Informe o token do canal cadastrado no maxbot. Pode ser obtido através do endpoint get_channel.
- Obs.: Caso a channel_token não for informado e ct_whatsapp está preenchido, será utilizado o primeiro canal cadastrado no maxbot.
- ct_whatsapp - Número do WhatsApp do Contato existente na ficha de cadastro
- ct_telegram_id - ID Telegram do Contato existente na ficha de cadastro
- ct_messenger - FB Messenger do Contato existente na ficha de cadastro
- messenger_page_id - ID da página do Facebook
- ct_instagram - Instagram do Contato existente na ficha de cadastro
- instagram_account_id - ID da conta do Instagram
- ct_external_id - ID Externo do Contato existente na ficha de cadastro
- ct_br_cpf - Número de CPF do padrão brasileiro do Contato existente na ficha de cadastro
- img_url - URL da imagem que será disparada
- image_extension - Extensão da imagem que será disparada. (Extensões permitidas: jpg, jpeg ou png)
- Obs.: Tamanho máximo da imagem de 5mb. Abaixo de 1mb a imagem é disparada normalmente. Acima de 1mb será disparada uma mensagem de texto com o link para download da imagem;
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_image';
$_CHANNEL_TOKEN = '202304FE471FF7A477-5FA8BA-E72F90';
$_CT_WHATSAPP = '553196668586';
$_CT_TELEGRAM = '';
$_CT_MESSENGER = '';
$_MESSENGER_PAGE_ID = '';
$_CT_INSTAGRAM = '';
$_INSTAGRAM_ACCOUNT_ID = '';
$_CT_CPF = '03104925640';
$_CT_IDEXTERNO = '1234';
$_IMG_URL = 'https://www.meusite.com.br/foto.png';
$_IMG_EXT = 'png';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel_token => ".$_CHANNEL_TOKEN."<br/>";
$_TXT .= " ct_whatsapp => ".$_CT_WHATSAPP."<br/>";
$_TXT .= " ct_telegram_id => ".$_CT_TELEGRAM."<br/>";
$_TXT .= " ct_messenger => ".$_CT_MESSENGER."<br/>";
$_TXT .= " messenger_page_id => ".$_MESSENGER_PAGE_ID."<br/>";
$_TXT .= " ct_instagram => ".$_CT_INSTAGRAM."<br/>";
$_TXT .= "instagram_account_id => ".$_INSTAGRAM_ACCOUNT_ID."<br/>";
$_TXT .= " ct_br_cpf => ".$_CT_CPF."<br/>";
$_TXT .= " ct_external_id => ".$_CT_IDEXTERNO."<br/>";
$_TXT .= " image_url => ".$_IMG_URL."<br/>";
$_TXT .= " image_extension => ".$_IMG_EXT."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel_token" => "$_CHANNEL_TOKEN",
"ct_whatsapp" => "$_CT_WHATSAPP",
"ct_telegram_id" => "$_CT_TELEGRAM",
"ct_messenger" => "$_CT_MESSENGER",
"messenger_page_id" => "$_MESSENGER_PAGE_ID",
"ct_instagram" => "$_CT_INSTAGRAM",
"instagram_account_id" => "$_INSTAGRAM_ACCOUNT_ID",
"ct_br_cpf" => "$_CT_CPF",
"ct_external_id" => "$_CT_IDEXTERNO",
"image_url" => "$_IMG_URL",
"image_extension" => "$_IMG_EXT"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_file Requisita disparo de documento
Utilize a requisição de disparo de documento para enviar um documento (pdf, doc, docx, xls, xlsx, ppt, pptx ou pps) para um contato existente no Maxbot. Você pode disparar documentos para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato na seguinte ordem: Número de WhatsApp, ID Externo, CPF do padrão brasileiro;
- Ao encontrar o contato na base, carrega o número de WhatsApp existente na ficha do contato;
- Valida se a API está on-line e se a integração com o WhatsApp está ativa;
- Tudo validado, dispara o documento para o contato;
- Obs. 1: Documentos até 1mb serão disparados normalmente. Documentos acima de 1mb serão disparados como uma mensagem de texto com o link para download do documento. O tamanho máximo permitido é de 5mb. Acima de 5mb não haverá disparo retornando falha no disparo;
- Obs. 2: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 3: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Requisição JSON:
{
"token": "xxxx",
"cmd": "send_file",
"channel_token" : "202304FE471FF7A477-5FA8BA-E72F90"
"ct_whatsapp": "553191112222",
"ct_telegram_id" : "",
"ct_messenger" : "",
"messenger_page_id" : "",
"ct_instagram" : "",
"instagram_account_id" : "",
"ct_external_id": "1234",
"ct_br_cpf": "11122233344",
"file_url": "https://www.meusite.com.br/teste.pdf",
"file_extension": "pdf"
"file_name": "teste.pdf"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_file
- channel_token - Informe o token do canal cadastrado no maxbot. Pode ser obtido através do endpoint get_channel.
- Obs.: Caso a channel_token não for informado e ct_whatsapp está preenchido, será utilizado o primeiro canal cadastrado no maxbot.
- ct_whatsapp - Número do WhatsApp do Contato existente na ficha de cadastro
- ct_telegram_id - ID Telegram do Contato existente na ficha de cadastro
- ct_messenger - FB Messenger do Contato existente na ficha de cadastro
- messenger_page_id - ID da página do Facebook
- ct_instagram - Instagram do Contato existente na ficha de cadastro
- instagram_account_id - ID da conta do Instagram
- ct_external_id - ID Externo do Contato existente na ficha de cadastro
- ct_br_cpf - Número de CPF do padrão brasileiro do Contato existente na ficha de cadastro
- file_url - URL do documento que será disparado
- file_extension - Extensão do documento que será disparado. (Extensões permitidas: pdf, doc, docx, xls, xlsx, ppt, pptx e pps)
- file_name - Nome original do documento que será disparado.
- Obs.: Tamanho máximo do documento de 5mb. Abaixo de 1mb o documento é disparado normalmente. Acima de 1mb será disparada uma mensagem de texto com o link para download do documento;
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_file';
$_CHANNEL_TOKEN = '202304FE471FF7A477-5FA8BA-E72F90';
$_CT_WHATSAPP = '553196668586';
$_CT_TELEGRAM = '';
$_CT_MESSENGER = '';
$_MESSENGER_PAGE_ID = '';
$_CT_INSTAGRAM = '';
$_INSTAGRAM_ACCOUNT_ID = '';
$_CT_CPF = '03104925640';
$_CT_IDEXTERNO = '1234';
$_FILE_URL = 'https://www.meusite.com.br/teste.pdf';
$_FILE_EXT = 'pdf';
$_FILE_NAME = 'teste.pdf';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel_token => ".$_CHANNEL_TOKEN."<br/>";
$_TXT .= " ct_whatsapp => ".$_CT_WHATSAPP."<br/>";
$_TXT .= " ct_telegram_id => ".$_CT_TELEGRAM."<br/>";
$_TXT .= " ct_messenger => ".$_CT_MESSENGER."<br/>";
$_TXT .= " messenger_page_id => ".$_MESSENGER_PAGE_ID."<br/>";
$_TXT .= " ct_instagram => ".$_CT_INSTAGRAM."<br/>";
$_TXT .= "instagram_account_id => ".$_INSTAGRAM_ACCOUNT_ID."<br/>";
$_TXT .= " ct_br_cpf => ".$_CT_CPF."<br/>";
$_TXT .= " ct_external_id => ".$_CT_IDEXTERNO."<br/>";
$_TXT .= " file_url => ".$_FILE_URL."<br/>";
$_TXT .= " file_extension => ".$_FILE_EXT."<br/>";
$_TXT .= " file_name => ".$_FILE_NAME."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel_token" => "$_CHANNEL_TOKEN",
"ct_whatsapp" => "$_CT_WHATSAPP",
"ct_telegram_id" => "$_CT_TELEGRAM",
"ct_messenger" => "$_CT_MESSENGER",
"messenger_page_id" => "$_MESSENGER_PAGE_ID",
"ct_instagram" => "$_CT_INSTAGRAM",
"instagram_account_id" => "$_INSTAGRAM_ACCOUNT_ID",
"ct_br_cpf" => "$_CT_CPF",
"ct_external_id" => "$_CT_IDEXTERNO",
"file_url" => "$_FILE_URL",
"file_extension" => "$_FILE_EXT"
"file_name" => "$_FILE_NAME"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
send_sound Requisita disparo de áudio
Utilize a requisição de disparo de áudio para enviar um arquivo de áudio MP3 para um contato existente no Maxbot. Você pode disparar áudios para qualquer contato previamente existente na sua base de contatos. O disparo é feito conforme as seguintes condições:
- A API tenta localizar o contato na seguinte ordem: Número de WhatsApp, ID Externo, CPF do padrão brasileiro;
- Ao encontrar o contato na base, carrega o número de WhatsApp existente na ficha do contato;
- Valida se a API está on-line e se a integração com o WhatsApp está ativa;
- Tudo validado, dispara o áudio para o contato;
- Obs. 1: Contatos com Sessão de 24 Horas Fechada! Só é possível o envio de templates WABA. Nova sessão de comunicação de 24 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes WABA);
- Obs. 2: Contatos com Sessão de 168 Horas Fechada! Nova sessão de comunicação de 168 horas será restaurada assim que o contato enviar uma mensagem (Apenas para Clientes FACEBOOK MESSENGER E INSTAGRAM);
Requisição JSON:
{
"token": "xxxx",
"cmd": "send_sound",
"channel_token" : "202304FE471FF7A477-5FA8BA-E72F90"
"ct_whatsapp": "553191112222",
"ct_telegram_id" : "",
"ct_messenger" : "",
"messenger_page_id" : "",
"ct_instagram" : "",
"instagram_account_id" : "",
"ct_external_id": "1234",
"ct_br_cpf": "11122233344",
"sound_url": "https://www.meusite.com.br/audio.mp3",
"sound_extension": "mp3"
}
- token - Informe o token de identificação de conta apresentado na plataforma Maxbot em Configurações/API Maxbot;
- cmd - Comando a ser executado: send_sound
- channel_token - Informe o token do canal cadastrado no maxbot. Pode ser obtido através do endpoint get_channel.
- Obs.: Caso a channel_token não for informado e ct_whatsapp está preenchido, será utilizado o primeiro canal cadastrado no maxbot.
- ct_whatsapp - Número do WhatsApp do Contato existente na ficha de cadastro
- ct_telegram_id - ID Telegram do Contato existente na ficha de cadastro
- ct_messenger - FB Messenger do Contato existente na ficha de cadastro
- messenger_page_id - ID da página do Facebook
- ct_instagram - Instagram do Contato existente na ficha de cadastro
- instagram_account_id - ID da conta do Instagram
- ct_external_id - ID Externo do Contato existente na ficha de cadastro
- ct_br_cpf - Número de CPF do padrão brasileiro do Contato existente na ficha de cadastro
- sound_url - URL do arquivo MP3 que será disparado
- sound_extension - Extensão do documento que será disparado. Será sempre mp3
Retorno:
{
"status": 1,
"msg": "Success"
}
- status - Situação do processamento: 1-Sucesso, 0-Falha;
- msg - Retorna mensagem de contexto do processamento. Se execução bem sucedida, retorna Success. Se houver falha, retorna informação referente à falha ocorrida;
Exemplo Funcional:
Este exemplo funcional em PHP 7.3 executa um post para a API e apresenta o retorno na tela para validação. Modifique o código para se adequar às suas necessidades. Para outras linguagens, adapte o código de acordo.
<?php
header('Content-Type: text/html; charset=utf-8');
# Parametros
$_TOKEN = 'xxxxxx';
$_CMD = 'send_sound';
$_CHANNEL_TOKEN = '202304FE471FF7A477-5FA8BA-E72F90';
$_CT_WHATSAPP = '553196668586';
$_CT_TELEGRAM = '';
$_CT_MESSENGER = '';
$_MESSENGER_PAGE_ID = '';
$_CT_INSTAGRAM = '';
$_INSTAGRAM_ACCOUNT_ID = '';
$_CT_CPF = '03104925640';
$_CT_IDEXTERNO = '1234';
$_SOUND_URL = 'https://www.meusite.com.br/audio.mp3';
$_SOUND_EXT = 'mp3';
# URL
$_URL = 'https://app.maxbot.com.br/api/v1.php';
# START
$_TXT = "[POST]:<br/><br/>";
$_TXT .= " API_URL => ".$_URL."<br/>";
$_TXT .= " token => ".$_TOKEN."<br/>";
$_TXT .= " cmd => ".$_CMD."<br/>";
$_TXT .= " channel_token => ".$_CHANNEL_TOKEN."<br/>";
$_TXT .= " ct_whatsapp => ".$_CT_WHATSAPP."<br/>";
$_TXT .= " ct_telegram_id => ".$_CT_TELEGRAM."<br/>";
$_TXT .= " ct_messenger => ".$_CT_MESSENGER."<br/>";
$_TXT .= " messenger_page_id => ".$_MESSENGER_PAGE_ID."<br/>";
$_TXT .= " ct_instagram => ".$_CT_INSTAGRAM."<br/>";
$_TXT .= "instagram_account_id => ".$_INSTAGRAM_ACCOUNT_ID."<br/>";
$_TXT .= " ct_br_cpf => ".$_CT_CPF."<br/>";
$_TXT .= " ct_external_id => ".$_CT_IDEXTERNO."<br/>";
$_TXT .= " sound_url => ".$_SOUND_URL."<br/>";
$_TXT .= " sound_extension => ".$_SOUND_EXT."<br/>";
$_TXT .= "<br/>";
$_TXT .= "[retorno]:<br/><br/>";
$_TXT .= "<textarea rows=10 cols=90>";
echo $_TXT;
# Request API
$_REQUEST = array(
"token" => "$_TOKEN",
"cmd" => "$_CMD",
"channel_token" => "$_CHANNEL_TOKEN",
"ct_whatsapp" => "$_CT_WHATSAPP",
"ct_telegram_id" => "$_CT_TELEGRAM",
"ct_messenger" => "$_CT_MESSENGER",
"messenger_page_id" => "$_MESSENGER_PAGE_ID",
"ct_instagram" => "$_CT_INSTAGRAM",
"instagram_account_id" => "$_INSTAGRAM_ACCOUNT_ID",
"ct_br_cpf" => "$_CT_CPF",
"ct_external_id" => "$_CT_IDEXTERNO",
"sound_url" => "$_SOUND_URL",
"sound_extension" => "$_SOUND_EXT"
);
$json = json_encode($_REQUEST);
$ch = curl_init($_URL);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($json))
);
$_result = curl_exec($ch);
curl_close($ch);
echo $_result;
echo "</textarea>";
exit;
?>
Ativação Webhooks
Ativação
Para ativar um webhook faça o login em sua conta Maxbot e vá para Configuração/API Maxbot e Webhooks. Após inserir a URL clique no ícone de salvar .
Requisitos Webhooks
- O solicitante configura na plataforma uma URL para recebimento dos dados;
- Retorno no método POST, enviando dados no formato JSON;;
Métodos Webhooks
- Mensagem Recebida Webhook para recebimento de mensagens recebidas;
- Mensagem Recebida em Atendimento Webhook para recebimento de mensagens de protocolos em atendimento;
- Novo Contato Webhook para recebimento de novo contato;
- Contato Atualizado Webhook para recebimento de contato atualizado;
- Charge Webhook da situação de cada envio da cobrança;
Exemplos de Retorno Webhooks
Mensagem Recebida Retorno do Webhook de recebimento de mensagens recebidas
Webhook Mensagem Recebida retorna o recebimento de mensagens recebidas no formato JSON para o webhook configurado no Maxbot.
Retorno:
{
"origin": "2",
"contact": {
"id": "1",
"created_at": "2022-01-25 13:52:15",
"updated_at": "",
"segmentation": "",
"tag": "",
"name": "Fulano",
"surname": "Mariano",
"gender": "",
"birth": "",
"age": "",
"br_person_type": "F",
"br_cpf": "",
"br_cnpj": "",
"company": "",
"email": "",
"whatsapp": "5531911112222",
"mobile_phone": "",
"phone": "",
"country": "BR",
"state": "MG",
"city": "",
"profession": "",
"external_id": "",
"avatar_url": "https:\/\/app.maxbot.com.br\/strg\/01\/HMG-202104-E1B4E2\/2022\/04\/13\/8ca7a22e5fe3c6bb72d8d1d14e8784fe_small.jpg",
"obs": "",
"in_attendance": "",
"current_protocol": "",
"current_attendant": ""
},
"msg_id": "3EB04714F09C9DE532E2",
"msg_timestamp": "1643129533",
"msg_date": "2022-01-25 13:52:15",
"msg": "Teste webhook 2",
"type": "T",
"img_info": "",
"img_size": "",
"img_filename": "",
"img_local_filename": "",
"img_extension": "",
"audio_info": "",
"audio_size": "",
"audio_filename": "",
"audio_local_filename": "",
"audio_extension": "",
"arq_info": "",
"arq_size": "",
"arq_filename": "",
"arq_local_filename": "",
"arq_extension": "",
"vid_info": "",
"vid_size": "",
"vid_filename": "",
"vid_local_filename": "",
"vid_extension": "",
"vcard": "",
"map_lat": "",
"map_lng": "",
"map_img": "",
"map_location_url": "",
"referral": "",
"quoted_id ": "",
"quoted_type": "",
"quoted_msg": "",
"quoted_img_info": "",
"quoted_img_size": "",
"quoted_img_filename": "",
"quoted_img_local_filename": "",
"quoted_img_extension": "",
"quoted_audio_info": "",
"quoted_audio_size": "",
"quoted_audio_filename": "",
"quoted_audio_local_filename": "",
"quoted_audio_extension": "",
"quoted_arq_info": "",
"quoted_arq_size": "",
"quoted_arq_filename": "",
"quoted_arq_local_filename": "",
"quoted_arq_extension": "",
"quoted_vid_info": "",
"quoted_vid_size": "",
"quoted_vid_filename": "",
"quoted_vid_local_filename": "",
"quoted_vid_extension": "",
"quoted_vcard": "",
"quoted_map_lat": "",
"quoted_map_lng": "",
"quoted_map_location_url": "",
"quoted_map_img": ""
}
- origin - Origem do contato (0-Chat Web, 1-MaxChat (App), 2-WhatsApp, 3-WhatsApp Oficial, 4-Telegram, 5-Facebook Messenger, 6-Instagram).
- contact - Dados do Contato em JSON;
- id - ID do contato;
- created_at - Data de Cadastro;
- updated_at - Data da Última atualização;
- segmentation - Lista de Segmentação;
- tag - Tag de atendimento exibido na fila de espera do atendimento;
- name - Nome;
- surname - Sobrenome;
- gender - Sexo (M-Masculino ou F-Feminino);
- birth - Data de Nascimento;
- age - Idade;
- br_person_type - Tipo de Pessoa do padrão brasileiro (F-Física ou J-Jurídica);
- br_cpf - Número do CPF do padrão brasileiro;
- br_cnpj - Número do CNPJ do padrão brasileiro;
- company - Razão Social da Empresa;
- email - Email do contato;
- whatsapp - Número do WhatsApp;
- mobile_phone - Número do Celular;
- phone - Número do Telefone Fixo;
- country - País (padrão ISO com sigla de 2 caracteres. Ex.: BR, US, PT, FR, etc);
- state - Estado (padrão ISO com sigla de 2 caracteres. Ex.: MG, SP, RJ, DF, etc);
- city - Nome da Cidade;
- profession - Nome da profissão indicada no cadastro;
- external_id - ID Externo para cruzamento com sistemas externos como RPs, CRMs ou softwares de gestão da empresa;
- avatar_url - Link do avatar do contato;
- obs - Texto do campo de observação da ficha de cadastro do contato;
- in_attendance - Indica se o contato está sendo atendido no momento (0-Não, 1-Sim);
- current_protocol - Número do protocolo em atendimento;
- current_attendant - Nome do atendente em atendimento;
- msg_id - ID da mensagem da origem de envio até 100 caracteres (Quando for uma mensagem do WhatsApp, será o ID interno da mensagem no whatsapp, quando for Telegram, será o ID interno da mensagem no telegram e assim por diante);
- msg_timestamp - Timestamp da mensagem;
- msg_date - Data da mensagem no formato AAAA-MM-DD HH:MM:SS.
- msg - Texto da mensagem;
- type - Tipo de mensagem (T-Texto, I-Imagem, A-Áudio, F-Arquivo, L-Localização, V-Vídeo, C-VCard de Contato);
- img_info - Nome original da imagem no momento do upload ou como foi recebido da origem (Ex.: foto_do_meu_pc.jpg);
- img_filename - Nome do arquivo de imagem armazenado no Maxbot;
- img_size - Tamanho da imagem em kb;
- img_local_filename - URL do arquivo de imagem armazenado no Maxbot;
- img_extension - Extensão do arquivo de imagem;
- audio_info - Nome original do áudio no momento do upload ou como foi recebido da origem (Ex.: audio001.mp3);
- audio_filename - Nome do arquivo de áudio armazenado no Maxbot;
- audio_size - Tamanho do áudio em kb;
- audio_local_filename - URL do arquivo de áudio armazenado no Maxbot;
- audio_extension - Extensão do arquivo de áudio;
- arq_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: orcamento.pdf);
- arq_filename - Nome do arquivo armazenado no Maxbot;
- arq_size - Tamanho do arquivo em kb;
- arq_local_filename - URL do arquivo armazenado no Maxbot;
- arq_extension - Extensão do arquivo;
- vid_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: video.mp4);
- vid_filename - Nome do arquivo de vídeo armazenado no Maxbot;
- vid_size - Tamanho do vídeo em kb;
- vid_local_filename - URL do arquivo de vídeo armazenado no Maxbot;
- vid_extension - Extensão do vídeo;
- vcard - Dados do contato para criação de contato (Nome|Sobrenome|Email|WhatsApp|Celular|)(Ex.: Rodrigo|Gomide|rodrigo@maxbot.com.br|553111112222|553111112222|); (Obs.: ainda não implementado no Maxbot);
- map_lat - Latitude de localização;
- map_lng - Longitude de localização;
- map_img - Imagem de localização;
- map_location_url - URL da localização que redireciona para o google maps;
- referral - Incluído em notificações quando um usuário clica em um anúncio que se conecta com o WhatsApp e envia uma mensagem ao negócio. Este objeto leva a informação do anúncio. (Obs.: Tipo do conteúdo em JSON);
- headline - Cabeçalho usado no anúncio que gerou a mensagem.;
- body - Corpo do anúncio que gerou a mensagem.;
- source_type - O tipo da origem do anúncio. Os valores compatíveis no momento são ad e post.;
- source_id - ID do Facebook de anúncio ou post.;
- source_url - O URL que leva ao anúncio. Ao abrir este URL, você vai para o anúncio visto pelo usuário.;
- image - ID de imagem que o usuário viu e clicou.;
Quando um contato comentar em cima de uma mensagem, os dados referentes à mensagem comentada serão recebidas nos campos quoted correspondente:
- quoted_id - ID da mensagem até 100 caracteres;
- quoted_type - Tipo de mensagem (T-Texto, I-Imagem, A-Áudio, F-Arquivo, L-Localização, V-Vídeo, C-VCard de Contato);
- quoted_msg - Texto da mensagem;
- quoted_img_info - Nome original da imagem no momento do upload ou como foi recebido da origem (Ex.: foto_do_meu_pc.jpg);
- quoted_img_filename - Nome do arquivo de imagem armazenado no Maxbot;
- quoted_img_size - Tamanho da imagem em kb;
- quoted_img_local_filename - URL do arquivo de imagem armazenado no Maxbot;
- quoted_img_extension - Extensão do arquivo de imagem;
- quoted_audio_info - Nome original do áudio no momento do upload ou como foi recebido da origem (Ex.: audio001.mp3);
- quoted_audio_filename - Nome do arquivo de áudio armazenado no Maxbot;
- quoted_audio_size - Tamanho do áudio em kb;
- quoted_audio_local_filename - URL do arquivo de áudio armazenado no Maxbot;
- quoted_audio_extension - Extensão do arquivo de áudio;
- quoted_arq_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: orcamento.pdf);
- quoted_arq_filename - Nome do arquivo armazenado no Maxbot;
- quoted_arq_size - Tamanho do arquivo em kb;
- quoted_arq_local_filename - URL do arquivo armazenado no Maxbot;
- quoted_arq_extension - Extensão do arquivo;
- quoted_vid_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: video.mp4);
- quoted_vid_filename - Nome do arquivo de vídeo armazenado no Maxbot;
- quoted_vid_size - Tamanho do vídeo em kb;
- quoted_vid_local_filename - URL do arquivo de vídeo armazenado no Maxbot;
- quoted_vid_extension - Extensão do vídeo;
- quoted_vcard - Dados do contato (Nome|Sobrenome|Email|WhatsApp|Celular|)(Ex.: Rodrigo|Gomide|rodrigo@maxbot.com.br|553111112222|553111112222|); (Obs.: ainda não implementado no Maxbot);
- quoted_map_lat - Latitude de localização;
- quoted_map_lat - Longitude de localização;
- quoted_map_location_url - URL da localização que redireciona para o google maps;
- quoted_map_img - Imagem de localização;
Mensagem Recebida em Atendimento Retorno do Webhook de recebimento de mensagens de protocolos em atendimento
Webhook Mensagem Recebida em Atendimento retorna o recebimento de mensagens de protocolos em atendimento no formato JSON para o webhook configurado no Maxbot.
Retorno:
{
"origin": "2",
"whatsapp": "553111112222",
"prot_id": "2398",
"contact_id": "845",
"avatar_url": "https://site.com/imagem.jpg",
"chat_id": "19273",
"msg_id": "3EB04714F09C9DE532E2",
"msg_timestamp": "1643129533",
"msg_date": "2022-01-25 13:52:15",
"msg": "Teste webhook 2",
"type": "T",
"img_info": "",
"img_size": "",
"img_filename": "",
"img_local_filename": "",
"img_extension": "",
"audio_info": "",
"audio_size": "",
"audio_filename": "",
"audio_local_filename": "",
"audio_extension": "",
"arq_info": "",
"arq_size": "",
"arq_filename": "",
"arq_local_filename": "",
"arq_extension": "",
"vid_info": "",
"vid_size": "",
"vid_filename": "",
"vid_local_filename": "",
"vid_extension": "",
"vcard": "",
"map_lat": "",
"map_lng": "",
"map_img": "",
"map_location_url": "",
"referral": "",
"quoted_id ": "",
"quoted_type": "",
"quoted_msg": "",
"quoted_img_info": "",
"quoted_img_size": "",
"quoted_img_filename": "",
"quoted_img_local_filename": "",
"quoted_img_extension": "",
"quoted_audio_info": "",
"quoted_audio_size": "",
"quoted_audio_filename": "",
"quoted_audio_local_filename": "",
"quoted_audio_extension": "",
"quoted_arq_info": "",
"quoted_arq_size": "",
"quoted_arq_filename": "",
"quoted_arq_local_filename": "",
"quoted_arq_extension": "",
"quoted_vid_info": "",
"quoted_vid_size": "",
"quoted_vid_filename": "",
"quoted_vid_local_filename": "",
"quoted_vid_extension": "",
"quoted_vcard": "",
"quoted_map_lat": "",
"quoted_map_lng": "",
"quoted_map_location_url": "",
"quoted_map_img": ""
}
- origin - Origem do contato (0-Chat Web, 1-MaxChat (App), 2-WhatsApp, 3-WhatsApp Oficial, 4-Telegram, 5-Facebook Messenger, 6-Instagram).
- whatsapp - WhatApp do contato;
- prot_id - ID do protocolo;
- contact_id - ID do contato;
- avatar_url - Link do avatar do contato;
- chat_id - ID único da mensagem na base de mensagens do Maxbot. É o ID real da mensagem no sistema Maxbot;
- msg_id - ID da mensagem da origem de envio até 100 caracteres (Quando for uma mensagem do WhatsApp, será o ID interno da mensagem no whatsapp, quando for Telegram, será o ID interno da mensagem no telegram e assim por diante);
- msg_timestamp - Timestamp da mensagem;
- msg_date - Data da mensagem no formato AAAA-MM-DD HH:MM:SS.
- msg - Texto da mensagem;
- type - Tipo de mensagem (T-Texto, I-Imagem, A-Áudio, F-Arquivo, L-Localização, V-Vídeo, C-VCard de Contato);
- img_info - Nome original da imagem no momento do upload ou como foi recebido da origem (Ex.: foto_do_meu_pc.jpg);
- img_filename - Nome do arquivo de imagem armazenado no Maxbot;
- img_size - Tamanho da imagem em kb;
- img_local_filename - URL do arquivo de imagem armazenado no Maxbot;
- img_extension - Extensão do arquivo de imagem;
- audio_info - Nome original do áudio no momento do upload ou como foi recebido da origem (Ex.: audio001.mp3);
- audio_filename - Nome do arquivo de áudio armazenado no Maxbot;
- audio_size - Tamanho do áudio em kb;
- audio_local_filename - URL do arquivo de áudio armazenado no Maxbot;
- audio_extension - Extensão do arquivo de áudio;
- arq_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: orcamento.pdf);
- arq_filename - Nome do arquivo armazenado no Maxbot;
- arq_size - Tamanho do arquivo em kb;
- arq_local_filename - URL do arquivo armazenado no Maxbot;
- arq_extension - Extensão do arquivo;
- vid_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: video.mp4);
- vid_filename - Nome do arquivo de vídeo armazenado no Maxbot;
- vid_size - Tamanho do vídeo em kb;
- vid_local_filename - URL do arquivo de vídeo armazenado no Maxbot;
- vid_extension - Extensão do vídeo;
- vcard - Dados do contato para criação de contato (Nome|Sobrenome|Email|WhatsApp|Celular|)(Ex.: Rodrigo|Gomide|rodrigo@maxbot.com.br|553111112222|553111112222|); (Obs.: ainda não implementado no Maxbot);
- map_lat - Latitude de localização;
- map_lng - Longitude de localização;
- map_img - Imagem de localização;
- map_location_url - URL da localização que redireciona para o google maps;
- referral - Incluído em notificações quando um usuário clica em um anúncio que se conecta com o WhatsApp e envia uma mensagem ao negócio. Este objeto leva a informação do anúncio. (Obs.: Tipo do conteúdo em JSON);
- headline - Cabeçalho usado no anúncio que gerou a mensagem.;
- body - Corpo do anúncio que gerou a mensagem.;
- source_type - O tipo da origem do anúncio. Os valores compatíveis no momento são ad e post.;
- source_id - ID do Facebook de anúncio ou post.;
- source_url - O URL que leva ao anúncio. Ao abrir este URL, você vai para o anúncio visto pelo usuário.;
- image - ID de imagem que o usuário viu e clicou.;
Quando um contato comentar em cima de uma mensagem, os dados referentes à mensagem comentada serão recebidas nos campos quoted correspondente:
- quoted_id - ID da mensagem até 100 caracteres;
- quoted_type - Tipo de mensagem (T-Texto, I-Imagem, A-Áudio, F-Arquivo, L-Localização, V-Vídeo, C-VCard de Contato);
- quoted_msg - Texto da mensagem;
- quoted_img_info - Nome original da imagem no momento do upload ou como foi recebido da origem (Ex.: foto_do_meu_pc.jpg);
- quoted_img_filename - Nome do arquivo de imagem armazenado no Maxbot;
- quoted_img_size - Tamanho da imagem em kb;
- quoted_img_local_filename - URL do arquivo de imagem armazenado no Maxbot;
- quoted_img_extension - Extensão do arquivo de imagem;
- quoted_audio_info - Nome original do áudio no momento do upload ou como foi recebido da origem (Ex.: audio001.mp3);
- quoted_audio_filename - Nome do arquivo de áudio armazenado no Maxbot;
- quoted_audio_size - Tamanho do áudio em kb;
- quoted_audio_local_filename - URL do arquivo de áudio armazenado no Maxbot;
- quoted_audio_extension - Extensão do arquivo de áudio;
- quoted_arq_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: orcamento.pdf);
- quoted_arq_filename - Nome do arquivo armazenado no Maxbot;
- quoted_arq_size - Tamanho do arquivo em kb;
- quoted_arq_local_filename - URL do arquivo armazenado no Maxbot;
- quoted_arq_extension - Extensão do arquivo;
- quoted_vid_info - Nome original do arquivo no momento do upload ou como foi recebido da origem (Ex.: video.mp4);
- quoted_vid_filename - Nome do arquivo de vídeo armazenado no Maxbot;
- quoted_vid_size - Tamanho do vídeo em kb;
- quoted_vid_local_filename - URL do arquivo de vídeo armazenado no Maxbot;
- quoted_vid_extension - Extensão do vídeo;
- quoted_vcard - Dados do contato (Nome|Sobrenome|Email|WhatsApp|Celular|)(Ex.: Rodrigo|Gomide|rodrigo@maxbot.com.br|553111112222|553111112222|); (Obs.: ainda não implementado no Maxbot);
- quoted_map_lat - Latitude de localização;
- quoted_map_lat - Longitude de localização;
- quoted_map_location_url - URL da localização que redireciona para o google maps;
- quoted_map_img - Imagem de localização;
Novo Contato Retorno do Webhook de recebimento de novo contato
Novo Contato retorna o recebimento de novo contato no formato JSON para o webhook configurado no Maxbot.
Retorno:
{
"id": "1",
"type_event": "insert",
"created_at": "2022-04-13 12:49:14",
"updated_at": "",
"segmentation": ["Equipe Maxbot"],
"tag": "",
"tag2": "",
"name": "Fulano",
"surname": "Mariano",
"gender": "",
"birth": "",
"age": "",
"br_person_type": "F",
"br_cpf": "",
"br_cnpj": "",
"company": "",
"email": "",
"maxbot_username": "",
"whatsapp": "5531911112222",
"mobile_phone": "",
"telegram_id": "",
"telegram_username": "",
"fbmessenger_id": "",
"fbmessenger_username": "",
"instagram_id": "",
"instagram_username": "",
"phone": "",
"country": "BR",
"state": "MG",
"city": "",
"profession": "",
"ind_client": "0",
"client_code": "",
"external_id": "",
"avatar_url": "https:\/\/app.maxbot.com.br\/strg\/01\/HMG-202104-E1B4E2\/2022\/04\/13\/ 8ca7a22e5fe3c6bb72d8d1d14e8784fe_small.jpg",
"obs": "",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": "",
"in_attendance": "",
"current_protocol": "",
"current_attendant": ""
}
- id - ID do contato;
- type_event - Tipo do Evento Webhook;
- created_at - Data de Cadastro;
- updated_at - Data da Última atualização;
- segmentation - Lista de Segmentação;
- tag - Tag de atendimento exibido na fila de espera do atendimento;
- tag2 - Tag de atendimento exibido na fila de espera do atendimento;
- name - Nome;
- surname - Sobrenome;
- gender - Sexo (M-Masculino ou F-Feminino);
- birth - Data de Nascimento;
- age - Idade;
- br_person_type - Tipo de Pessoa do padrão brasileiro (F-Física ou J-Jurídica);
- br_cpf - Número do CPF do padrão brasileiro;
- br_cnpj - Número do CNPJ do padrão brasileiro;
- company - Razão Social da Empresa;
- email - Email do contato;
- maxbot_username - Nome do usuário Maxchat no Maxbot;
- whatsapp - Número do WhatsApp;
- mobile_phone - Número do Celular;
- telegram_id - ID do contato no Telegram (Em Breve);
- telegram_username - Nome de usuário do contato no Telegram (Em Breve);
- fbmessenger_id - ID do contato no Facebook Messenger (Em Breve);
- telegram_username - Nome de usuário do contato no Facebook Messenger (Em Breve);
- instagram_id - ID do contato no Instagram (Em Breve);
- instagram_username - Nome de usuário do contato no Instagram (Em Breve);
- phone - Número do Telefone Fixo;
- country - País (padrão ISO com sigla de 2 caracteres. Ex.: BR, US, PT, FR, etc);
- state - Estado (padrão ISO com sigla de 2 caracteres. Ex.: MG, SP, RJ, DF, etc);
- city - Nome da Cidade;
- profession - Nome da profissão indicada no cadastro;
- external_id - ID Externo para cruzamento com sistemas externos como RPs, CRMs ou softwares de gestão da empresa;
- ind_client - Indicador se o contato já é um Cliente da empresa (0-Não, 1-Sim);
- client_code - Código do Cliente usado no sistema interno da empresa;
- avatar_url - Link do avatar do contato;
- obs - Texto do campo de observação da ficha de cadastro do contato;
- Tags INFO - Os campos de [INFO1], [INFO2], [INFO3], [INFO4], [INFO5] e [INFO6] é utilizado para entrada de texto livre a ser utilizado no disparo de templates. Permite texto livre, incluíndo EMOJIS, até 1.000 caracteres;
- tag_info1 - Tag Info 1, [INFO1];
- tag_info2 - Tag Info 2, [INFO2];
- tag_info3 - Tag Info 3, [INFO3];
- tag_info4 - Tag Info 4, [INFO4];
- tag_info5 - Tag Info 5, [INFO5];
- tag_info6 - Tag Info 6, [INFO6];
- Obs.: As Tags devem ser cadastradas no contato e no template para serem substituídas no envio de template.
- in_attendance - Indica se o contato está sendo atendido no momento (0-Não, 1-Sim);
- current_protocol - Número do protocolo em atendimento;
- current_attendant - Nome do atendente em atendimento;
Contato Atualizado Retorno do Webhook de recebimento de contato atualizado
Contato Atualizado retorna o recebimento de contato atualizado no formato JSON para o webhook configurado no Maxbot.
Retorno:
{
"id": "1",
"type_event": "update",
"created_at": "2022-04-13 12:49:14",
"updated_at": "",
"segmentation": ["Equipe Maxbot"],
"tag": "",
"tag2": "",
"name": "Fulano",
"surname": "Mariano",
"gender": "",
"birth": "",
"age": "",
"br_person_type": "F",
"br_cpf": "",
"br_cnpj": "",
"company": "",
"email": "",
"maxbot_username": "",
"whatsapp": "5531911112222",
"mobile_phone": "",
"telegram_id": "",
"telegram_username": "",
"fbmessenger_id": "",
"fbmessenger_username": "",
"instagram_id": "",
"instagram_username": "",
"phone": "",
"country": "BR",
"state": "MG",
"city": "",
"profession": "",
"ind_client": "0",
"client_code": "",
"external_id": "",
"avatar_url": "https:\/\/app.maxbot.com.br\/strg\/01\/HMG-202104-E1B4E2\/2022\/04\/13\/ 8ca7a22e5fe3c6bb72d8d1d14e8784fe_small.jpg",
"obs": "",
"tag_info1": "",
"tag_info2": "",
"tag_info3": "",
"tag_info4": "",
"tag_info5": "",
"tag_info6": "",
"in_attendance": "",
"current_protocol": "",
"current_attendant": ""
}
- id - ID do contato;
- type_event - Tipo do Evento Webhook;
- created_at - Data de Cadastro;
- updated_at - Data da Última atualização;
- segmentation - Lista de Segmentação;
- tag - Tag de atendimento exibido na fila de espera do atendimento;
- tag2 - Tag de atendimento exibido na fila de espera do atendimento;
- name - Nome;
- surname - Sobrenome;
- gender - Sexo (M-Masculino ou F-Feminino);
- birth - Data de Nascimento;
- age - Idade;
- br_person_type - Tipo de Pessoa do padrão brasileiro (F-Física ou J-Jurídica);
- br_cpf - Número do CPF do padrão brasileiro;
- br_cnpj - Número do CNPJ do padrão brasileiro;
- company - Razão Social da Empresa;
- email - Email do contato;
- maxbot_username - Nome do usuário Maxchat no Maxbot;
- whatsapp - Número do WhatsApp;
- mobile_phone - Número do Celular;
- telegram_id - ID do contato no Telegram (Em Breve);
- telegram_username - Nome de usuário do contato no Telegram (Em Breve);
- fbmessenger_id - ID do contato no Facebook Messenger (Em Breve);
- telegram_username - Nome de usuário do contato no Facebook Messenger (Em Breve);
- instagram_id - ID do contato no Instagram (Em Breve);
- instagram_username - Nome de usuário do contato no Instagram (Em Breve);
- phone - Número do Telefone Fixo;
- country - País (padrão ISO com sigla de 2 caracteres. Ex.: BR, US, PT, FR, etc);
- state - Estado (padrão ISO com sigla de 2 caracteres. Ex.: MG, SP, RJ, DF, etc);
- city - Nome da Cidade;
- profession - Nome da profissão indicada no cadastro;
- external_id - ID Externo para cruzamento com sistemas externos como RPs, CRMs ou softwares de gestão da empresa;
- ind_client - Indicador se o contato já é um Cliente da empresa (0-Não, 1-Sim);
- client_code - Código do Cliente usado no sistema interno da empresa;
- avatar_url - Link do avatar do contato;
- obs - Texto do campo de observação da ficha de cadastro do contato;
- Tags INFO - Os campos de [INFO1], [INFO2], [INFO3], [INFO4], [INFO5] e [INFO6] é utilizado para entrada de texto livre a ser utilizado no disparo de templates. Permite texto livre, incluíndo EMOJIS, até 1.000 caracteres;
- tag_info1 - Tag Info 1, [INFO1];
- tag_info2 - Tag Info 2, [INFO2];
- tag_info3 - Tag Info 3, [INFO3];
- tag_info4 - Tag Info 4, [INFO4];
- tag_info5 - Tag Info 5, [INFO5];
- tag_info6 - Tag Info 6, [INFO6];
- Obs.: As Tags devem ser cadastradas no contato e no template para serem substituídas no envio de template.
- in_attendance - Indica se o contato está sendo atendido no momento (0-Não, 1-Sim);
- current_protocol - Número do protocolo em atendimento;
- current_attendant - Nome do atendente em atendimento;
Charge Retorno do Webhook da situação de cada envio da cobrança
Retorna a situação de cada envio da cobrança no formato JSON para o url do webhook configurado no modulo de cobrança inteligente.
Retorno:
{
"client_country": "BR",
"client_customer": "Carlos Lana",
"client_br_person_type": "F",
"client_br_cpf": "31113710614",
"client_br_cnpj": "7574849393",
"client_whatsapp": "5551982492631",
"client_mobile_phone": "",
"client_email": "meuemail@mail.com",
"client_code1": "1231",
"client_code2": "12321",
"client_code3": "AV930",
"charge_origin": "API",
"charge_id": "2342",
"charge_invoice": "23423",
"charge_due_date": "2022-06-23",
"charge_amount": "120.00",
"msg_charge_1": [
{
"status": "5",
"date": "2022-07-11",
"info": "Late Date"
}
],
"msg_charge_2": [
{
"status": "1",
"date": "2022-07-29",
"info": ""
}
],
"msg_alert_1": [
{
"status": "1",
"date": "2022-08-29",
"info": ""
}
],
"msg_alert_2": [
{
"status": "1",
"date": "2022-09-29",
"info": ""
}
],
"msg_pg": [
{
"status": "2",
"date": "",
"info": "Waiting"
}
],
"msg_cnc": [
{
"status": "3",
"date": "2022-07-29",
"info": ""
}
],
"msg_nf": [
{
"status": "3",
"date": "2022-07-29",
"info": ""
}
]
}
- client_country - Código do país com 2 caracteres no padrão ISO (Ex.: BR-Brasil, PE-Peru, US-Estados Unidos);
- client_customer - Nome do Cliente;
- client_person_type - Tipo de pessoa do padrão brasileiro;
- client_cpf - Número do CPF (cadastro de pessoa física) do padrão brasileiro;
- client_cnpj - Número do CNPJ (cadastro nacional de pessoa jurídica) do padrão brasileiro;
- client_whatsapp - Número do WhatsApp com código de país e DDD (Ex.: 5511988887777);
- client_mobile_phone - Número do telefone celular com código de país e DDD (Ex.: 551144446666);
- client_email - E-Mail do Cliente;
- client_code1 - Código do Cliente no sistema da empresa;
- client_code2 - Código do Cliente no sistema da empresa;
- client_code3 - Código do Cliente no sistema da empresa;
- charge_origin - Local que foi gerado a cobrança;
- charge_id - ID da Cobrança no Maxbot;
- charge_invoice - Número da cobrança;
- charge_due_date - Data de Vencimento da cobrança;
- charge_amount - Valor da cobrança;
- msg_charge_1
- status - Situação de Envio da 1º Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 1º Cobrança;
- info - Informação de Envio da 1º Cobrança;
- msg_charge_2
- status - Situação de Envio da 2º Cobrança (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio da 2º Cobrança;
- info - Informação de Envio da 2º Cobrança;
- msg_alert_1
- status - Situação de Envio do 1º Aviso (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 1º Aviso;
- info - nformação de Envio do 1º Aviso;
- msg_alert_2
- status - Situação de Envio do 2º Aviso (0 - Desativado, 1 - Programado, 3 - Sucesso, 4 - Cancelado, 5 - Falha);
- date - Data de Envio do 2º Aviso;
- info - Informação de Envio do 2º Aviso;
- msg_pg
- status - Situação de Envio do Pagamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso , 5 - Falha);
- date - Data de Envio do Pagamento;
- info - Informação de Envio do Pagamento;
- msg_cnc
- status - Situação de Envio do Cancelamento (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio do Cancelamento;
- info - Informação de Envio do Cancelamento;
- msg_nf
- status - Situação de Envio da Nota Fiscal (0 - Desativado, 2 - Aguardando, 3 - Sucesso, 5 - Falha);
- date - Data de Envio da Nota Fiscal;
- info - Informação de Envio da Nota Fiscal;