Antes de explicar como funciona nossa API, há TRÊS pontos que são muito importantes a esclarecer:
O primeiro ponto é que nossa API dentro da Whaticket é apenas para o envio de mensagens!
A segunda é que o uso do API requer conhecimento técnico, por isso recomendamos que você tenha um profissional de TI que tenha um entendimento mínimo do assunto para ajudá-lo.
E a terceira é que para enviar estas mensagens através da API você precisa comprá-las separadamente e ter créditos de campanha.
Agora que esses pontos já foram esclarecidos, vamos lá!
Mostraremos passo a passo como utilizar a API dentro da plataforma pela SWAGGER.
1.0 Você deve gerar um token de acesso para poder realizar envios dentro da API.
Para fazer isso, você deve clicar em TOKENS, lá você encontrará um botão chamado NOVO TOKEN.
1.1 Ao clicar sobre ele, aparecerá uma tela, com um campo para você nomear o componente e selecionar as permissões que deseja dar a ele.
1.2 Copie o TOKEN gerado e prossiga para o próximo passo.
2.0 Agora você deve ir até a documentação, inserir o token gerada dentro da cadeado e autorizar as permissões.
2.1 Vamos falar sobre o método GET. Dentro você receberá 3 informações: A identificação a ser enviada, o nome de sua conexão a ser identificada e seu status (se estiver conectada ou desconectada).
Dentro de cada método, é mencionada a autorização a ser dada.
É bom prestar atenção ao cadeado no canto superior direito, se ele estiver fechado significa que sua chave deu autorização está funcionando, mas lembre-se sempre de verificar se você deu autorização para este método.
Depois disso, você deve clicar em try it out e um grande botão azul escrito EXECUTE aparecerá, clique nele para que as informações sejam publicadas. Em caso de erro, rever as etapas.
2.1.1 Atenção! Se você não quiser usar este método, você também pode obter o ID de conexão na própria conexão ao lado da conexão em Copiar Identificação.
2.2 O método seguinte é o método PATCH. Ele é usado no caso de sua conexão estar offline e você quiser reconectar sem ler um novo código qr, você precisará do ID gerado no primeiro método ou tomado no passo 2.1, primeiro clique em try it out, depois coloque o ID no local indicado.
3.0 O próximo método é o POST. O que o ajudará a enviar mensagens, tem alguns modelos diferentes, para o tipo de imagem que você deseja enviar.
3.1 Envie uma mensagem personalizada: Para enviar você deve clicar em experimentá-la e preencher os campos de valor com ID (mostramos como obtê-la no método 2.1) e dentro das mensagens variáveis você deve colocar o contato (lembrando sempre de inserir o código do país), o nome deste contato e a mensagem personalizada que você deseja enviar. Depois de fazer isso, clique em EXECUTE e sua mensagem será enviada!
3.2 Envie várias mensagens: basta seguir o conselho do ponto anterior, lembrando sempre de colocar a identificação da conexão dentro do Example Value. Se você quiser pode enviar uma mensagem personalizada para cada cliente, se não quiser pode usar o globalBody que está dentro do próprio código e enviar a mesma mensagem para todos os clientes.
3.3 Upload de mídia para múltiplos contatos: Antes de iniciar esta etapa, você deve pular para nossa etapa 4.0 para ver como Upload de uma imagem e convertê-la em uma mediaKey, após a qual você deve digitar novamente o ID da conexão.
A mediaKey que você obteve no passo 4.0 é para alterar os números para os quais você deseja enviar esta imagem.
3.4 Enviar uma mensagem e atribuí-la a um usuário e a um departamento: O que mudará nesta etapa é que temos nossa primeira variável extra, além da variável que conta em todas as etapas que são ‘mensagens’.
A nova variável é chamada ticketData, você escolhe o status do bate-papo entre: aberto, fechado ou pendente.
Nos dois campos seguintes, você deve colocar o usuárioId que você recebe dentro da equipe parte de seu usuário e a queueId que é a identificação de seu departamento, que você recebe dentro.
Veja as screenshots com exemplos abaixo.
E finalmente temos a Force que tem apenas dois estados que são: verdadeiro ou falso. Deixe isso sempre verdadeiro caso este contato já tenha sido criado e você queira alterar as informações de identificação anteriores.
3.5 Envie uma mensagem e preencha o contato com informações personalizadas: como mostrado em nossa última etapa, isto também tem variáveis adicionais além de mensagens, temos 2 contactData que seriam os detalhes de contato como nome e e-mail e na variável customFields seriam as informações adicionais que você deseja colocar nesse contato, como país de origem, cor favorita, um segundo e-mail, etc.
4.0 Como converter sua imagem em uma mediaKey. Depois de ir em try it out, você deve ir ao campo de escolha do arquivo, clicar nele, escolher e procurar a imagem desejada em seu computador. Depois disso, um código será gerado! Basta copiar o código entre aspas e colá-lo no passo 3.3.
Importante:Temos um número máximo de pedidos por minuto, que é de 600 por minuto.