Para habilitar a API Maxbot, realize login na conta e acesse o menu Configuração > API Maxbot. Clique em Ativar API para gerar o token de identificação da conta, o qual será utilizado nos processos de autenticação e validação das requisições à API. Sempre que necessário, um novo token poderá ser emitido por meio da opção Gerar Novo Token. O token exibido na interface deverá ser utilizado obrigatoriamente em todas as comunicações com a API Maxbot.
Versão:1.0
A API (sigla em inglês para Interface de Programação de Aplicativos) é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A plataforma Maxbot oferece uma API REST de comunicação que permite a integração do Maxbot com sistemas externos, possibilitando:
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.
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 .
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": ""
}
Quando um contato comentar em cima de uma mensagem, os dados referentes à mensagem comentada serão recebidas nos campos quoted correspondente:
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": ""
}
Quando um contato comentar em cima de uma mensagem, os dados referentes à mensagem comentada serão recebidas nos campos quoted correspondente:
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": ""
}
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": ""
}
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": ""
}
]
}