Cargar catálogos para el registro de mensajería

Cargue las opciones antes de crear un formulario de registro

Utilice el catálogo actual de registro de mensajería para rellenar las opciones en lugar de fijar los valores del registro en el código. Para un formulario de marca, el portal carga los catálogos de tipo de empresa, sector, tipo de identificador empresarial alternativo, relación con la marca, país, estado de Estados Unidos y bolsa de valores. Para un formulario de campaña, carga los casos de uso, los subcasos de uso válidos y los socios de conectividad. Conserve cada valor devuelto para procesamiento automático junto con su etiqueta de visualización; al preparar una solicitud posterior, utilice el valor, no una etiqueta traducida.

Elija un catálogo

Procese directamente la respuesta de TCR

El cuerpo de la respuesta procede directamente de la API de TCR. A diferencia de muchos puntos de acceso antiguos de /v3, no incorpora una envoltura status/response adicional. Compruebe el estado HTTP antes de interpretarlo. Un catálogo puede contener etiquetas de texto o definiciones estructuradas, por lo que no debe suponer que todos los valores tienen los mismos campos. Si la solicitud HTTP se completa correctamente, pero el cuerpo no es un JSON válido con la estructura esperada, indique que la consulta ha fallado en lugar de sustituirlo silenciosamente por una lista vacía.

Distinga las opciones del catálogo de la elegibilidad y los precios

Un catálogo general de casos de uso no indica para qué casos de uso cumple los requisitos una marca concreta. El portal actual realiza una consulta de elegibilidad específica para la marca antes de crear la campaña y comprueba los requisitos de los operadores seleccionados. Del mismo modo, los metadatos de tarifas de un proveedor no constituyen el precio final de venta al cliente de la cuenta. Revise por separado el precio aplicable a la cuenta y las condiciones de registro. Cargar un catálogo no supone la aprobación de una marca, una campaña ni un número de mensajería.

Gestione los catálogos no disponibles

Conserve los datos introducidos por el cliente en el formulario si falla una consulta. Muestre el error, respete Retry-After cuando se devuelva y utilice esperas progresivas entre reintentos. No vuelva a cargar todos los catálogos repetidamente ni interprete un error de límite de solicitudes o de transporte como un catálogo vacío válido. Esta solicitud GET no requiere una clave de idempotencia y no se reproduce desde el almacén de idempotencia de operaciones de modificación.

Solicitud

Utilice una cuenta de API habilitada a través de HTTPS desde una dirección IP de origen permitida. La ruta actual admite la política de autenticación de la cuenta, incluida la autenticación Basic y las cuentas de API habilitadas con autenticación mediante token de portador. No utilice credenciales del proveedor.

Realice una solicitud GET con un nombre de catálogo admitido en la ruta. Incluya los filtros de catálogo aplicables en la cadena de consulta. No se necesita un cuerpo de solicitud.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Respuesta

Esta ruta de TCR devuelve directamente el cuerpo del registro con su estado HTTP. No utiliza la antigua envoltura status.code/status.msg/response de v3. Las estructuras de los catálogos varían: algunos asocian valores con objetos descriptivos; otros asocian valores con cadenas de texto. Conserve las claves legibles por máquina al enviar un formulario posterior. El ejemplo ficticio abreviado de usecase ilustra un mapa cuyos valores son objetos; no es un catálogo en producción ni garantiza un esquema completo. Compruebe tanto el estado HTTP como la estructura JSON esperada.

Estructura de respuesta ilustrativa; no contiene datos reales de la cuenta ni constituye una cotización vigente.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Errores

• 401: La autenticación de la cuenta ha fallado. Compruebe la credencial de API, que la cuenta esté habilitada y las restricciones de IP de origen aplicables.
• 400/404 y otros errores del registro: el catálogo o el filtro no son válidos o no están disponibles. La ruta actual conserva el estado HTTP y el cuerpo de respuesta del servicio de origen; no existe una envoltura universal de errores de v3.
• 429: Se ha alcanzado el límite de solicitudes de la cuenta o el límite compartido del proveedor. Respete Retry-After y reintente con esperas progresivas.
• 502: No se ha podido contactar con el registro. Se desconoce la disponibilidad; no presente opciones vacías en su lugar como si fueran un resultado satisfactorio.
• 503: El limitador de solicitudes o el servicio de origen no está disponible. Examine el cuerpo y cualquier cabecera Retry-After antes de reintentar.

Disponibilidad y efectos secundarios

• Esta solicitud GET de catálogo no crea una marca ni una campaña, no envía una solicitud de registro, no reserva un recurso ni cobra una tarifa de registro en la ruta revisada. Contacta con el proveedor y genera registros de auditoría de solicitudes.
• Las definiciones del catálogo y los metadatos de tarifas del proveedor no constituyen una cotización de venta al cliente. El portal actual obtiene por separado los precios de venta de las campañas; la antigua función auxiliar getCampaignPrice y las antiguas anotaciones de precios de enumeraciones no deben considerarse el contrato de precios de esta ruta.
• Una entrada de catálogo admitida no demuestra que una marca concreta cumpla los requisitos para ese caso de uso. Complete la evaluación de elegibilidad específica de la marca, las declaraciones, el consentimiento y la revisión de precios de la cuenta antes de realizar una solicitud de registro posterior.