Leer los requisitos de campaña de una marca

Mantenga juntos la marca y el caso de uso

Use el ID de marca de su cuenta y un valor de caso de uso devuelto por la lista de calificación de esa misma marca. El flujo de trabajo del cliente comprueba la propiedad antes de la solicitud al proveedor. Confirme que el usecase del objeto devuelto coincide con el valor seleccionado. Una consulta para una marca o un caso de uso no establece los requisitos de otra.

Leer los requisitos actuales

Requisitos usados por el formulario de campaña actual
Campo	Cómo lo usa el portal
minSubUsecases / maxSubUsecases	Número mínimo y máximo de subcasos de uso para esta selección. Elija valores del catálogo válido de subcasos de uso en lugar de texto libre.
mnoMetadata	Requisitos específicos de cada operador, indexados por ID de operador. Use los ID presentes en la respuesta actual para la selección de operadores.
mnoSupport / qualify	Soporte y calificación del operador. El portal excluye los operadores marcados explícitamente como false en cualquiera de los dos campos y exige al menos un operador seleccionado elegible.
minMsgSamples	Número de muestras requerido para un operador. El portal exige al menos una muestra no vacía y cumple el mínimo más alto entre los operadores seleccionados elegibles.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	Declaraciones de suscriptor requeridas. Cuando sean requeridas, la declaración correspondiente debe ser true. Las declaraciones habilitadas también necesitan sus campos de palabras clave y de mensaje de respuesta.
noEmbeddedLink / noEmbeddedPhone	Restricciones sobre enlaces o números de teléfono incrustados. El portal rechaza una función declarada si un operador seleccionado elegible la prohíbe.

Aplique conjuntamente los requisitos de los operadores seleccionados

Los requisitos de los operadores pueden diferir. Cuando no se proporciona una lista explícita de operadores, el portal considera todos los metadatos de operadores de la respuesta; una lista no vacía limita las comprobaciones a esos ID seleccionados. No use solo el número de muestras o las declaraciones del primer operador. Seleccione operadores de la respuesta, compruebe el soporte y la calificación, cumpla el mínimo de muestras más alto aplicable y satisfaga las declaraciones requeridas de alta (opt-in), baja (opt-out) y ayuda en toda esa selección. El portal rechaza los ID de operador seleccionados que no estén en la respuesta actual y rechaza una selección sin ningún operador elegible.

Los requisitos describen lo que debe proporcionarse; no demuestran que el proceso de consentimiento del cliente ni el contenido de la campaña cumplan esos requisitos. Reúna muestras y declaraciones veraces y representativas. No active automáticamente las declaraciones para que un formulario pase la validación.

Prepare las muestras y las respuestas al suscriptor

El formulario de campaña actual usa de sample1 a sample5 para las muestras de mensajes. Si los requisitos no pueden cumplirse dentro del formulario disponible, deténgase y resuelva la selección con soporte. Para una declaración de suscriptor habilitada, proporcione sus palabras clave y su texto de respuesta correspondientes: optinKeywords/optinMessage, optoutKeywords/optoutMessage y helpKeywords/helpMessage. Mantenga las muestras coherentes con el caso de uso elegido y con la mensajería real al cliente.

Revise antes de cualquier solicitud de registro

Actualice los requisitos cuando cambie la marca, el caso de uso o la selección de operadores. El portal vuelve a validar el caso de uso seleccionado, el número de subcasos de uso, la elegibilidad de los operadores, las muestras y las declaraciones antes de la creación. Revise por separado los precios de la cuenta y las condiciones de registro. Este GET no registra ni aprueba una campaña, no la comparte con el operador de mensajería ni asigna un número de teléfono. La creación y el aprovisionamiento son operaciones separadas.

Gestione una consulta de requisitos fallida

Si la solicitud falla, devuelve un JSON inesperado o no coincide con el caso de uso seleccionado, mantenga el formulario incompleto y permita que el cliente lo reintente después de resolver el error. No sustituya los requisitos no disponibles por un objeto vacío ni asuma que la falta de datos significa que no hay requisitos. Respete Retry-After y use una espera progresiva (backoff) para los límites de solicitudes y los fallos de disponibilidad.

Solicitud

Use 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 cuentas, incluida la autenticación Basic y las cuentas de API con token bearer habilitadas. No use las credenciales del proveedor.

GET con el ID de marca y el valor del caso de uso seleccionado en la ruta de la URL. No se requiere cuerpo de solicitud.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

Parámetros de ruta
Nombre	Tipo	Obligatorio	Descripción
`brand_id`	string	Sí	El ID de marca del registro asociado a su cuenta MultiTEL autenticada. Use el ID de marca, no un ID de fila de la base de datos local, un ID de campaña ni un número de identificación fiscal de la empresa. Codifíquelo como un único segmento de la ruta de la URL.
`usecase`	string	Sí	El valor usecase legible por máquina seleccionado de la lista de calificación de esta misma marca. Conserve sus mayúsculas y minúsculas; no envíe una etiqueta de visualización traducida. Codifíquelo como un único segmento de la ruta de la URL.

Respuesta

La ruta actual de TCR devuelve directamente el cuerpo JSON del registro y conserva su estado HTTP. No añade la envoltura status/response heredada de la v3. El ejemplo ficticio abreviado no es un resultado de calificación real. Compruebe el estado HTTP y la forma JSON esperada antes de usarlo. El portal espera un objeto cuyo usecase coincida con el caso de uso seleccionado. Los requisitos de los operadores están bajo mnoMetadata, indexados por ID de operador. El ID de operador y los requisitos del ejemplo son ficticios. Pueden devolverse otros campos del proveedor.

Forma ilustrativa de la respuesta; no son datos reales de la cuenta ni una cotización actual.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Errores

401: Falló la autenticación de la cuenta. Compruebe las credenciales de API, el estado de habilitación y las restricciones de IP de origen aplicables.
404: La marca no está asociada a la cuenta autenticada, o el proveedor no encuentra la marca o la selección solicitada. Una denegación local de propiedad se devuelve antes de cualquier solicitud al proveedor.
Otros errores del registro: se conservan el estado HTTP y el cuerpo de origen. Un caso de uso no válido o no disponible no es un conjunto de requisitos vacío correcto.
429: Se alcanzó el límite de solicitudes de la cuenta o del proveedor compartido. Respete Retry-After.
502/503: Fallo de disponibilidad del transporte, del proveedor o del limitador de velocidad. Conserve el formulario y reintente con espera progresiva.

Disponibilidad y efectos secundarios

El GET revisado comprueba la propiedad existente de la marca, contacta con el registro y escribe registros de auditoría de solicitudes. No crea una marca ni una campaña ni cobra una tarifa de registro.
Los metadatos de tarifas del proveedor no son una cotización minorista para clientes de MultiTEL. El portal revisa por separado los precios de la cuenta antes de una solicitud de registro posterior.
La calificación y los requisitos pueden cambiar. Actualícelos para la marca y el caso de uso seleccionados antes del envío. Una consulta correcta no es una aprobación de campaña, una asignación de número ni un permiso para empezar a enviar mensajes.