Busca guías, resúmenes de API y endpoints por nombre, ruta o palabra clave.

Tipos

Consultar, crear y editar los tipos de comunicación y validar sus plantillas en todos los tenants.

Admin Última actualización

Consulta los tipos de comunicación, sus argumentos y su ventana de entrega. Desde aquí también ves qué plantillas tiene cada tipo en cada tenant y las validas contra sus ejemplos. Los tipos son comunes a todos los tenants.

Abrir Tipos en Admin →

ℹAntes de empezar
No hace falta seleccionar un tenant.
  1. Abre Tipos. La tabla Tipos de comunicación muestra el código, los argumentos, la ventana de entrega y la fecha de actualización de cada tipo.
  2. Filtra por Código, Descripción, Ventana de entrega o Argumentos escribiendo parte del texto, o por Requerido en tiempo real, Tipo de envío y Sensible eligiendo un valor.
  3. Despliega una fila con › para ver la Descripción, si es Requerido en tiempo real, el Tipo de envío y la Fecha de creación.
Tipos de comunicación con una fila desplegada

Ver las plantillas de un tipo

  1. En la fila del tipo, abre el menú ⋮ y pulsa Plantillas.
  2. Se abre una ventana con el código del tipo y una fila por tenant. La columna DETAIL indica cuántas plantillas tiene el tipo en ese tenant o «No hay plantillas disponibles para este tenant».
  3. Despliega un tenant con › para ver sus plantillas: canal, idioma, fecha de creación y fecha de actualización.
  4. Pulsa Plantilla en una de ellas para abrirla en una pestaña nueva.

Solo aparecen los tenants que tienes habilitados. Con Plantillas disponibles ocultas los tenants sin plantillas de ese tipo; Canal, Idioma, Fecha de creación y Fecha actualización filtran las plantillas.

Validar las plantillas de un tipo

La validación genera cada plantilla del tipo con los argumentos de sus ejemplos y comprueba que el resultado coincide con la salida esperada. No cambia nada.

  1. En la fila del tipo, abre el menú ⋮ y pulsa Validar plantillas.
  2. Espera a que se cargue la lista: una fila por plantilla del tipo en cada tenant que tienes habilitado.
  3. Pulsa Validar. El estado de cada plantilla pasa de Pendiente… a En curso y termina en Validado o Error.
  4. Si lo necesitas, pulsa Pausar validación y después Reanudar validación.
  5. Cuando termine, despliega con › las plantillas con error para ver el Campo, la Salida esperada y la Salida obtenida. Pulsa Finalizar para cerrar.

Puedes filtrar la lista por Tenant, Canal, Idioma, Estado y Detalle.

Crear un tipo

  1. Pulsa Crear tipo de comunicación.
  2. En Parámetros de tipo, rellena el Código, la Ventana de entrega y la Descripción, y elige Requerido en tiempo real y Tipo de envío.
  3. En Argumentos, escribe el Nombre del argumento, elige su tipo y si es Sensible, y pulsa Añadir. Repite para cada argumento. Para quitar uno, pulsa la X de su fila.
  4. Pulsa Crear. Verás «Creación completada» y el resumen del tipo. Pulsa Hecho para volver a la lista.
Formulario para crear un tipo de comunicación

El código solo admite minúsculas, números y guiones bajos, y no puede empezar ni terminar por guion bajo, por ejemplo aviso_cambio_tarifa.

Editar un tipo

  1. En la fila del tipo, abre el menú ⋮ y pulsa Editar tipo de comunicación.
  2. Cambia los campos que necesites. El Código no se puede cambiar.
  3. Pulsa Guardar. Verás «Actualización completada»; pulsa Hecho para volver a la lista.

Para cambiar solo la ventana de entrega, usa ⋮ > Editar ventana de entrega: escribe el nuevo valor y pulsa Aceptar. Verás «Ventana de entrega editada correctamente».

Eliminar un tipo

  1. En la fila del tipo, abre el menú ⋮ y pulsa Eliminar.
  2. En Eliminar tipo de comunicación, comprueba el código y pulsa Aceptar. Verás «Tipo de comunicación eliminado».

Si algo no sale como esperas

VesQué significa y qué hacer
No aparecen Crear tipo de comunicación ni las opciones de edición del menú ⋮No tienes permiso de escritura en esta sección.
«Formato de código inválido»El código tiene mayúsculas, espacios u otros caracteres, o empieza o termina por guion bajo. Corrígelo.
«Ya existe un argumento con este nombre»Ya has añadido un argumento con ese nombre. Usa otro o quita el anterior.
«Se ha producido un error desconocido» con el botón ReintentarEl servicio rechazó el cambio. Lee el mensaje, pulsa Reintentar para volver al formulario y corrige el dato.
Una plantilla queda en Error sin filas al desplegarlaNo se pudo validar: el motivo está en la columna DETALLE. Vuelve a intentarlo más tarde.

Referencia

Campos de un tipo

CampoQué es
CódigoIdentificador del tipo. Lo usan las plantillas y los ejemplos.
ArgumentosDatos que recibe la comunicación, cada uno con su tipo, por ejemplo tariff(String).
Ventana de entregaCuándo se puede entregar la comunicación, por ejemplo ANYDAY_ANYTIME o ANYDAY_8AM11PM.
Requerido en tiempo realSí o No.
Tipo de envíoDEFAULT, EXTERNAL, BATCH o PREPAID.
DescripciónPara qué sirve el tipo.

Tipos de argumento: String, StringList, StringMap, Number, Link, LocaleRegion, Date, Boolean y Attachment. Un argumento Sensible aparece con un ojo tachado.