Documentação Botbr

Aqui você tem tudo sobre os recursos da Botbr

Seja Bem vindo

Esta é a documentação de uso do nosso sistema Botbr para WhatsApp.

Nesta documentação, você encontrará um manual do usuário detalhado, onde poderá aprender como executar:

  • Envio de lembretes
  • Conectar multiplas contas de Whatsapp
  • Envio em massa
  • Salvar Grupos de contatos
  • Criar modelos de mensagem
  • Usando a API da Botbr Whatsapp Gateway

Caso você não esteja familiarizado com os procedimentos apresentados, podemos auxiliá-lo através de nossa equipe de suporte. Soporte Tecnico

Licença de Uso

Isenção de direitos autorais

Este projeto não é afiliado, associado, autorizado, endossado ou de qualquer forma oficialmente conectado com o WhatsApp ou qualquer uma de suas subsidiárias ou afiliadas. O site oficial do WhatsApp pode ser encontrado em https://whatsapp.com "WhatsApp" e nomes, marcas, emblemas e imagens relacionados são marcas registradas de seus respectivos proprietários.

Criando uma conta

Criar uma conta na Botbr é muito simples, basta ir à página de cadastro e preencher os dados solicitados.

Nota : Você deve usar uma conta de e-mail real para usar sua conta

Iniciando um sessão

Você pode acessar sua conta Botbr fazendo login, você deve preencher o formulário de login digitando seu nome de usuário, e-mail ou número de telefone e inserindo a senha, faça login pressionando o botão LOGIN.

Nota : Se você esqueceu a senha então vá até Recuperar Senha informe seu e-mail de casatro e você receberá um link para redefinir sua nova senha.

Cadastrando um dispositivo

Para adicionar um novo dispositivo em seu painel de usuário, vá para Dispositivos-> adicionar um novo dispositivo

Adicione um novo número salvando um Nome para identificá-lo e adicionando o número (você não deve usar o sinal +, mas sim o número da área exemplo: 55)

Clique no botão OFF-LINE ou Botão Laranja e visualizar dispositivo

Digitalize o código QR do aplicativo Whatsapp para iniciar a sessão

Nota : O dispositivo deve-se manter ligado a internet

Bot de resposta automática

