VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: moderação de mídia

Fila de mídias

Lista a fila de moderação das mídias que clientes enviam pelo WhatsApp e lê um item.

Quando um cliente manda uma foto, um vídeo, um áudio ou um documento pelo WhatsApp, a plataforma guarda um item na fila de moderação. Estas duas rotas só leem a fila: uma lista com filtros e a outra abre um item.

Listar a fila

Devolve os itens da fila, os pendentes primeiro e, dentro de cada grupo, os mais recentes antes. Use os filtros para trabalhar só uma categoria por vez.

GET/api/v1/admin/whatsapp/media-moderationAdmin

Lista a fila de moderação de mídias

Parâmetros de consulta

statusstring
pendingapprovedrejectedflaggedescalated
Filtra por estado. Um valor desconhecido não gera erro: a lista volta vazia.
media_typestring
imagevideoaudiodocument
Filtra pelo tipo de mídia.
vendor_iduuid
Filtra por seller.
qstring
Busca por trecho na classificação automática e nas observações do moderador.
fromstring
Início do período de entrada na fila, em RFC 3339. Valor inválido é ignorado em silêncio.
tostring
Fim do período, em RFC 3339. Valor inválido é ignorado em silêncio.
limitintegerpadrão: 50
Itens por página. Valores menores que 1 ou maiores que 200 voltam para 50.
offsetintegerpadrão: 0
Quantos itens pular.

Exemplo de requisição (Listar a fila)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/media-moderation?status=pending&media_type=image&limit=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar a fila)

200Fila devolvida
json
{
  "rows": [
    {
      "id": "3f6c1d2a-8b44-4e0a-9c1e-5d7a2b9f0e11",
      "media_type": "image",
      "status": "pending",
      "vendor_id": "9d9d9d56-eb43-4719-889d-055632f7c7da",
      "thread_id": "5b1f0c7e-2a3d-4c88-9e41-0a7d6b3c9f22",
      "message_id": 156,
      "meta_media_id": "1234567890123456",
      "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "auto_classification": "possível produto danificado (embalagem rasgada)",
      "auto_classification_confidence": 0.87,
      "moderation_tags": [],
      "created_at": "2026-07-11T17:22:22.328404Z",
      "updated_at": "2026-07-11T17:22:22.328404Z"
    }
  ],
  "total": 1
}

Campos da resposta

rowsarray

Itens da página.

iduuid
Identificador do item da fila.
media_typestring
imagevideoaudiodocument
Tipo da mídia recebida.
statusstring
pendingapprovedrejectedflaggedescalated
Estado do item. Depende da loja: a maioria devolve a palavra (pending), algumas guardam uma letra (P, A, R, F, E). Para filtrar, envie a palavra.
vendor_iduuid
Seller dono da conversa. Ausente quando não há.
thread_iduuid
Conversa de origem. Ausente quando não há.
message_idinteger
Id numérico da mensagem de WhatsApp que trouxe a mídia.
meta_media_idstring
Id da mídia na Meta.
sha256string
Impressão digital (SHA-256, hexadecimal) do arquivo. Ausente quando não calculada.
auto_classificationstring
Descrição gerada automaticamente sobre o conteúdo da mídia. Ausente quando não houve análise.
auto_classification_confidencenumber
Confiança da classificação automática, de 0 a 1.
moderator_user_iduuid
Quem decidiu. Ausente enquanto pending.
moderator_notesstring
Observação registrada na decisão.
moderation_tagsarray
Etiquetas registradas na decisão. Lista vazia quando não há.
moderated_atstring
Data da decisão (RFC 3339). Ausente enquanto pending.
created_atstring
Quando a mídia entrou na fila (RFC 3339, UTC).
updated_atstring
Última alteração do item (RFC 3339, UTC).
totalinteger
Total de itens que casam com os filtros, sem contar a paginação.

Erros (Listar a fila)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} (ou manage_orders) ou {"error":"admin access required"}
500Falha ao consultar a fila.{"error":"Failed to list media moderation rows: ..."}
Quem aparece na fila

Cada mídia que um cliente envia pelo WhatsApp (imagem, vídeo, áudio ou documento) entra na fila como pending. A API só lê e registra decisões: não existe rota para criar um item.

Ver um item

Devolve um item da fila pelo id. A resposta embrulha o item em row.

GET/api/v1/admin/whatsapp/media-moderation/{id}Admin

Lê um item da fila de moderação

Parâmetros de caminho

iduuidobrigatório
Id do item da fila.

Exemplo de requisição (Ver um item)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/media-moderation/3f6c1d2a-8b44-4e0a-9c1e-5d7a2b9f0e11" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Ver um item)

200Item devolvido
json
{
  "row": {
    "id": "3f6c1d2a-8b44-4e0a-9c1e-5d7a2b9f0e11",
    "media_type": "image",
    "status": "pending",
    "vendor_id": "9d9d9d56-eb43-4719-889d-055632f7c7da",
    "thread_id": "5b1f0c7e-2a3d-4c88-9e41-0a7d6b3c9f22",
    "message_id": 156,
    "meta_media_id": "1234567890123456",
    "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "auto_classification": "possível produto danificado (embalagem rasgada)",
    "auto_classification_confidence": 0.87,
    "moderation_tags": [],
    "created_at": "2026-07-11T17:22:22.328404Z",
    "updated_at": "2026-07-11T17:22:22.328404Z"
  }
}

Campos da resposta

rowobject

O item, com os mesmos campos da listagem.

iduuid
Identificador do item da fila.
media_typestring
imagevideoaudiodocument
Tipo da mídia recebida.
statusstring
pendingapprovedrejectedflaggedescalated
Estado do item. Depende da loja: a maioria devolve a palavra (pending), algumas guardam uma letra (P, A, R, F, E). Para filtrar, envie a palavra.
vendor_iduuid
Seller dono da conversa. Ausente quando não há.
thread_iduuid
Conversa de origem. Ausente quando não há.
message_idinteger
Id numérico da mensagem de WhatsApp que trouxe a mídia.
meta_media_idstring
Id da mídia na Meta.
sha256string
Impressão digital (SHA-256, hexadecimal) do arquivo. Ausente quando não calculada.
auto_classificationstring
Descrição gerada automaticamente sobre o conteúdo da mídia. Ausente quando não houve análise.
auto_classification_confidencenumber
Confiança da classificação automática, de 0 a 1.
moderator_user_iduuid
Quem decidiu. Ausente enquanto pending.
moderator_notesstring
Observação registrada na decisão.
moderation_tagsarray
Etiquetas registradas na decisão. Lista vazia quando não há.
moderated_atstring
Data da decisão (RFC 3339). Ausente enquanto pending.
created_atstring
Quando a mídia entrou na fila (RFC 3339, UTC).
updated_atstring
Última alteração do item (RFC 3339, UTC).

Erros (Ver um item)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} (ou manage_orders) ou {"error":"admin access required"}
404Nenhum item com esse id.{"error":"moderation row not found"}
500O id não é um UUID válido (a plataforma devolve 500 em vez de 400).{"error":"Failed to fetch moderation row: scan media moderation row: pq: invalid input syntax for type uuid: \"xyz\" (22P02)"}

Veja também

  • Decidir um item
  • Decisões em lote
  • Visão geral
Anterior
WhatsApp: moderação de mídia
Próxima
Decidir um item
Nesta página
  • Listar a fila
  • Exemplo de requisição (Listar a fila)
  • Resposta (Listar a fila)
  • Erros (Listar a fila)
  • Ver um item
  • Exemplo de requisição (Ver um item)
  • Resposta (Ver um item)
  • Erros (Ver um item)
  • Veja também