GET api/v1/chat/{idPedido}

GET

https://www.allpost.com.br/api/v1/chat/{idPedido}

Consulta mensagens do chat com a transportadora de um pedido; cada mensagem inclui a lista anexos quando houver arquivos vinculados

Módulo: Transportadora

Descrição

Consulta as mensagens do chat com a transportadora de um pedido.
Exemplo:
- https://www.allpost.com.br/api/v1/chat/665f1c2a3fdb9612b7f43261

Além do id interno do pedido, é possível identificar o pedido pelo número do pedido, número do pedido no canal ou chave da NF-e, informando o parâmetro chave na querystring (ver "Parâmetros de Path").

Retorna os dados da conversa e o histórico de mensagens ordenado cronologicamente (do mais antigo para o mais recente), limitado a 500 mensagens.
Quando uma mensagem possui anexos, ela inclui o campo anexos — uma lista com url, nome, data e o autor do arquivo (idUsuario/nomeUsuario e idTransportadora quando enviado pela transportadora). Mensagens sem anexo não trazem o campo, preservando o formato anterior. Os anexos são enviados junto ao texto pelo endpoint POST api/v1/chat/{idPedido}/mensagem.
As conversas são isoladas por loja: somente o chat de pedidos pertencentes à loja autenticada pelo token é retornado.
Caso o pedido não possua conversa, o retorno é {"mensagens": [], "situacao": "sem_conversa"}.

Códigos de retorno:
- 200: sucesso.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido não encontrado.
- 429: limite de requisições excedido.

Parâmetros de Path

Campo	Descrição	Tipo	Obrigatório
idPedido	Identificador do pedido no allPost. Por padrão é o id interno do pedido; combinado com o parâmetro `chave` (querystring) pode ser também o número do pedido, o número do pedido no canal ou a chave da NF-e.	string	sim
chave	Querystring opcional que define como o valor de `idPedido` deve ser interpretado. Quando ausente, usa o id interno do pedido. Valores aceitos: `id`/`documento` (id interno, padrão), `pedido`/`numeropedido` (número do pedido), `numeropedidocanal` (número do pedido no canal — exige `canal`), `chavenf`/`chavenfe` (chave da NF-e).	string	não
canal	Querystring obrigatória apenas quando `chave=numeropedidocanal`. Identifica o canal de venda do pedido.	string	não

Exemplos:
- por número do pedido: api/v1/chat/PED-10023?chave=pedido
- por número do pedido no canal: api/v1/chat/12345?chave=numeropedidocanal&canal=mercadolivre
- por chave da NF-e: api/v1/chat/32000000000000000000000000000000000000000000?chave=chavenf

Parâmetros de Retorno

Campo	Descrição	Tipo
_id	Identificador da conversa de chat.	string
situacao	Situação da conversa (ex.: aberto, finalizado). Quando não há conversa retorna "sem_conversa".	string
subSituacao	Subsituação da conversa (ex.: aguardandoRespostaTransportadora, aguardandoRespostaLoja).	string
tipoPedido	Tipo do pedido: envio ou reversa.	string
nomeTransportadora	Nome da transportadora da conversa.	string
mensagens	Lista de mensagens ordenada cronologicamente (máx. 500).	array
mensagens[].id	Identificador da mensagem.	string
mensagens[].data	Data/hora da mensagem em ISO 8601 (YYYY-MM-DDTHH:mm:ss).	string
mensagens[].mensagem	Conteúdo da mensagem.	string
mensagens[].origem	Origem da mensagem: loja ou transportadora.	string
mensagens[].nomeUsuario	Nome do usuário que enviou a mensagem.	string
mensagens[].anexos	Lista de anexos da mensagem. Presente somente quando a mensagem possui anexos (mensagens sem anexo não trazem o campo).	array
mensagens[].anexos[].url	Caminho/URL do arquivo no armazenamento.	string
mensagens[].anexos[].nome	Nome do arquivo.	string
mensagens[].anexos[].data	Data/hora do upload em ISO 8601 (YYYY-MM-DDTHH:mm:ss).	string
mensagens[].anexos[].idUsuario	Identificador do usuário que enviou o anexo.	inteiro
mensagens[].anexos[].nomeUsuario	Nome do usuário que enviou o anexo.	string
mensagens[].anexos[].idTransportadora	Identificador da transportadora quando o anexo foi enviado por um usuário de transportadora; `null` quando enviado pela loja.	inteiro

Response

{
    "_id": "3f2a1c8b9d4e5f6071829abc",
    "situacao": "aberto",
    "subSituacao": "aguardandoRespostaTransportadora",
    "tipoPedido": "reversa",
    "nomeTransportadora": "Correios",
    "mensagens": [
        {
            "id": "a1b2c3d4",
            "data": "2025-01-15T10:32:00",
            "mensagem": "Bom dia, qual o status da coleta?",
            "origem": "loja",
            "nomeUsuario": "Atendente HelpyGo"
        },
        {
            "id": "e5f6g7h8",
            "data": "2025-01-15T10:40:00",
            "mensagem": "Segue o comprovante em anexo",
            "origem": "loja",
            "nomeUsuario": "Atendente HelpyGo",
            "anexos": [
                {
                    "url": "chat/anexos/3f2a1c8b/comprovante.pdf",
                    "nome": "comprovante.pdf",
                    "data": "2025-01-15T10:40:00",
                    "idUsuario": 87,
                    "nomeUsuario": "Atendente HelpyGo",
                    "idTransportadora": null
                }
            ]
        }
    ]
}

// Quando o pedido nao possui conversa de chat:
{
    "mensagens": [],
    "situacao": "sem_conversa"
}