Enviar mídia
Envie imagem, vídeo, áudio ou documento com a mesma operação.
/functions/v1/erp-whatsapp-bridgesend-mediaBearer AuthKeyCabeçalhos obrigatóriosAuthKey + JSON
AuthorizationBearer SUA_AUTHKEYContent-Typeapplication/jsonCorpo da requisiçãoJSON
Envie os campos abaixo junto com a ação da operação.
_actionstringObrigatórioIdentifica a operação neste endpoint. Use "send-media".
instance_idstringOpcional*UUID da instância retornado pela API. Informe este campo ou appkey; não use o ID do dispositivo no seu banco.
appkeystringOpcional*Nome da instância retornado em instance_name. Alternativa ao instance_id.
require_instancebooleanOpcional*Recomendado true para exigir a instância selecionada.
phonestringObrigatório*Destino com DDI + DDD + número, apenas dígitos. Para vários destinos, use para ou to como array em vez de phone.
media_typestringObrigatório*Tipo da mídia.
media_urlstringOpcional*URL HTTP(S) pública e acessível pelo servidor. Alternativa a media_base64 ou media_data_uri.
media_base64stringOpcional*Conteúdo Base64 puro; informe mime_type. Não enviar junto com outra fonte de mídia.
media_data_uristringOpcional*Alternativa completa no formato data:TIPO_MIME;base64,CONTEUDO.
mime_typestringOpcional*MIME real, por exemplo application/pdf ou video/mp4.
file_namestringOpcional*Nome do arquivo com extensão, especialmente para documentos.
captionstringOpcional*Legenda opcional; o suporte depende do tipo de mídia.
pttbooleanOpcional*Para áudio: true por padrão (mensagem de voz). Prefira Ogg/Opus para voz.
secondsnumberOpcional*Duração opcional do áudio, em segundos.
waveformarrayOpcional*Forma de onda opcional do áudio.
* Condições e alternativas estão descritas em cada campo. Quando necessário, selecione a instância por instance_id ou appkey. Um array de destinos pode substituir phone nos envios.
Comportamento e cuidados
- A instância precisa estar conectada e pertencer à empresa da AuthKey. require_instance=true evita a seleção automática de outra instância.
- Confira sent e total: success=true pode representar sucesso parcial em múltiplos destinatários. sent_to identifica os destinos aceitos; não significa confirmação de leitura.
- Não repita envios automaticamente após timeout: a API não oferece uma chave pública de idempotência. Registre send_id e request_id para investigar antes de tentar novamente.
- Para vários destinos use para, to ou recipients como array de strings. Eles substituem phone; o backend normaliza e elimina destinos duplicados. Destinatários em quarentena podem ser bloqueados.
- A URL example.com é ilustrativa: substitua por um arquivo real sob seu controle. Não exponha documentos privados em URLs permanentes.
- O JSON completo aceita até 16 MiB; Base64 aumenta o tamanho. O arquivo remoto também é validado pelo servidor. Um arquivo abaixo do limite pode ser recusado por formato ou pela sessão.
- Para vídeo use media_type=video e MIME compatível, como video/mp4. Para voz prefira Ogg/Opus; não há promessa de transcodificação de qualquer formato.
Tratamento de falhas
Confira o HTTP e os campos da resposta. Em falhas, preserve code e request_id para diagnóstico. HTTP 200 e success=true nem sempre significam envio completo ou exclusão confirmada.