Seleccione una marca existente en su cuenta
Comience con el ID de marca del registro que ya está asociado a su cuenta de MultiTEL. Esta consulta no crea una marca ni vincula la marca de otra persona a su cuenta. El flujo de trabajo actual del cliente comprueba la titularidad antes de solicitar los casos de uso para los que reúne los requisitos. Si la consulta devuelve 404, verifique la cuenta y la marca seleccionadas en lugar de sustituir el identificador por el ID de una fila local.
Genere las opciones de casos de uso a partir de este resultado
El catálogo general de casos de uso describe las opciones del registro. Esta consulta específica de la marca proporciona las opciones para la marca seleccionada. Conserve cada valor de usecase devuelto y combínelo con la etiqueta y la descripción que muestra el catálogo. No ofrezca todas las entradas del catálogo general como si la marca reuniera los requisitos para cada una de ellas.
El portal espera que esta respuesta sea una lista JSON. Si falta, tiene un formato incorrecto o es un error, conserve el formulario del cliente e indique que no se han podido cargar los casos de uso para los que reúne los requisitos. No lo interprete silenciosamente como una aprobación para un caso de uso predeterminado. El registro puede devolver campos adicionales a los del ejemplo abreviado.
Cargue los requisitos del caso de uso seleccionado
Después de que el cliente elija uno de los valores de caso de uso devueltos, solicite /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} para la misma marca. Esa respuesta proporciona los límites de los subcasos de uso y los requisitos específicos de cada operador. Utilícela para recopilar ejemplos de mensajes, el consentimiento y las demás declaraciones obligatorias. La lista de casos de uso para los que la marca reúne los requisitos no basta por sí sola para preparar un registro de campaña completo.
Revise los precios de la cuenta por separado
Los campos del proveedor, como monthlyFee, quarterlyFee o annualFee, cuando se devuelven, describen metadatos de las tarifas del proveedor. No sustituyen el precio de la cuenta del cliente ni las condiciones de registro. El portal actual consulta por separado los precios de venta de las campañas y los combina con los datos de los casos de uso para los que la marca reúne los requisitos en su pantalla de revisión. No deduzca un cargo para el cliente a partir de los precios fijados en el código de la antigua función auxiliar de enumeraciones.
Actualice los datos cuando cambie la marca o el caso de uso
Al cambiar de marca, descarte las opciones de la marca anterior y cargue los casos de uso para los que la nueva selección reúne los requisitos. Actualice los requisitos del caso de uso seleccionado antes del envío. Estas solicitudes GET no envían un registro, no activan una campaña ni asignan números.
Solicitud
Utilice una cuenta 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 API habilitadas con autenticación mediante token de portador. No utilice las credenciales del proveedor.
GET con el identificador de la marca en la ruta de la URL. No se requiere un 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"| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
brand_id | cadena de caracteres | Sí | El ID de marca del registro asociado a su cuenta autenticada de MultiTEL. Utilice el ID de la marca, no el ID de una fila de la base de datos local, el ID de una campaña ni el número de identificación fiscal de la empresa. Codifíquelo como un único segmento de 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 de la versión anterior v3. El ejemplo ficticio abreviado no es el resultado de una consulta real de los casos de uso para los que una marca reúne los requisitos. Compruebe el estado HTTP y la estructura JSON esperada antes de utilizarlo. El portal actual espera una lista de registros de casos de uso para los que la marca reúne los requisitos, cada uno de los cuales identifica un usecase. Combina esos registros con el catálogo de usecase para obtener las etiquetas que se muestran y consulta los precios de venta por separado. Puede haber campos adicionales del proveedor.
Estructura de respuesta ilustrativa; no contiene datos reales de una cuenta ni constituye una cotización vigente.
[
{
"usecase": "2FA"
}
]Errores
- 401: Error de autenticación de la cuenta. Compruebe las credenciales de API, que la cuenta esté habilitada y las restricciones aplicables a la IP de origen.
- 404: La marca no está asociada a la cuenta autenticada, o el proveedor no encuentra la marca o la selección solicitada. Si la comprobación local de titularidad deniega el acceso, se devuelve esa denegación antes de enviar una solicitud al proveedor.
- Otros errores del registro: se conservan el estado HTTP y el cuerpo de la respuesta del servicio externo. Un caso de uso no válido o no disponible no equivale a una respuesta satisfactoria con un conjunto vacío de requisitos.
- 429: Se ha alcanzado el límite de solicitudes de la cuenta o el límite compartido del proveedor. Respete Retry-After.
- 502/503: Fallo de transporte o de disponibilidad del proveedor o del limitador de solicitudes. Conserve el formulario y vuelva a intentarlo con intervalos de espera crecientes.
Disponibilidad y efectos secundarios
- La solicitud GET revisada comprueba la titularidad de la marca existente, se comunica 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 las tarifas del proveedor no constituyen una cotización del precio de venta para el cliente de MultiTEL. El portal revisa los precios de la cuenta por separado antes de una solicitud de registro posterior.
- Los casos de uso para los que una marca reúne los requisitos y los requisitos exigidos pueden cambiar. Actualícelos para la marca y el caso de uso seleccionados antes del envío. Una consulta satisfactoria no constituye una aprobación de campaña, una asignación de números ni un permiso para comenzar a enviar mensajes.