Programadores

GET/tcr/v2/brand/{brandId}/externalVetting

Consulte os resultados de avaliação de uma marca

Consulte os resultados de avaliação de uma marca da sua conta e acompanhe uma análise existente pelos resultados pendentes, bem-sucedidos ou malsucedidos.

Nesta página
  1. Selecione a marca que deseja consultar
  2. Acompanhe uma análise existente
  3. Entenda as cobranças de um pedido anterior
  4. Repita a consulta sem fazer outro pedido
  5. Mantenha as etapas de registro separadas
  6. Requisição
  7. Resposta
  8. Erros
  9. Disponibilidade e efeitos colaterais

Selecione a marca que deseja consultar

Use o identificador da marca da sua conta. Mantenha-o junto aos registros de avaliação obtidos para que a análise de uma empresa não seja confundida com a de outra. Não use identificadores de outra conta.

Acompanhe uma análise existente

Mantenha os valores de vettingId, evpId, vettingClass e vettingStatus quando estiverem presentes. A sincronização atual considera PENDING e UNSCORE como resultados que ainda aguardam verificações adicionais, e ACTIVE e FAILED como resultados finais para fins de liquidação da cobrança. Leia os detalhes retornados antes de decidir se é necessário algum acompanhamento. Uma lista vazia, por si só, não comprova que um envio anterior não chegou ao registro.

Entenda as cobranças de um pedido anterior

Consultar o status não solicita outra análise. No entanto, pode reconciliar um resultado concluído e liquidar a cobrança vinculada a uma solicitação anterior de análise faturável. Isso inclui uma cobrança por falha, quando aplicável. Use o preço e as condições revisados no momento do pedido; não deduza o preço atual a partir de um exemplo antigo ou de uma resposta de status.

Repita a consulta sem fazer outro pedido

Em caso de falha transitória, mantenha o identificador da marca e os identificadores de avaliação conhecidos, respeite Retry-After e repita esta consulta aumentando progressivamente o intervalo entre as tentativas. Não faça um novo pedido de análise apenas porque a consulta de status falhou ou retornou um corpo inesperado. Se a divergência persistir, entre em contato com a MultiTEL e informe os identificadores de referência pertinentes por um canal de suporte autenticado.

Mantenha as etapas de registro separadas

A avaliação estabelece um resultado de análise para a marca. A qualificação da campanha, o registro da campanha e a atribuição de números continuam sendo etapas separadas. Verifique o status atual e os requisitos dessas etapas antes de enviar mensagens.

Requisição

Use uma conta com acesso à API habilitado por HTTPS, a partir de um endereço IP de origem permitido. Use as credenciais da sua conta, não as credenciais do registro. A marca deve estar associada à conta autenticada.

Use GET com o identificador da marca no caminho e o filtro de consulta obrigatório vettingStatus. O esquema revisado define um vetor de status; este exemplo solicita um único valor ACTIVE. Este guia não estabelece como codificar vários valores nem confirma que o provedor aceite requisições sem filtro. Não é necessário um corpo de requisição.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Parâmetros de caminho
NomeTipoObrigatórioDescrição
brandIdcadeia de caracteresSimO identificador da marca no registro associado à sua conta MultiTEL. Não é o identificador da sua conta nem um identificador de avaliação.
Parâmetros de consulta
NomeTipoObrigatórioDescrição
vettingStatusvetor de cadeias de caracteresSimFiltro de status obrigatório. Valores permitidos: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. O exemplo fornece um único valor ACTIVE; não se afirma como codificar vários valores nem que o provedor aceite requisições sem filtro.

Resposta

A rota atual preserva o status HTTP e o corpo da resposta do registro em vez de usar o envelope de resposta da versão legada v3. O vetor fictício abreviado ilustra os campos utilizados pelo fluxo de sincronização local; não é uma resposta capturada do registro nem um esquema cuja completude seja garantida. Verifique o status HTTP e o JSON antes de ler os registros. Mantenha cada vettingId junto à marca selecionada.

Estrutura ilustrativa de resposta; não contém dados de conta em tempo real nem constitui uma cotação atual.

[
  {
    "vettingId": "example-vetting-id",
    "evpId": "example-review-provider",
    "vettingClass": "STANDARD",
    "vettingStatus": "ACTIVE"
  }
]

Erros

  • 401: Falha na autenticação da conta. Verifique as credenciais, se o acesso à API está habilitado e as restrições aplicáveis ao IP de origem.
  • 404: A marca não está associada a esta conta ou o registro não conseguiu encontrá-la. A recusa por falta de titularidade da conta ocorre antes da requisição ao registro.
  • 429: O limite de requisições da conta ou do registro foi atingido. Respeite Retry-After e aumente progressivamente o intervalo entre as tentativas.
  • 502/503: O transporte, o registro, o limitador de requisições ou o processamento local está indisponível. Um erro não comprova que uma solicitação anterior de análise falhou.

Disponibilidade e efeitos colaterais

  • Esta requisição GET não faz um novo pedido de avaliação. Ela obtém resultados do registro, grava registros de auditoria da requisição e sincroniza os resultados armazenados.
  • Consultar um resultado concluído pode liquidar a cobrança de um pedido faturável de avaliação feito anteriormente. Uma análise malsucedida pode gerar uma cobrança por falha, quando aplicável. Revise o preço e as condições ao fazer o pedido; esta consulta não constitui uma cotação de preço.
  • Um registro recém-descoberto e importado por esta requisição GET não é automaticamente classificado como um novo pedido faturável.
  • Um resultado de avaliação bem-sucedido ou ACTIVE não equivale à aprovação de campanha, à atribuição de número de telefone nem à permissão para enviar mensagens.