Pular para o conteúdo

Glossário

Os termos são definidos conforme a API os usa. Quando uma palavra também tem um sentido cotidiano mais amplo, o sentido da API é o que prevalece.

TermoSignificado
identificadorA única coisa sobre a qual uma verificação em tempo real trata: um número de telefone ou um endereço de e-mail. Um envio em lote carrega uma lista deles.
sérieSe um identificador é um phone ou um email. Produtos, endpoints e requisições são todos específicos de uma série, e uma requisição só pode misturar séries no sentido de que não pode misturá-las de forma alguma.
produtoUm alvo de detecção — uma plataforma, mais o tipo de verificação feita contra ela. “WhatsApp Number Checker” e “WhatsApp Activity Details” são dois produtos diferentes, embora ambos digam respeito ao WhatsApp.
produto de tempo realUm produto usado pelos endpoints síncronos. Endereçado pelo seu ID numérico.
produto em loteUm produto usado pelos endpoints assíncronos. Endereçado pelo seu slug.
IDO inteiro que identifica um produto de tempo real, exibido como #47 no catálogo. Os IDs são o que product_ids aceita.
slugA string que identifica um produto em lote, por exemplo waValid. Os slugs são o que o campo product aceita.
moderealtime ou async. Um produto pertence a exatamente um, e o modo decide quais endpoints o aceitam.
TermoSignificado
registradoO que a detecção de fato responde: este identificador está registrado nesta plataforma? Não é uma afirmação sobre se o número ou endereço é sintaticamente válido, alcançável ou está em serviço.
validConfirmado como registrado. Cobrado.
invalidConfirmado como não registrado. Cobrado — uma resposta negativa ainda é uma resposta.
unknownO provedor não conseguiu resolvê-lo. Não cobrado; reembolsado.
cachedO veredito veio de um fato armazenado, e não de consultar um fornecedor. Um acerto de cache ainda é cobrado.
comboUma requisição de tempo real, um identificador e os produtos, de um a dez, contra os quais ele foi verificado. Um combo pode ter sucesso parcial — consulte partial_succeeded.
TermoSignificado
reservarRetirar o valor antecipadamente antes de o trabalho ser executado. Todo envio é reservado contra o saldo da conta.
liquidarDecidir a cobrança final de um item individual assim que seu veredito é conhecido.
reembolsarDevolver o valor reservado de um item que não produziu um veredito utilizável.
billing_statusCampo por item: charged ou refunded. Leia este campo em vez de inferir a partir do status HTTP.
total_reservedReservado antes de o trabalho ser executado. Sempre é igual a total_charged + total_refunded.
charged_amountCobrança líquida. refunded_amount é o reembolso líquido.
TermoSignificado
request_idUUID que identifica um envio de tempo real. Informe-o em solicitações de suporte.
task_idO token que identifica um envio em lote, retornado no momento do envio. Também é o parâmetro de caminho {token} dos endpoints de tarefa — um valor, dois nomes na documentação.
Idempotency-KeyUm cabeçalho fornecido pelo chamador, obrigatório nas chamadas de tempo real, que torna uma nova tentativa segura: a mesma chave com o mesmo corpo retorna o resultado armazenado em vez de cobrar de novo.
replayedA resposta veio de um resultado armazenado, e não de trabalho novo. replayed em uma resposta de tempo real, idempotent_replay em um envio em lote. Uma repetição nunca movimenta dinheiro.
recovery_pendingA tarefa em lote está na fila, mas sua contabilização ainda está sendo reconciliada.
TermoSignificado
submittedLinhas que você enviou.
prefilteredLinhas descartadas antes da detecção — linhas malformadas, por exemplo.
dedupedLinhas duplicadas removidas.
totalLinhas de fato verificadas: submitted menos prefiltered menos deduped.
processedLinhas que o canal upstream concluiu até agora.
unknown_unprocessedLinhas que nunca foram resolvidas. Estas são as que são reembolsadas.
TermoSignificado
limite por chaveO orçamento associado à sua chave de API. É com ele que você deve planejar.
limite por IPUm teto mais grosseiro, compartilhado por todas as chaves atrás de um mesmo endereço. Não é um controle de acesso.
retençãoPor quanto tempo um registro sobrevive. Logs de tempo real e resultados de repetição: 30 dias. Arquivos de resultado em lote: 7 dias.