Visão geral

A página de logs da API mostra o que está acontecendo com a atividade da sua API em tempo real, em toda a sua conta. Ela foi criada para lhe dar tranquilidade, para que você possa ver rapidamente o que está funcionando, identificar problemas com antecedência e entender como seus sistemas estão se comunicando.

Os logs são mantidos por 7 dias e incluem:

Solicitações bem-sucedidas
Solicitações com falha
Logs detalhados para cada solicitação
Payloads completos de solicitação e resposta

Você pode usar esta página para verificar se as solicitações foram entregues com sucesso, investigar quaisquer erros e rastrear a atividade em todos os seus serviços conectados, tudo em uma única exibição simples.

Acessando a página de logs da API

No menu à esquerda, procure por Desenvolvedores.
Clique em Ferramentas do desenvolvedor > Logs da API

Componentes

1. Resumo: 'Sua atividade recente'

Essas métricas oferecem visibilidade instantânea do uso da sua API.
Mostra os números gerais para o intervalo de datas selecionado:

Total de solicitações: Todas as solicitações de API feitas.
Bem-sucedidas: Solicitações retornando status 200 e 201
Com falha: Solicitações retornando status 400, 401, 403, 404 e 50

2. Pesquisa, Filtros & Aplicar

O recurso de Pesquisa e Filtros ajuda você a encontrar rapidamente os logs que está procurando. Você pode pesquisar por palavras-chave, filtrar por status ou restringir por data para se concentrar nas solicitações que mais importam.

Essa funcionalidade se aplica às quatro páginas de logs que são carregadas inicialmente. Para pesquisar ou filtrar por mais registros, basta carregar páginas adicionais clicando nas próximas páginas, sua pesquisa e filtros se aplicarão também aos logs recém-carregados.

Pesquisar
Digite palavras inteiras ou parciais, e a pesquisa examinará todos os campos a seguir para ajudar você a encontrar rapidamente o que precisa.
Aqui estão as possíveis opções de pesquisa:
- Ponto de extremidade da API: O caminho específico da API sendo chamado.
- ID da solicitação: Um identificador exclusivo atribuído automaticamente a cada solicitação de API.
- Origem: De onde a solicitação se originou (por exemplo, API, painel, subconta).
- Corpo: O conteúdo da solicitação, incluindo o texto da mensagem e os parâmetros.
- País: O país de destino da mensagem com base no número do destinatário.
- ID do remetente: O valor "de" usado ao enviar a mensagem (alfanumérico ou número).
- Código de resposta: O código numérico do sistema retornado após o processamento da solicitação.
- Mensagem de resposta: Uma breve mensagem explicando o código de resposta.
- Código de erro: o status HTTP da chamada
- Mensagem de erro: Uma breve explicação do que causou o erro.
- ID da mensagem: O identificador exclusivo para a mensagem individual uma vez na fila ou enviada.
Filtros
- Status: Filtrar por sucesso, erros do cliente ou erros do servidor.
- Ponto de extremidade: Filtrar por exemplo, /v3/sms/send, /v3/mms/send, /v3/sms/history, etc.
- Subconta: Por padrão, será a sua subconta.
- Intervalo de datas: Mantemos os logs apenas por 7 dias Você pode selecionar a partir destas opções:
  - Hoje
  - Últimas 12 horas
  - Últimas 24 horas
  - 2 dias atrás
  - 3 dias atrás
  - 4 dias atrás
  - 5 dias atrás
  - Há 6 dias
“Nota: Ao usar o filtro 'Há 2 dias', ele exibirá todos os logs dos últimos dois dias, incluindo hoje.
Botões
- Limpar filtros: Redefine todos os filtros, incluindo a Pesquisa.
- Aplicar: Use para aplicar seus filtros atuais e pesquisa. Você pode clicar em 'Aplicar' ou apenas pressionar Enter para executar a pesquisa.

3. Tabela de logs

Exibe todas as solicitações de API com base em seus filtros. As colunas incluem:

Use esta tabela para analisar rapidamente a atividade ou identificar chamadas com falha.

Classificação:

Você pode classificar por qualquer coluna, como Carimbo de data/hora ou Status.
Clicar em um cabeçalho de coluna alterna entre as ordens crescente e decrescente.
Isso ajuda você a agrupar erros, atividades recentes ou pontos de extremidade específicos de forma mais eficiente.

Interações:

Clicar em uma linha abre os detalhes completos da solicitação no painel direito.
A paginação permite pesquisar todos os logs e carrega os próximos dados.
A opção Atualizar tabela recarrega os logs mais recentes.
Classificação de ordenação

