Logo

Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

Endpoints

  • GET /api/external/usage/status/{requestId}
  • GET /api/external/usage/logs

Escopo necessario: whatsapp:send

Estes endpoints permitem acompanhar o ciclo de vida das operacoes assincronas (mensagens, templates, emails, flows) feitas pela API. Veja Idempotencia e Requisicoes Assincronas para o fluxo completo.

Consultar status de uma requisicao

GETBuscar/api/external/usage/status/{requestId}

Busca o status atual de uma requisicao assincrona pelo requestId.

Escopo: whatsapp:sendSincrono — responde 200 com os dados

Use o requestId retornado por um endpoint de envio.

Exemplo:

Resposta:

Campos:

  • operationType: send_message, send_template, send_email, trigger_flow, webhook_delivery
  • status: pending, processing, success, failed
  • whatsappMessageId / conversationId: preenchidos apos o processamento de envios de WhatsApp
  • flowId / executionId: preenchidos em disparos de flow
  • errorMessage / errorCode: preenchidos quando status = failed

Erros:

  • 404 quando o requestId nao existe no workspace

Listar logs de uso

GETBuscar/api/external/usage/logs

Busca o historico de requisicoes do workspace, com filtros.

Escopo: whatsapp:sendSincrono — responde 200 com os dados

Lista o historico de requisicoes do workspace, com filtros.

Query params
pagenumberopcionaldefault: 1

Numero da pagina.

limitnumberopcionaldefault: 50

Itens por pagina.

operationTypestringopcional

send_message, send_template ou webhook_delivery.

statusstringopcional

pending, processing, success ou failed.

apiKeyIdstringopcional

Filtra por uma API key especifica.

fromstring (ISO)opcional

Data inicial.

tostring (ISO)opcional

Data final.

Exemplo:

Resposta (estrutura paginada com a lista de logs e o total).

Erros comuns

  • 400 parametro invalido
  • 401 API key invalida
  • 403 escopo insuficiente
  • 404 requestId nao encontrado

Última atualização

15 de junho de 2026

Editar esta página no GitHub