📄Enviar mensagem de documento

Permite enviar uma mensagem de documento para um número cadastrado no WhatsApp.

Um pouco sobre mensagens de documentos

Neste método você poderá enviar mensagens com documentos.

Exemplo de body a ser enviado:

O parâmetro base64 pode ser uma base64 text ou uma url para o documento.

{
    "destination": "+55 61 9551-4650",
    "text": "Uma mensagem de pdf direto da Zapfy :)",
    "base64": "https://www.africau.edu/images/default/sample.pdf",
    "fileName": "sample-pdf"
}

Enviar uma mensagem de documento

POST https://api.zapfy.me/v1/instance/{{instanceKey}}/token/{{instanceToken}}/message?type=document

Permite enviar uma mensagem de documento via rest para um contato no WhatsApp, note que essa mensagem será adicionada à uma fila e no momento da requisição será devolvido um id de identificação dessa mensagem, essa fila irá processar o envio da mensagem e depois irá chamar o webhookde delivery da instância que enviou a mensagem.

Após o envio, você receberá um webhook no método post na url da sua instância, veja a página de webhooks que temos aqui na documentação para melhor entendimento do que será enviado:

Webhooks

Path Parameters

Name
Type
Description

instanceKey*

String

instanceToken*

String

Query Parameters

Name
Type
Description

type*

String

Para envio de botões, valor deve ser audio

Request Body

Name
Type
Description

destination*

String

Número de telefone do usuário ou id de um grupo.

Exemplo: (556195514650)

Necessário conter DD e DDI.

base64*

String

Base64 do documento ou url para o documento

text

String

Texto para a mensagem

fileName*

String

Nome do documento a ser exibido

{
    "result": {
        "id": "0d5f9971-7dbd-4ecb-b82f-ab097d7ea5d8"
    },
    "message": "MESSAGE_SCHEDULED",
    "isValid": true
}

Webhooks disparados após o envio

O envio dessa mensagem resultará em webhooks do tipo Envio de document message e Alteração de status da mensagem

Last updated