Syntaxe Liquid prise en charge pour les modèles de messages téléphoniques

Découvrez les balises Liquid, les filtres et les variables courantes pris en charge dans les modèles de messages téléphoniques.

Pour un aperçu de la syntaxe Liquid, consultez l’introduction à LiquidJS. Vous y trouverez un bref résumé des deux types de balisage Liquid :

• Sorties, qui génèrent du HTML.

  La syntaxe des sorties consiste en une variable ou une valeur, ainsi qu’une liste facultative de filtres, entourées de {{ et }}. Par exemple, {{ user.name }}.

• Balises, qui contrôlent le rendu du modèle et mettent en œuvre la logique.

  La syntaxe des balises consiste en un nom de balise et des arguments facultatifs entourés de {% et %}. Par exemple, {% if user_metadata.lang == 'it' %} Ciao! {% endif %}.

Cette page répertorie les balises, les filtres et les variables pris en charge dans les modèles de messages téléphoniques.

​

Balises

Tous les modèles de messages téléphoniques prennent en charge les balises Liquid suivantes :

Catégorie	Balises
Itération	for, cycle, tablerow
Contrôle de flux	if, unless, elsif, else, case
Variable	assign, increment, decrement
Fichier	include, layout
Langage	raw, comment

Vous pouvez consulter des descriptions et des exemples de balises Liquid sur la page des balises de LiquidJS.

​

Filtres

Tous les modèles de messages téléphoniques prennent en charge les filtres Liquid suivants :

Catégorie	Filtres
Mathématiques	plus, minus, modulo, times, floor, ceil, round, divided_by, abs, at_least, at_most
String	append, prepend, capitalize, upcase, downcase, strip, lstrip, rstrip, strip_newlines, split, replace, replace_first, remove, remove_first, truncate, truncatewords
HTML/URI	escape, escape_once, url_encode, url_decode, strip_html, newline_to_br
Array	slice, map, sort, sort_natural, first, last, join, reverse, size
Date	date
Divers	default

Vous pouvez consulter la description et des exemples des filtres Liquid sur la page des filtres de LiquidJS.

​

Variables générales

Les variables suivantes sont disponibles dans le champ Text Message Template de chaque modèle de messages téléphoniques, sauf indication contraire.

Les propriétés fondées sur des URL, comme logo_url, sont automatiquement protégées par échappement d’URL afin de réduire les risques de sécurité. Les numéros de téléphone sont stockés avec leur indicatif de pays (+<country_code>), sauf les numéros de téléphone américains, qui peuvent omettre cet indicatif.

• Renseignements liés au tenant définis dans Tenant Settings :

  • tenant, qui correspond au nom brut du tenant
  • friendly_name
  • support_email
  • support_url
  • logo_url
  • home_url
  • region

• locale, qui est basée sur le paramètre de requête ui_local des requêtes /authorize

• code (non disponible dans les modèles blocked_account)

• connection, le nom de la connexion de base de données

• Les variables user suivantes :

  • user.name
  • user.nickname
  • user.given_name
  • user.family_name
  • user.picture
  • user.login_count
  • user.user_metadata, les attributs utilisateur qui n’ont pas d’incidence sur les fonctionnalités de base d’un utilisateur, y compris les préférences utilisateur
  • user.app_metadata, les attributs utilisateur qui peuvent avoir une incidence sur les fonctionnalités de base d’un utilisateur, par exemple le fonctionnement d’une application ou ce à quoi l’utilisateur peut accéder, y compris son forfait de soutien, ses rôles de sécurité et ses groupes de contrôle d’accès
  • user.email_verified
  • user.email
  • user.phone_number
  • user.phone_verified
  • user.multifactor
  • user.source_ip
  • user.country
  • user.city

• Les variables client suivantes :

  • name
  • clientID
  • metadata

• L’objet application, avec accès aux propriétés client standard comme application.name et application.client_metadata

• Lorsqu’un utilisateur se connecte au moyen d’une Organization, les variables supplémentaires suivantes sont disponibles :

  • organization.id
  • organization.name
  • organization.display_name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

• Plusieurs variables de domaines personnalisés :

  • custom_domain.domain, le nom de domaine du tenant
  • custom_domain.domain_metadata, les champs de métadonnées du domaine personnalisé (paires clé-valeur)