Skip to main content
POST
Enviar link

Conceituação

Método responsável por enviar um link aos seus contatos, muito utilizado para compartilhar links para que os usuários sejam direcionados a um site.
É importante você saber que o link só fica clicável caso o destinatário já tenha seu telefone nos contatos, ou se o mesmo iniciar uma conversa com você.

Exemplo no WhatsApp


Atributos

string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.

Obrigatórios

string
obrigatório
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
string
obrigatório
Texto sobre seu link. Não esqueça de informar o mesmo valor do linkURL no final deste texto.
string
obrigatório
Link da imagem
URL do seu link
string
obrigatório
Título para o link
Descrição do link

Opcionais

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.
string
Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 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 a 3 sec
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 15 sec, significa quantos segundos ele vai ficar com o status “Digitando…”. O delay default caso não seja informado é de 0

Request Body


Response

200

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início 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”.