Criar uma mensagem de resposta automática é muito simples, essas mensagens serão enviadas automaticamente quando uso de palavra-chave.

  • Vá para Auto Responder no menu e crie uma mensagem de resposta automática.
    • Nota : Suporta palavras-chave únicas, não suporta frases

    Deve preencher os dados para criar a resposta automática

    • 1. Selecione o remetente (de onde a resposta automática será enviada, selecione TODOS para enviar a mensagem de resposta automática para todas as contas salvas do whatsapp)
    • 2. Escreva a palavra-chave
    • 3. Determine a porcentagem de proximidade da palavra-chave que recomendamos usar 75%
    • 4. Escreva a resposta
    • 5. Selecione um arquivo opcional
    • 6. Pressione o botão enviar

    Lista de Contatos

    As listas de contatos são usadas para enviar lembretes de gerenciamento em massa para vários números do mesmo lembrete.

  • Vá para Lista de contatos no menu e crie uma lista de contatos.
    • Nota : Você deve atribuir um nome exclusivo a cada lista de contatos para que seja fácil selecioná-la

    Mensagens pré-salvas (Templates)

    Aqui você pode criar modelos de mensagens de texto para facilitar a criação de lembretes.

    1. Você deve ir ao botão "Criar novo template" e criar uma nova mensagem pré-escrita, adicionar um nome que o ajudará a identificar o modelo de mensagem do painel para criar lembretes

    Recarga de assinatura

    Botbr tem um teste gratuito que você pode usar para verificar como funciona o Botbr para continuar desfrutando dos serviços que o Botbr oferece. Você deve obter uma assinatura que melhor atenda às suas necessidades, para isso você deve recarregar sua carteira segura para continuar desfrutando do Botbr.

  • Vá para Seu perfil em sua conta Botbr e clique no botão "Recarregar Saldo" .
    • Nota : Você pode ver suas transações a partir do botão Ir para Transações em seu perfil

    Escolha o método de pagamento para recarregar sua carteira

  • Você pode selecionar entre PAYPAL e Mercado Pago aqui no Botbr, e você recarregará sua conta..

    • Pagar com Paypal

  • Se seleccionou o pagamento por paypal terá duas opções
  • 1. Pague através de uma conta paypal
  • 2. Pague com cartão de crédito e débito

    • Pague com cartão de crédito ou débito

  • Deve preencher os dados financeiros e pessoais para que sejam tratados.
    • Nota : Botbr não armazena nenhum dado bancário dos usuários as transações são processadas pelo paypal sob a proteção de segurança e privacidade do paypal.

    Pagar com Mercado Pago

  • Se seleccionou o pagamento por Mercado Pago terá algumas opções
  • 1. Pague com cartão de crédito
  • 2. Pague com boleto bancário
  • 3. Pague com sua conta Mercado Pago
  • 4. Pague com PIX
    • Nota : Botbr não armazena nenhum dado bancário dos usuários as transações são processadas pelo Mercado Pago sob a proteção de segurança e privacidade do Mercado Pago.

    Atualizar seu Plano

  • Após recarregar sua carteira, acesse seu perfil e clique no botão "Upgrade/Downgrade" para melhorar seu plano Botbr.

    • Escolha o plano

  • Escolha o plano que deseja atualizar e que melhor se adapte às suas necessidades, o Botbr calculará o percentual de cobrança desde o dia em que você o apresentar até o final do mês e cobrará o valor percentual do custo da assinatura, você também pode fazer o downgrade do seu plano (preço mais baixo) Isso será afetado em sua fatura no início do próximo mês, pois o ciclo de cobrança é reiniciado todo dia 1º de cada mês.

    • Rest Api

    Nota : Sua conta Botbr deve estar ativa com mensagens disponíveis para que o envio de mensagens funcione corretamente

    Editar Perfil

    Edite seu perfil Botbr, mude sua senha, escolha entre o modo claro e o modo escuro.

    Nota : Você pode alterar o modo claro e o modo escuro no formulário de edição do seu perfil

    VERIFIQUE SE UM NÚMERO DE TELEFONE ESTÁ NO WHATSAPP

    Veja como verificar se um número está cadastrado no WhatsApp ou não (GET):

    https://api.botbr.us/isonwa?receiver=phone_number_you_want_to_check&sender=sender_phone_number&
    token=sender_token

    Veja como verificar se um número está cadastrado no Whatsapp ou não (POST):

    Use a mensagem de envio POST no menu REST API, apenas altere o

    $nodeurl = 'https://api.botbr.us/isonwa';
    $data = [ 'receptor' => 'phone_number_you_want_to_check', 'remitente' => 'sender_phone_number',
    'token' => 'sender_token',
    ];

    1. Valor de retorno:

    {"success":true,"isonwa": true}

    conexão com o whatsapp foi bem-sucedida e o número está no whatsapp


    2. Valor de retorno:

    {"success":true,"isonwa":false}

    conexão com o whatsapp foi bem-sucedida e o número NÃO está no whatsapp


    3. Valor de retorno:

    {"success":false,"response":"[WARNING] isonwa request failed! remetente inválido!"}

    Erro de conexão do WhatsApp devido a número de remetente inválido


    4. Valor de retorno:

    {"success":false,"response":"[WARNING] isonwa request failed! Token inválido!"}

    Erro de conexão do WhatsApp devido a token de remetente inválido


    Nota : fazer a consulta de forma massiva pode resultar no bloqueio da sua conta do WhatsApp

    URL API

    Você pode usar a URL API para enviar mensagens de outras plataformas

  • Vá até Rest Api e usa as informações padrão.

    • Metodo GET:

    Envio de Texto

    https://api.botbr.us/send?receiver={{$receiver}}&msgtext={{$msgtext2}}&token={{$token}}


    Envio de Texto + Mídia

    https://api.botbr.us/send?receiver={{$receiver}}&msgtext={{$msgtext2}}&token={{$token}}&mediaurl={{$mediaurl}}


    Nota : substitua {{''}} pelas informações no final do seu perfil.

    Avançados

    PADRÃO DE RESPOSTA AUTOMÁTICA

    Como fazer um autoresponder padrão se não houver palavra-chave correspondente?

  • 1. Vá para o menu "Resposta automática"
  • 2. Clique no botão "Adicionar nova resposta automática"
  • 3. Coloque "defaultAutoreply" na caixa de texto das palavras-chave
  • 4. Coloque "Olá {nome}, desculpe, mas não entendi você. Você pode clicar no botão abaixo?" na caixa de texto de resposta
  • 5. Exemplo: "Ligue para mim!" e "+5511912345678" no botão
  • 6. Coloque "Ir para o menu principal" e "teste" no botão 2
  • 7. Clique no botão Enviar para salvar.

    • Nota : Você pode usar esta opção ou ativá-la fora do horário comercial

    ENVIE MENSAGEM DE MASSA COM O ROTACIONADOR

    O que é ROTACIONADOR? Se você tiver 2 ou mais dispositivos de envio, poderá alternar os remetentes ao enviar mensagens em massa.
    O processo: enviador1, enviador2, enviador, ...., enviadorX, então de volta para enviador1, enviador2, .... até o trabalho terminar...

    PHP API CODE {{ __('Send') }} {{__('VCARD') }} (POST)

    <?php
