GET
https://www.allpost.com.br/api/v1/chat/{idPedido}/anexo
Download autenticado de um anexo do chat (bucket S3 privado); o caminho é obtido em mensagens[].anexos[].url do endpoint 145
Módulo: Transportadora
Descrição
Faz o download autenticado de um anexo do chat com a transportadora. Como o bucket S3 é privado, este endpoint é a única forma de recuperar o conteúdo binário de um arquivo anexado a uma mensagem.
Exemplo:
- https://www.allpost.com.br/api/v1/chat/{idPedido}/anexo?caminho=chat/anexos/{idChat}/arquivo.png
- https://www.allpost.com.br/api/v1/chat/{idPedido}/anexo?caminho=chat/anexos/{idChat}/arquivo.png&modo=inline
O caminho do anexo é obtido na resposta do endpoint 145 (GET chat), no campo mensagens[].anexos[].url.
O endpoint valida que o anexo pertence a uma mensagem do chat do pedido informado (impede acesso arbitrário ao S3).
Parâmetro modo:
- inline: exibe o arquivo no navegador (útil para preview de imagens).
- attachment (default): força download do arquivo.
Códigos de retorno:
- 200: stream binário do arquivo com Content-Type correto (image/png, application/pdf, etc.).
- 400: parâmetros obrigatórios ausentes.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido, chat ou anexo não encontrado.
Exemplo:
- https://www.allpost.com.br/api/v1/chat/{idPedido}/anexo?caminho=chat/anexos/{idChat}/arquivo.png
- https://www.allpost.com.br/api/v1/chat/{idPedido}/anexo?caminho=chat/anexos/{idChat}/arquivo.png&modo=inline
O caminho do anexo é obtido na resposta do endpoint 145 (GET chat), no campo mensagens[].anexos[].url.
O endpoint valida que o anexo pertence a uma mensagem do chat do pedido informado (impede acesso arbitrário ao S3).
Parâmetro modo:
- inline: exibe o arquivo no navegador (útil para preview de imagens).
- attachment (default): força download do arquivo.
Códigos de retorno:
- 200: stream binário do arquivo com Content-Type correto (image/png, application/pdf, etc.).
- 400: parâmetros obrigatórios ausentes.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido, chat ou anexo não encontrado.
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| idPedido | string | Sim | Identificador do pedido (_id, numeroPedido, chaveNFe — use `chave` e `canal` para alternativas). |
| caminho | string | Sim | Caminho relativo do anexo no S3 (obtido em mensagens[].anexos[].url do endpoint 145). |
| modo | string | Não | "inline" (exibe no navegador) ou "attachment" (download). Default: attachment. |
| chave | string | Não | Tipo de identificador do pedido: "pedido", "numeropedidocanal", "chavenf" (default: _id). |
| canal | string | Não | Canal (obrigatório quando chave=numeropedidocanal). |
Response
Sucesso (200):
Stream binário do arquivo. Headers relevantes:
Content-Type: image/png
Content-Disposition: inline; filename="2.png"
Content-Length: 45231
Erro (JSON):
{
"mensagem": "Anexo não encontrado."
}