Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-document
/
{extension}
Enviar documento
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-document/{extension} \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "document": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método responsável por enviar documentos aos seus contatos, ele é simples e objetivo. Você pode trabalhar com os documentos de 2 formas:
  • Por Link: caso você tenha o documento hospedado em algum lugar da internet, basta enviar somente o link;
  • Por Base64: caso você queira enviar o documento em formato Base64.

​
Exemplo no WhatsApp

​
Atributos

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

​
Path

​
extension
string
obrigatório
Extensão do arquivo que está sendo enviado (ex: pdf, xlsx, docx)

​
Obrigatórios

​
phone
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
​
document
string
obrigatório
Link do documento ou seu Base64

​
Opcionais

​
fileName
string
Nome do documento para exibição
​
caption
string
Descrição do arquivo
​
messageId
string
Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo
​
delayMessage
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
​
editDocumentMessageId
string
Permite editar a descrição de um documento enviado anteriormente através do campo caption. É necessário configurar o webhook antes de utilizar

​
Request Body

Por link: 
{
  "phone": "5511999999999",
  "document": "https://expoforest.com.br/wp-content/uploads/2017/05/exemplo.pdf",
  "fileName": "Meu PDF"
}
Por Base64: 
{
  "phone": "5511999999999",
  "document": "data:application/pdf;base64,JVBERiN0YXJ0eHJlZg0KMjg3NDINCiUlRU9G0xLj...",
  "fileName": "Meu PDF"
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
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”.