🟢 Principais aspectos da API Whaticket
Antes de começarmos, é importante ter em mente alguns pontos fundamentais sobre como a API funciona.
▪️ A API Whaticket foi projetada exclusivamente para o envio de mensagens .
▪️ Para utilizá-lo corretamente, é necessário conhecimento técnico .
▪️ Recomenda-se a contratação de um profissional de tecnologia da informação com experiência em integrações.
▪️ Para enviar e-mails via API, você precisa ter créditos de campanha .
Essas considerações ajudarão você a entender melhor o escopo da ferramenta antes de iniciar a configuração.
🟢 Como gerar um token de acesso
Para usar a API, você precisa primeiro criar um token de acesso na plataforma.
1. Acesse a seção de tokens
- Faça login na sua conta Whaticket.
- Acesse a opção Tokens .
2. Criar um novo token
- Clique no botão Novo Token .
- Atribua um nome ao token.
- Selecione as permissões que deseja conceder.
3. Salve o token gerado.
- Copie o token gerado.
- Guarde-o em um local seguro, pois você precisará dele para autorizar as solicitações da API.
4. Autorize o uso do token na documentação.
- Acesse o campo Documentação .
- Clique no botão Autorizar .
- Cole o token gerado ali.
🟢 Métodos disponíveis na API
A API do Whaticket possui diversos métodos para consultar informações, restabelecer conexões e enviar mensagens.
🟢 Método GET para obtenção de informações
O método GET permite consultar informações importantes sobre uma conexão.
Com este método você poderá obter:
▪️ ID de conexão
▪️ Nome da conexão
▪️ Estado da conexão
Esses dados são necessários para realizar outras ações, como enviar mensagens ou restabelecer uma linha.
🟢 Método PATCH para restabelecer uma conexão
Se a sua conexão do WhatsApp for interrompida e você quiser restaurá-la sem precisar escanear um novo código QR, você pode usar o método PATCH .
1. Obtenha o identificador de conexão.
Antes de reconectar a linha, você precisa do ID da conexão .
Você pode encontrá-lo:
▪️ Usando o método GET
▪️ Nas configurações de conexão do Whaticket
2. Realize a reconexão.
- Clique em "Experimentar" .
- Insira o ID da conexão no campo correspondente.
- Pressione Executar para reconectar a linha.
🟢 Método POST para envio de mensagens
O método POST permite enviar mensagens para um ou mais contatos.
1. Enviar uma mensagem personalizada
Para enviar uma mensagem individual:
- Clique em "Experimentar" .
- Preencha os campos com as seguintes informações:
▪️ ID de conexão
▪️ Número de contato com código do país
▪️ Nome do destinatário
▪️ Mensagem - Clique em Executar .
2. Enviar mensagens em massa
Você também pode usar a API para enviar mensagens para vários contatos.
Nesse caso:
▪️ Repita os passos de envio individuais
▪️ Use a variável globalBody se quiser enviar a mesma mensagem para todos os destinatários.
🟢 Como converter uma imagem em uma chave de mídia
Se você deseja enviar arquivos multimídia, primeiro precisa converter a imagem em uma chave de mídia .
1. Gere a chave de mídia
- Clique em "Experimentar" .
- Selecione a imagem no seu computador.
- Copie o código gerado.
🟢 Como enviar arquivos multimídia para vários contatos
Após a geração da chave de mídia, você poderá utilizá-la para enviar arquivos para vários contatos.
1. Preencha os detalhes de envio.
- Autorize o uso de Experimente .
- Insira o ID de conexão que será usado para o envio.
- Cole a chave de mídia gerada anteriormente .
🟢 Como enviar uma mensagem e atribuí-la a um usuário e departamento
A API também permite enviar uma mensagem e atribuir automaticamente o chat a um usuário e a um departamento.
Neste caso, é utilizada uma variável adicional chamada ticketData .
Essa variável permite definir o estado do chat.
Os valores disponíveis são:
▪️ aberto
▪️ fechado
▪️ pendente
Além disso, você precisará preencher outros campos:
▪️ userId : corresponde ao identificador do usuário, disponível na seção Equipe
▪️ queueId : corresponde ao identificador do departamento
Existe também a variável força , que aceita apenas dois valores:
▪️ verdadeiro
▪️ falso
Recomenda-se manter a opção " verdadeiro" se o contato já existir e você quiser atualizar as informações com os novos identificadores.
🟢 Como configurar “Continue comigo” ou “Continue comigo até”
A API agora também permite configurar as opções "Manter comigo" e "Manter comigo até" a partir de sistemas externos .
1. Continue comigo
Esta opção permite que você mantenha o chat aberto indefinidamente.
2. Mantenha-me com você até
Essa opção permite que você adie o bate-papo até uma data específica.
Para essa finalidade, a API aceita apenas o seguinte formato de data:
▪️ AAAA-MM-DD
É importante ressaltar que a liberação é calculada com base no momento exato em que a retenção é ativada.
Por exemplo:
▪️ Se você ativar a retenção no dia 9 às 12:36
▪️ E você definiu a data de término para o dia 11.
▪️ O chat será liberado automaticamente no dia 11 às 12:36
3. Regras de Sobreposição
▪️ Se uma nova data for enviada pela API, a data anterior será substituída.
▪️ Se for submetido um pedido sem data, a retenção será interpretada como " Mantenha comigo indefinidamente".
🟢 Informações importantes sobre limites de uso
A API Whaticket possui um limite máximo de uso para evitar sobrecargas.
▪️ O máximo permitido é de 600 solicitações por minuto.
Caso encontre erros durante o processo, recomenda-se revisar cuidadosamente cada etapa e verificar se todos os campos foram preenchidos corretamente.
Tem mais alguma dúvida? Não se preocupe, estamos aqui para ajudar.
Entre em contato com nossa equipe clicando no botão "Suporte" localizado no menu à esquerda da nossa plataforma.
