Pular para o conteúdo principal
POST
Enviar documento
Envia um documento, como PDF, planilha ou apresentação, para um cliente com a janela de 24 horas aberta.
O destinatário pode ser informado pelo número de telefone (to) ou pelo ID do usuário (recipient). Se os dois forem enviados, vale o to; para enviar pelo ID do usuário, deixe o to em branco. Veja a diferença em Destinatário.
Informe o documento de uma das duas formas:
Envie apenas um dos dois. Com link e id na mesma requisição, a Meta recusa o envio.
No Testar, o link já vem preenchido com um PDF de exemplo. Para testar com um id, apague o link antes de enviar.

Nome do arquivo

Use document.filename para definir o nome que o cliente vê, com a extensão, como boleto-pedido-7539.pdf. O WhatsApp usa a extensão para mostrar o ícone do tipo de arquivo.

Formatos aceitos

Só esses tipos são aceitos oficialmente pela Meta. Outros formatos podem não abrir corretamente no WhatsApp do cliente. A legenda aceita até 1.024 caracteres e a mesma formatação do texto. Veja mais detalhes na documentação de mensagens de documento da Meta.

Autorizações

Authorization
string
header
obrigatório

Token gerado no painel da Datafy ao criar o canal. Formato: sk_live_xxx.

Parâmetros de caminho

phone_number_id
string
obrigatório

ID do número que envia a mensagem. Descubra com GET /me.

Corpo

application/json
messaging_product
enum<string>
padrão:whatsapp
obrigatório

Sempre whatsapp.

Opções disponíveis:
whatsapp
Exemplo:

"whatsapp"

to
string
obrigatório

Número do destinatário com código do país e DDD, como 5511999999999. Tem prioridade sobre recipient: para enviar pelo ID do usuário, deixe em branco.

Exemplo:

"5511999999999"

type
enum<string>
padrão:document
obrigatório

Sempre document.

Opções disponíveis:
document
Exemplo:

"document"

document
object
obrigatório

Documento da mensagem. Informe link ou id, nunca os dois.

recipient_type
enum<string>
padrão:individual

Sempre individual.

Opções disponíveis:
individual
Exemplo:

"individual"

recipient
string

ID do usuário no WhatsApp (BSUID), recebido nos webhooks em from_user_id e contacts[].user_id, como BR.13491208655302741918. Usado quando to não é informado.

context
object

Responde citando uma mensagem anterior da conversa.

Resposta

Envio aceito pela Meta. Não confirma a entrega.