Desarrolladores

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

Consulte los resultados de evaluación de una marca

Consulte los resultados de evaluación de una marca de su cuenta y siga una revisión existente a través de sus resultados pendientes, satisfactorios o fallidos.

En esta página
  1. Seleccione la marca que desea consultar
  2. Haga el seguimiento de una revisión existente
  3. Comprenda los cargos de una solicitud anterior
  4. Reintente la consulta sin realizar otra solicitud de revisión
  5. Mantenga separados los pasos de registro
  6. Petición
  7. Respuesta
  8. Errores
  9. Disponibilidad y efectos secundarios

Seleccione la marca que desea consultar

Utilice el identificador de marca de su cuenta. Consérvelo junto con los registros de evaluación obtenidos para evitar confundir la revisión de una empresa con la de otra. No utilice identificadores de otra cuenta.

Haga el seguimiento de una revisión existente

Conserve los valores de vettingId, evpId, vettingClass y vettingStatus cuando estén presentes. La sincronización actual considera PENDING y UNSCORE como resultados que aún requieren comprobaciones adicionales, y ACTIVE y FAILED como resultados definitivos a efectos de liquidación del cargo. Lea los detalles devueltos antes de decidir si es necesario realizar algún seguimiento. Una lista vacía por sí sola no demuestra que un envío anterior no haya llegado al registro.

Comprenda los cargos de una solicitud anterior

Consultar el estado no solicita otra revisión. Sin embargo, puede conciliar un resultado completado y liquidar el cargo asociado a una solicitud anterior de revisión facturable. Esto incluye el cargo por fallo que corresponda. Utilice el precio y las condiciones revisados al realizar la solicitud; no deduzca el precio actual a partir de un ejemplo antiguo ni de una respuesta de estado.

Reintente la consulta sin realizar otra solicitud de revisión

Ante un fallo transitorio, conserve el identificador de marca y los identificadores de evaluación conocidos, respete Retry-After y reintente esta consulta aumentando progresivamente el tiempo de espera entre intentos. No realice una nueva solicitud de revisión solo porque la consulta de estado haya fallado o haya devuelto un cuerpo inesperado. Si la discrepancia persiste, póngase en contacto con MultiTEL e indique los identificadores de referencia pertinentes a través de un canal de asistencia autenticado.

Mantenga separados los pasos de registro

La evaluación establece un resultado de revisión para la marca. La determinación de la elegibilidad de la campaña, el registro de la campaña y la asignación de números siguen siendo pasos separados. Consulte su estado actual y sus requisitos antes de enviar mensajes.

Petición

Utilice una cuenta con acceso a la API habilitado mediante HTTPS desde una dirección IP de origen permitida. Utilice las credenciales de su cuenta, no las del registro. La marca debe estar asociada a la cuenta autenticada.

Utilice GET con el identificador de marca en la ruta y el filtro de consulta obligatorio vettingStatus. El esquema revisado define un arreglo de estados; este ejemplo solicita un único valor ACTIVE. Esta guía no establece cómo codificar varios valores ni confirma que el proveedor acepte peticiones sin filtro. No se requiere un cuerpo de petición.

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 ruta
NombreTipoObligatorioDescripción
brandIdcadena de textoSíEl identificador de marca del registro asociado a su cuenta de MultiTEL. No es el identificador de su cuenta ni un identificador de evaluación.
Parámetros de consulta
NombreTipoObligatorioDescripción
vettingStatusarreglo de cadenas de textoSíFiltro de estado obligatorio. Valores permitidos: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. El ejemplo proporciona un único valor ACTIVE; no se afirma cómo codificar varios valores ni que el proveedor acepte peticiones sin filtro.

Respuesta

La ruta actual conserva el estado HTTP y el cuerpo de la respuesta del registro en lugar de utilizar la estructura envolvente de respuesta de la versión anterior v3. El arreglo ficticio abreviado ilustra los campos que utiliza el proceso de sincronización local; no es una respuesta capturada del registro ni un esquema cuya integridad esté garantizada. Compruebe el estado HTTP y el JSON antes de leer los registros. Conserve cada vettingId junto con la marca seleccionada.

Estructura de respuesta ilustrativa; no contiene datos de cuenta en tiempo real ni constituye una cotización actual.

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

Errores

  • 401: Ha fallado la autenticación de la cuenta. Compruebe las credenciales, que el acceso a la API esté habilitado y las restricciones aplicables a la IP de origen.
  • 404: La marca no está asociada a esta cuenta o el registro no ha podido encontrarla. La denegación por falta de titularidad de la cuenta se produce antes de realizar la petición al registro.
  • 429: Se ha alcanzado el límite de peticiones de la cuenta o del registro. Respete Retry-After y aumente progresivamente el tiempo de espera entre intentos.
  • 502/503: El transporte, el registro, el limitador de peticiones o el procesamiento local no están disponibles. Un error no demuestra que una solicitud anterior de revisión haya fallado.

Disponibilidad y efectos secundarios

  • Esta petición GET no realiza una nueva solicitud de evaluación. Obtiene resultados del registro, escribe registros de auditoría de la petición y sincroniza los resultados almacenados.
  • Consultar un resultado completado puede liquidar el cargo de una solicitud de evaluación facturable realizada anteriormente. Una revisión fallida puede conllevar el cargo por fallo que corresponda. Revise el precio y las condiciones al realizar la solicitud; esta consulta no constituye una cotización.
  • Un registro recién descubierto e importado mediante esta petición GET no se clasifica automáticamente como una nueva solicitud facturable.
  • Un resultado de evaluación satisfactorio o ACTIVE no equivale a la aprobación de una campaña, a la asignación de un número de teléfono ni a un permiso para enviar mensajes.