$nodeurl = '{{env('NODE_URL')}}/send';
 
$data = [
    'receiver'  => '{{$receiver}}',
    'msgtext'   => 'vcard',
    // 'msgtext'   => 'FN:My+Full+Nome,ORG:Minha+empresa+aqui,TEL:5511912345678',
    'token'     => '{{$token}}',
];
 
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/x-www-form-urlencoded']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_URL, $nodeurl);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
$response = curl_exec($ch);
curl_close($ch);
 
echo $response; // output {success:true} or {success:false}
    Nota :Você deve ter mais dois dispositivos conectados para esta opção

    ENVIAR VCARD

    O que é ENVIAR VCARD? O arquivo vCard pode armazenar um contato específico em um formato padrão que torna mais fácil para os usuários transferir ou compartilhar em redes e computadores..
    Como enviar VCARD: Digite na caixa de mensagem e digite "vcard" ou
    FN: Nome Completo,
    ORG: minha Empresa Nova,
    TEL: 5511912345678.

    Nota : Você pode usar o método GET:
    https://api.botbr.us/send?receiver=123456789&msgtext=FN:Meu+Nome+Completo,ORG:Minha+Empresa+Nova,
    TEL:5511912345678&sender=5511912345679&token=TOKEN_API

    POST:

    PHP API CODE {{ __('Send') }} {{__('VCARD') }} (POST)

    <?php
$nodeurl = '{{env('NODE_URL')}}/send';
 
$data = [
    'receiver'  => '{{$receiver}}',
    'msgtext'   => 'vcard',
    // 'msgtext'   => 'FN:Meu+Nome+Completo,ORG:Minha+Empresa+Nova,TEL:5511912345678',
    'token'     => '{{$token}}',
];
 
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/x-www-form-urlencoded']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_URL, $nodeurl);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
$response = curl_exec($ch);
curl_close($ch);
 
echo $response; // output {success:true} or {success:false}

    RESPOSTA AUTOMATICA:
    Para responder ao bot vcard (self VCARD):
    envie “vcard” para o seu bot de resposta automática, você receberá uma resposta de contato do vcard
    Para responder com outro número VCARD:
    1. Deve colocar a palavra-chave “vcard”
    2. Deve colocar a resposta como abaixo:
    FN: Meu Nome Completo,
    ORG: Minha Empresa nova,
    TEL: 5511912345678

    ENVIAR LOCALIZAÇÃO

    O que é ENVIAR LOCALIZAÇÃO? Você pode compartilhar locais determinados.
    Como enviar LOCALIZAÇÃO: Digite na caixa de mensagem que eu digitei:
    degreesLatitude: latitude,
    degreesLongitude: longitude,
    locationName: Nome,     locationAddress: Endereço

    Nota : Você pode usar o método GET:
    https://api.botbr.us/send?receiver=0123456789&msgtext=degreesLatitude:23.232483,degreesLongitude:
    54.692107,locationName:Omar+Palace, locationAddress:dress+adress2&sender=TOKEN

    POST:

    PHP API CODE {{ __('Send') }} {{__('LOCATION') }} (POST)

    <?php
$nodeurl = '{{env('NODE_URL')}}/send';
 
