API Reference
  1. Chat
  2. Envio

Documento

post
https://api.app.sevenbee.com.br/chat/v1/send/document

Envia uma mensagem de documento para um contato.
O campo FileIdOrUrl é obrigatório; informe uma URL pública ou o ID de um arquivo previamente cadastrado.
O arquivo deve seguir as regras do canal de atendimento (formato e tamanho).
O campo CallbackUrl permite receber webhook quando a mensagem for entregue ou falhar.
Este endpoint tem rate limit individual e permite 1000 requisições a cada 2 minutos.

Processamento 100% assíncrono: a resposta confirma apenas o enfileiramento (id). O status final chega via callback/webhook ou consulta em GET /v1/send/message/{id}.

Body Params

Dados para envio do documento.

string | null
string | null
options
object
uuid | null

ID do atendimento. (Opcional) Deve ser utilizado para atendimentos em tempo real, como respostas de IA externa.

uuid | null

ID da mensagem que está sendo respondida. Para resposta a uma mensagem

int32 | null

Tempo em segundos "digitando..." antes de entregar a mensagem.
Se fornecido o disparo será adiado, para que o contato consiga ver o digitando.
Para a API Oficial, utilize o endpoint específico para uma melhor experiência
Max.: 25 segundos

string | null

URL para receber webhook quando a mensagem for enviada ou falhar

string | null

ID de identificação no seu sistema para rastreamento e consulta da mensagem.

string
required
length ≥ 1

Informe uma URL (com acesso público) do arquivo ou o Id de um arquivo. O arquivo enviado deverá seguir as regras do canal de atendimento.

string | null

Legenda a ser enviada junto com o arquivo. O suporte a legenda depende do canal de atendimento.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?