Enviar link
Método#
/send-link#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-link
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Método responsavel por enviar um link aos seus contatos, muito utilzado para compartilhar links para que os usuários sejam direcionados a um site.
Sobre links
É importante você saber que o link só fica clicavel caso o destinatário ja tenha seu telefone nos contatos, ou se o mesmo iniciar uma conversa com vocë.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
| message | string | Texto sobre seu link. Não esqueça de informar o mesmo valor do linkURL no final deste texto. |
| image | string | Link da imagem |
| linkUrl | string | Url do seu link |
| title | string | Titulo para o link |
| linkDescription | string | descrição do link |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| delayMessage | number | Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex "delayMessage": 5, ). O delay default caso não seja informado é de 1~3 sec |
| delayTyping | number | Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai ficar com o status "Digitando...". (Ex "delayTyping": 5, ). O delay default caso não seja informado é de 0 |
| linkType | String | Atributo utilizado para definir o tamanho da mensagem de visualização do link enviado (SMALL, MEDIUM ou LARGE). O tamanho default caso não seja informado é SMALL. |
Request Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no z-api |
| messageId | string | id no whatsapp |
| id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.
415#
Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"
Webhook Response#
Link para a response do webhook (ao receber)