$data = [
    'receiver'  => '{{$receiver}}',
    'msgtext'   => 'degreesLatitude:24.232483,degreesLongitude:55.692107,locationName:Omar+Palace,locationAddress:Abu+Dhabi',
    'token'     => '{{$token}}',
];
 
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/x-www-form-urlencoded']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_URL, $nodeurl);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
$response = curl_exec($ch);
curl_close($ch);
 
echo $response; // output {success:true} or {success:false}

    RESPOSTA AUTOMATICA:
    Para responder à LOCALIZAÇÃO do bot:
    Vá para o seu bot de resposta automática, você obterá a localização
    1.Selecione o menu Resposta automática => Adicionar nova resposta automática
    2.Palavra-chave => LOCATION (qualquer palavra-chave de sua preferência)
    3. resposta:
    degreesLatitude: 23.232483,
    degreesLongitude: 54.692107,
    locationName: Nome,
    locationAddress: São Paulo, SP.
    4. Clique em “Enviar” para salvar

    CANCELAR A INSCRIÇÃO DA MENSAGEM MASSIVA (CAMPANHA)

    COMO FAZER ISSO DO LADO DO CLIENTE?

    Por padrão, se um cliente digitar "cancelar inscrição" no bot, o bot será salvo no banco de dados e nunca mais enviará mensagens em massa para esse cliente.
    Cada bot no mesmo usuário no Botbr não enviará nenhuma mensagem em massa para aquele cliente, isso ocorre porque o Botbr possui recurso de vários remetentes, se você bloquear apenas 1 remetente, outro remetente ainda poderá enviar mensagens em massa para esse cliente. Cada bot ainda poderá enviar mensagens para esse cliente, desde que envie mensagens não em massa.

    ESSE RECURSO VAI TE AJUDAR A REDUZIR O BAN

    DO WHATSAPP Minha sugestão é: Ao enviar uma campanha, inclua esta mensagem abaixo: "Digite 'unsubscribe' para se remover de nossas futuras mensagens de campanha"
    Ou você pode criar um botão com a mensagem da sua campanha, coloque "unsubscribe" no ID do botão.

    O QUE ACONTECE APÓS O CLIENTE CANCELAR A ASSINATURA?

    O número de telefone do cliente será salvo na tabela "assinante" com o código "0", e toda vez que você enviar uma campanha, ela será verificada através deste banco de dados. Se encontrado, o envio para este número será ignorado.
    Ou seja, você não precisa retirar da agenda o telefone do cliente não cadastrado, pois o Botbr irá pular automaticamente a mensagem para os clientes não cadastrados.

    O QUE ACONTECE SE O CLIENTE MUDA DE IDEIA E QUER RECEBER A CAMPANHA NOVAMENTE?

    Do lado do cliente, basta pedir ao cliente para digitar 'subscribe' no bot

    SPINTAX (PALAVRA ALEATÓRIA AO ENVIAR CAMPANHA)

    O OBJETIVO É FAZER MENSAGENS UM POUCO DIFERENTES UMAS DAS OUTRAS EM UMA CAMPANHA

    Vá para o menu Enviar mensagem e você pode digitar vários conjuntos de palavras aleatórias entre chaves. Use { } para agrupar e usar | para separar palavras ou frases.
    Olá {name}, hoje temos uma {venda | grande promoção | bazar de fim de semana | Desconto extremo} na sua cidade. Entre em contato com nossos { vendedores | agentes | técnico | advisors} para mais informações entre em contato pelos nossos telefones: {+1234567890 | +1234567891 | +1234567892 | +1234567893}
    Isso mudará aleatoriamente em cada mensagem, resultando em mensagens diferentes

    Nota : Esta função ajuda a evitar bloqueios pelo whatsapp e é recomendada em remessas massivas de grandes quantidades
    recomendamos usar este fragmento no final de cada mensagem: {A|B|C|D}{1|2|3|4}{F|G|H|I}{5|6|7|8} que irá dar como O resultado é um código de 4 caracteres (A2H8) que ajuda a melhorar o anti-ban do whatsapp

    OPENAI CHATGPT

    Você pode usar uma conta do WhatsApp como um chatbot de inteligência artificial, essa função é focada em páginas de blogs, notas, revistas e todos que desejam que seus clientes e contatos se comuniquem com inteligência artificial de IA aberta, chamada chatGPT

    Como obter apikey do openai ?

    Registre uma nova conta se você ainda não o fez.

  • Então vá para Chaves de API da conta - OpenAI API e obtenha suas credenciais.

    • Onde inserir openai apikey no Botbr?

    Como interagir com o bot openai chatGPT?

    Chame o chatbotGPT com o nome do dispositivo. Exemplo para conversar com o bot com o dispositivo da imagem acima: "tri, o que é openai chatbot?".

    CAPTURA DE DADOS

    O QUE É O BOT DE CAPTURA DE DADOS?

    Esse recurso é como um bot de pesquisa. O bot terá um conjunto de perguntas que serão feitas se for dada uma palavra-chave específica.
    Quando a pessoa responder, essa resposta será coletada e resumida no final da pesquisa.

    COMO FUNCIONA?

    A captura pode ser usada como universal ou personalizada por dispositivo (o padrão é universal).
    Agora a mensagem de fim e a mensagem de parada podem ser diferentes em cada tema
    Confira a imagem "Problemas" abaixo!
    Universal Media: A estrutura de captura será a mesma para todos os usuários.
    Mas você não precisa habilitar o webhook do usuário.
    Por dispositivo é um estilo de captura mais personalizado, cada dispositivo pode editar o arquivo webhook para obter uma experiência de captura personalizada.
    Requer a habilitação do webhook do usuário

    PARA QUE SERVE?

    Bem, para qualquer dado relacionado que você deseja obter de uma conversa interativa com o bot.
    O exemplo a seguir demonstrará um bot que está marcando uma consulta com o dentista de um usuário.

    1. Digite a palavra-chave para iniciar o agendamento da consulta ao dentista
    2. Insira saudações
    3. Escolha o tipo de botão
    4. Digite SIM e ative "capture>>start>>dentist"
    5. Digite NÃO e habilite "capture>>stop"¡
    Isso é tudo! É isso!
    GATILHOS DE CAPTURA:
    capture>>start>>{subject-name}
    Isso iniciará uma sessão de captura com o nome do assunto
    capture>>stop Isto irá parar/cancelar a captura atual
    capture>>end Isto irá parar/salvar a captura completa
    MENSAGENS DE CAPTURA: Esta mensagem será exibida na capture>>finish e capture>>stop
    no arquivo de idioma você encontrará as tags
    "finish": "Obrigado por marcar uma consulta com o Bright Dentist Office!",
    "stop": "Desculpe. Se você quiser começar de novo, digite < code class="badge badge-info">'capture>>start>>dentista'"

    Nota : Você pode editar e adicionar problemas. Exemplo: adicione "enquete" (não se esqueça de "finalizar" no final das perguntas) Agora você pode ativar a nova captura usando "capture>>start>>survey"

    DISPOSITIVO DE LEITURA AUTOMÁTICA, INTERRUPTOR AUTOMÁTICO, PREFIXO ABERTO, GRUPO DE RESPOSTA AUTOMÁTICA

    ESTA CONFIGURAÇÃO PODE SER ACESSADA ATRAVÉS DE: DISPOSITIVOS->EDITAR DISPOSITIVO.

  • Vá para Editar dispositivos e edite as configurações de qualquer dispositivo.

    • O que é Autotroca?

    Isso é para ativar/desativar o bot para alterar o remetente se o remetente atual for banido ou estiver offline (o padrão é SIM)

    Qual é o prefixoOpenAI?

    Este é o nome do bot seguido por "," (vírgula) e depois a pergunta.
    Por que preciso de um prefixo?
    Esse prefixo diferenciará entre a resposta automática regular ou a resposta automática de webhook.
    Este dispositivo é dedicado ao OpenAI chatGPT,
    posso ignorar a chamada do nome do bot?
    SIM, você pode, basta escolher "Sem prefixo" no menu suspenso.(predeterminado "device->name")

    O que é o grupo de resposta automática?

    Isso é para ativar/desativar o recurso de resposta automática no grupo do WhatsApp. (padrão NÃO)

    Nota : Recomenda-se fazer testes antes e depois de alterar as configurações padrão para ver os resultados.

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE

    AGUARDE NOVIDADE.

    Nota : AGUARDE NOVIDADE