Painéis detalhados de logs (Metadados, Solicitação e Resposta)
Ao selecionar uma linha, os detalhes completos são exibidos.

O painel de Metadados inclui:
- Método
- Status
- Status da mensagem (ex.: 200 Sucesso)
- ID da solicitação
- Subconta
- Carimbo de data/hora
- Endereço IP do cliente
- Agente do usuário
Esta seção ajuda a identificar de onde a solicitação veio (Postman, servidor, navegador, etc.).

Corpo da solicitação
Mostra a carga exata enviada. Útil para:
- Depurar JSON malformado
- Verificar parâmetros
- Verificar métodos de autenticação
Corpo da resposta
Mostra a resposta exata retornada. Inclui:
- Códigos HTTP
- Mensagens de erro
- Códigos de resposta internos
- Dados de entrega e precificação (se aplicável)
Esta é a sua principal ferramenta para solucionar problemas como falhas, erros de mensagem ou cargas incorretas.

Casos de uso comuns

1. Depuração de chamadas de API com falha

Abrir o menu suspenso de filtro Status
Clicar em uma linha com 400 ou 500.
Revisar:
- Corpo da resposta (mensagem de erro)
- Corpo da solicitação (campos incorretos?)
- Ponto de extremidade usado
- Subconta que o acionou

2. Confirmar se o SMS/MMS foi enviado com sucesso

Aplicar filtro ao ponto de extremidade /v3/sms/send.
Verificar o status 200.
Inspecionar o corpo da resposta → Message queued for delivery.

3. Reprodução ou escalonamento de problemas

Copie os corpos da solicitação/resposta diretamente ao fazer a denúncia de problemas.

Dicas

Use a Pesquisa para encontrar rapidamente logs de um número de telefone ou palavra-chave específica.
Para problemas recorrentes, compare vários logs lado a lado.
Os logs são atualizados automaticamente quando 'Atualizar tabela' é clicado.
Use a carga de resposta para entender problemas de precificação ou entrega.

Perguntas frequentes

O que é a página de logs da API?

A página de logs da API permite que os desenvolvedores visualizem e monitorem todas as solicitações de API feitas por meio da conta deles. Ela ajuda no rastreamento das atividades de solicitação, na identificação de erros e na depuração de integrações em tempo real.

Quais informações posso ver nos logs da API?

Cada entrada de log inclui detalhes importantes, como:

Carimbo de data/hora – Quando a solicitação foi feita
Ponto de extremidade – Qual ponto de extremidade da API foi chamado
Status – Se a solicitação foi bem-sucedida ou falhou
Código de resposta – Código de status HTTP (ex.: 200, 400, 500)
ID da solicitação – Um identificador exclusivo para cada solicitação

O que são os contadores “Todos”, “Sucesso” e “Falha”?

Esses contadores resumem a atividade da sua solicitação de API:

Todos – Mostra o número total de chamadas de API feitas
Sucesso – Mostra a contagem de solicitações completadas com sucesso
Falha – Mostra a contagem de solicitações que resultaram em um erro

Como a paginação funciona na página de logs?

Os logs são exibidos em páginas para tornar a pesquisa mais rápida e fácil.

Use os controles de paginação (ex.: Próximo, Anterior ou páginas numeradas) para navegar pelo seu histórico de logs.

O que o botão “Atualizar” faz?

O botão Atualizar recarrega a tabela de logs para mostrar a atividade mais recente da API sem recarregar todo o painel.

Isso é útil durante o monitoramento de solicitações de API ao vivo.

Com que frequência os logs são atualizados?

Os logs são atualizados quase em tempo real. Você pode clicar manualmente em Atualizar para obter os dados mais recentes instantaneamente.

Até que data no passado posso visualizar os logs da API?

Você pode visualizar logs dos últimos 7 dias.

Os logs mais antigos podem ser arquivados ou excluídos automaticamente.

Posso exportar meus logs da API?

Atualmente, a funcionalidade de exportação pode não estar disponível diretamente na página.

Posso pesquisar ou aplicar filtro aos meus logs da API?

Sim Você pode aplicar filtro aos logs por:

Status (Sucesso, Falha)
Intervalo de datas
Ponto de extremidade
Pesquisa - digite qualquer palavra-chave

O que devo fazer se uma solicitação falhar?

Você pode:

Clicar na entrada de log com falha para visualizar detalhes e mensagens de erro
Verificar o código de resposta e o corpo do erro
Usar esses dados para solucionar problemas da sua integração de API

Quem pode acessar a página de logs da API?

A conta e a subconta podem acessar e visualizar os logs da API delas. Neste lançamento, foi desenvolvido que as subcontas só podem visualizar as suas próprias.

Guia de logs da API