v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Envio

Documento

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.

post/v1/send/document

Request body

tostring nullable

fromstring nullable

sessionIdstring uuid nullable

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

refIdstring uuid nullable

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

delayTypinginteger nullable

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

callbackUrlstring nullable

URL para receber webhook quando a mensagem for enviada ou falhar

senderIdstring nullable

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

fileIdOrUrlstring required

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.

textstring nullable

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

Response

Success

idstring uuid

createdAtstring date-time

updatedAtstring date-time nullable

companyIdstring uuid

sessionIdstring uuid nullable

senderIdstring nullable

statusUrlstring nullable

sentAtstring date-time nullable

failedReasonstring nullable

callbackUrlstring nullable

waitReplyboolean nullable