Exemplos de requisições API via Postman
Para realizar os envios, é necessário acessar o POSTMAN:
Nessa tela, será necessário criar uma conta ou fazer login caso já possua uma conta existente. Clique em Sign In no canto superior direito.
Caso possua uma conta no Google o login se tornará mais simples! Após o login você será redirecionado para a página principal:
Para começarmos a fazer as requisições você precisará criar um workspace ou utilizar algum que você já possua, clique em em Workspaces:
Caso você não tenha um, clique em Create Workspace:
A visibilidade pode ser mantida como Personal, onde será um Workspace que somente você terá acesso, um nome também precisa ser definido para criação. Clique em Create Workspace.
Pronto! Você já será redirecionado ao seu novo Workspace onde poderá realizar os testes.
Requisição GET
Para criar uma nova requisição, clique em New:
Será aberta uma nova janela, perguntando o que queremos criar, deve ser selecionado HTTP Request:
Pronto, a requisição foi criada!
O Method (Método) deve ser selecionado como GET.
Enter request URL é onde deve ser informado o Endpoint (https://v1.utalk.chat/send/token/), sempre será o mesmo, só irá mudar o Token no final.
Para visualizar o Endpoint:
- Acesse sua conta no Umbler Talk;
- Clique em Módulos > Integrações API/Webhook
- (Doc) Enviar mensagem
Informando os parâmetros:
Mensagem de texto:
- cmd: Tipo da mensagem a ser enviada, neste caso: chat
- id: Para que você capture atualizações de status pelo webhook referente a mensagem enviada, é necessário que você identifique cada mensagem enviada pela API com um ID único, neste caso (randômico)
- to: Número de telefone do contato que irá receber sua mensagem. Atenção: Sempre incluir o código do país,ddd,número e no final adicionar a tag @c.us caso a mensagem seja enviada para um contato ou a tag @g.us se a mensagem for enviada para um grupo.
- msg: Conteúdo da mensagem a ser enviada
Resposta em JSON:
Resultado:
Mensagem de mídia:
- cmd: Tipo da mensagem a ser enviada, neste caso: media
- id: Para que você capture atualizações de status pelo webhook referente a mensagem enviada, é necessário que você identifique cada mensagem enviada pela API com um ID único, neste caso (randômico)
- to: Número de telefone do contato que irá receber sua mensagem. Atenção: Sempre incluir o código do país,ddd,número e no final adicionar a tag @c.us caso a mensagem seja enviada para um contato ou a tag @g.us se a mensagem for enviada para um grupo.
- link: URL da mídia que será enviada. O WhatsWeb irá identificar se o tipo do arquivo é imagem, arquivo de áudio, vídeo, pdf, texto e fará o envio de acordo com a solicitação.
- msg: Conteúdo da mensagem a ser enviada
Resposta em JSON:
Resultado:
OBS: Para PDF’s, a mensagem junto do arquivo não está sendo enviada, sendo necessário enviar separadamente. (14/05/2021)
Mensagem com link e miniatura:
- cmd: Tipo da mensagem a ser enviada, neste caso: link
- id: Para que você capture atualizações de status pelo webhook referente a mensagem enviada, é necessário que você identifique cada mensagem enviada pela API com um ID único, neste caso (randômico)
- to: Número de telefone do contato que irá receber sua mensagem. Atenção: Sempre incluir o código do país,ddd,número e no final adicionar a tag @c.us caso a mensagem seja enviada para um contato ou a tag @g.us se a mensagem for enviada para um grupo.
- thumb: URL da imagem que aparecerá como miniatura do link
- title: Titulo do link
- desc: Descrição do link
- link: URL que o contato será redirecionado ao clicar
Resposta em JSON:
Resultado:
Exemplo de envio para grupo:
Resultado:
Como pegar um ID de grupo?
Para pegar o id do grupo pelo chat basta clicar no ícone do grupo dentro do WebChat do Umbler Talk:
Pelo Webhook:
OBS: É necessário informar o número de quem criou o grupo + id do grupo, como marcado na imagem.
Requisição POST
É possível fazer em POST tudo que é feito em GET, porém, em POST é possível pular linhas.
- O Method (Método) deve ser selecionado como POST.
- Selecionar Body e marcar x-www-form-urlencoded
Exemplo:
Resultado:
OBS: Para formatações de texto podem ser utilizadas as mesmas formas do próprio WhatsApp:
Exemplo:
Resultado: