Référence des balises Zendesk Support

Les balises Zendesk Support sont des conteneurs destinés aux données de ticket et d’utilisateur générées dynamiquement. Leur format est celui d’une référence de données contenue dans des accolades doubles. Comme vous pouvez également accéder aux données de ticket et d’utilisateur en définissant la logique de programmation, il peut être utile de ne pas s’en tenir aux balises et de réfléchir plutôt aux objets de données et à leurs propriétés, qui peuvent servir dans les deux cas.

Il existe deux objets de données principaux dans Zendesk Support : Ticket et Utilisateur. Chacun possède son propre jeu de propriétés ; l’objet Utilisateur, par exemple, contient des propriétés d’utilisateur, comme le nom et l’e-mail. En plus de ces deux objets de données, il existe des objets associés. Pour les tickets, ce sont les objets Commentaire et Note de satisfaction. Pour les utilisateurs, il s’agit des objets Organisation et Agent.

Même si les balises peuvent être au format HTML, quand une balise est envoyée à une cible HTTP ou URL, c’est Markdown, pas HTML, qui est utilisé pour le rendu de la balise.

Cet article classe les balises par les données qu’elles affichent :

• Données d’utilisateur
• Données d’organisation
• Données d’agent
• Données de ticket
• Données de commentaire
• Données de notes de satisfaction (Professional et Enterprise)

Données d’utilisateur

Dans le contexte de la mise à jour d’un ticket, il existe plusieurs types d’utilisateurs, dont les suivants :

• ticket.requester, qui est la personne ayant demandé le ticket ;
• ticket.assignee, qui est l’agent affecté au ticket ;
• ticket.submitter, qui désigne soit l’utilisateur ayant envoyé la demande, soit l’agent ayant ouvert ce ticket au nom du demandeur ;
• current_user, c’est-à-dire l’utilisateur qui met actuellement à jour le ticket (utilisateur final ou agent).

Cela signifie que la plupart des données d’utilisateur répertoriées dans le tableau suivant peuvent être renvoyées pour chaque type d’utilisateur (par exemple {{ticket.submitter.name}}, {{current_user.name}} et ainsi de suite).

Tableau 1. Données de l’objet Utilisateur

Propriétés/balises	Description
utilisateur.name Important : n’oubliez pas de remplacer utilisateur par l’un des types utilisateur indiqués ci-dessus (par exemple, ticket.requester).	Nom complet de l’utilisateur.
utilisateur.first_name	Prénom de l’utilisateur.
utilisateur.last_name	Nom de famille de l’utilisateur.
utilisateur.email	Adresse e-mail de l’utilisateur.
utilisateur.language	Préférence linguistique de l’utilisateur.
utilisateur.phone	Numéro de téléphone de l’utilisateur.
utilisateur.external_id	ID externe de l’utilisateur (le cas échéant). Facultatif pour les comptes qui ont activé la connexion unique d’entreprise par JWT ou SAML.
utilisateur.details	Informations détaillées sur l’utilisateur.
utilisateur.notes	Notes de l’utilisateur.
utilisateur.time_zone	Fuseau horaire de l’utilisateur.
utilisateur.role	Rôle de l’utilisateur (administrateur, agent ou utilisateur final).
utilisateur.extended_role	En cas d’utilisation des rôles d’agent Zendesk Support Enterprise, cette propriété renvoie le nom du rôle Enterprise de l’agent. Les rôles prédéfinis sont les suivants : Conseiller Agent light Équipe Chef d’équipe Agent (en héritage) Administrateur Si vous avez créé des rôles d’agent personnalisés, leurs noms sont renvoyés. Si vous n’avez pas de compte Enterprise, l’utilisation de cette balise renvoie « Agent » pour tous les agents, tandis que les utilisateurs finaux ont le rôle « End-user ». Pour en savoir plus sur les rôles d’agent personnalisés, consultez Rôles d’agents personnalisés.
utilisateur.id	ID de l’utilisateur.
utilisateur.locale	Paramètres régionaux de l’utilisateur (par exemple, fr-FR).
utilisateur.signature	Signature de l’agent. Seuls les agents possèdent des signatures.
utilisateur.organization...	Voir Données d’organisation ci-dessous.
utilisateur.tags	Marqueurs. Consultez Ajout de marqueurs aux utilisateurs et aux organisations.

Données d’organisation

Chaque type d’utilisateur peut être ajouté à une organisation. Une organisation contient les propriétés de données suivantes.

Tableau 2. Objet de données Organisation

Propriétés/balises	Description
utilisateur.organization.id Important : n’oubliez pas de remplacer utilisateur par l’un des types utilisateur indiqués ci-dessous.	ID de l’organisation à laquelle l’utilisateur est affecté.
utilisateur.organization.name	Nom de l’organisation à laquelle l’utilisateur est affecté.
utilisateur.organization.is_shared	True ou False. Indique si l’organisation est une organisation partagée.
utilisateur.organization.is_shared_comments	True ou False. Indique si l’organisation autorise les utilisateurs à ajouter des commentaires aux tickets d’autres utilisateurs.
utilisateur.organization.details	Informations détaillées sur l’organisation.
utilisateur.organization.notes	Notes sur l’organisation.
utilisateur.organization.tags	Marqueurs. Consultez Ajout de marqueurs aux utilisateurs et aux organisations.

Comme tous les utilisateurs peuvent être ajoutés à une organisation, Liquid vous permet d’accéder aux données d’organisation de chacun. Par exemple, vous pouvez obtenir des données pour chacun des types d’utilisateur suivants (indiqués ici sous forme de balises) :

• {{ticket.organization.name}}, c’est-à-dire le nom de l’organisation du demandeur du ticket
• {{ticket.requester.organization.name}}, qui est identique à {{ticket.organization.name}} (le demandeur)
• {{current_user.organization.name}}, c’est-à-dire l’utilisateur qui met actuellement à jour le ticket (utilisateur final ou agent).
• {{ticket.assignee.organization.name}}, c’est-à-dire l’agent affecté au ticket
• {{ticket.submitter.organization.name}}, c’est-à-dire soit l’utilisateur ayant envoyé la demande, soit l’agent ayant ouvert ce ticket au nom du demandeur

Données d’agent

Vous pouvez utiliser les balises suivantes dans les signatures d’agent uniquement. Pour en savoir plus au sujet des signatures d’agent, consultez Ajout de la signature d’agent aux notifications par e-mail de tickets.

Tableau 3. Objet de données Agent

Propriétés/balises	Description
agent.name	Nom complet de l’agent (ou pseudo, s’il est présent).
agent.first_name	Prénom de l’agent.
agent.last_name	Nom de l’agent.
agent.role	Rôle de l’agent.
agent.signature	Signature de l’agent.
agent.email	Adresse e-mail de l’agent.
agent.phone	Numéro de téléphone de l’agent.
agent.organization	Organisation de l’agent.
agent.language	Langue de l’agent.
agent.time_zone	Fuseau horaire de l’agent.

Données de ticket

Les tickets Zendesk Support contiennent les propriétés de données suivantes.

Tableau 4. Données de l’objet Ticket

Propriétés/balises	Description
ticket.account	Nom du compte Zendesk.
ticket.assignee.name	Nom complet de l’assigné au ticket (le cas échéant). Consulter Données d’utilisateur ci-dessus.
ticket.brand.name	Nom de la marque affectée au ticket.
ticket.cc_names	Renvoie les noms des personnes en CC pour le ticket. Remarque – Si vous utilisez la nouvelle expérience de CC et abonnés et que vous ajoutez ou mettez vos balises à jour, nous vous conseillons d’utiliser ticket.email_cc_names au lieu de tickets.cc_names. Elles font la même chose. Si vous souhaitez renvoyer les adresses e-mail des personnes mises en copie du message, vous pouvez utiliser ce code Liquid : {% for cc in ticket.ccs %} {{cc.name}} ({{cc.email}}) {% endfor %}
ticket.email_cc_names	Avec la nouvelle expérience de CC et abonnés, renvoie les noms des personnes en CC pour le ticket. Avec l’ancienne expérience de CC, renvoie un résultat vide. Remarque – Si vous utilisez la nouvelle expérience de CC et abonnés et que vous ajoutez ou mettez vos balises à jour, nous vous conseillons d’utiliser ticket.email_cc_names au lieu de tickets.cc_names. Elles font la même chose.
ticket.follower_names	Avec la nouvelle expérience de CC et abonnés, renvoie les noms des abonnés. Avec l’ancienne expérience de CC, renvoie un résultat vide.
ticket.follower_reply_type_message	Avec la nouvelle expérience de CC et abonnés, indique le type de commentaire (public ou privé) qui a déclenché la notification. Avec l’ancienne expérience de CC, renvoie un résultat vide.
ticket.created_at	Date de création du ticket (par ex. 18 mai 2014).
ticket.created_at_with_timestamp	Date et heure auxquelles le ticket a été créé, exprimées au format iso8601. Exemple : 2013-12-12T05:35Z, ce qui se traduit par 12 décembre 2013 à 05:35 UTC.
ticket.created_at_with_time	Date et heure de création du ticket. Par exemple, 10 février, 14:29.
ticket.current_holiday_name	Nul si la balise n’est pas utilisée pendant un jour chômé. Si elle est utilisée pendant un jour chômé, le nom de jour chômé est affiché. Si vous avez configuré plusieurs emplois du temps, cette balise respecte la liste de jours chômés configurés dans l’emploi du temps appliqué au ticket.
ticket.description	Description du ticket (premier commentaire). Remarque – Si le champ de sujet est vide ou n’est pas visible par le demandeur, le premier commentaire est utilisé et envoyé au demandeur. C’est également vrai pour les tickets privés.
ticket.due_date	Date d’échéance du ticket (applicable aux tickets de type Tâche). Le format est le suivant : Mai-18.
ticket.due_date_with_timestamp	Date d’échéance du ticket (ne concerne que les tickets de type Tâche), exprimée au format de date/heure ISO 8601. Exemple : 2013-12-12T05:35+0100, ce qui se traduit par 12 décembre 2013 à 06:35 UTC+1.
ticket.external_id	ID externe du ticket (le cas échéant).
ticket.encoded_id	L’ID chiffré est utilisé pour incorporer les réponses par e-mail entrantes aux tickets existants.
ticket.group.name	Groupe affecté au ticket.
ticket.id	L’ID du ticket. #{{ticket.id}} crée un lien cliquable. {{ticket.id}} rend le numéro du ticket en texte brut.
ticket.in_business_hours	True ou False. True (vrai) si le ticket est mis à jour pendant les heures ouvrées. Consultez Définition de vos heures ouvrées.
ticket.link	Chemin complet de l’URL pour accéder au ticket.
ticket.organization.custom_fields.<nom_clé>	Format de propriété/balise pour les champs d’organisation personnalisés. Consultez Ajout de champs personnalisés aux organisations.
ticket.organization.custom_fields.<nom_champ>.titre	Format de propriété/balise pour le titre d’option d’un champ personnalisé déroulant d’organisation. Consultez Ajout de champs personnalisés aux organisations.
ticket.organization.external_id	ID externe de l’organisation du demandeur du ticket.
ticket.organization.name	Voir Données d’organisation ci-dessus.
ticket.priority	Priorité du ticket (basse, normale, élevée et urgente).
ticket.requester.name	Nom complet du demandeur du ticket.
ticket.requester.custom_fields.<nom_clé>	Format de propriété/balise pour les champs personnalisés. Consultez Ajout de champs personnalisés aux utilisateurs.
ticket.requester.custom_fields.<nom_champ>.titre	Format de propriété/balise pour le titre d’option d’un champ personnalisé déroulant d’utilisateur. Consultez Ajout de champs personnalisés aux utilisateurs.
ticket.status	Statut du ticket (nouveau, ouvert, en attente, résolu et clos).
ticket.tags	Tous les marqueurs associés au ticket.
ticket.ticket_field_<numéro ID champ>	Format de propriété/balise pour les champs personnalisés. Par exemple, {{ticket.ticket_field_123}}. Consultez Balises de champs personnalisés.
ticket.ticket_field_option_title<numéro ID champ>	Format de propriété/balise pour les titres d’option d’un champ personnalisé déroulant. Consultez Balises de champs personnalisés.
ticket.ticket_form	Nom de formulaire pour les utilisateurs finaux.
ticket.ticket_type	Type du ticket (question, incident, problème, tâche).
ticket.title	Sujet du ticket.
ticket.updated_at	Date de dernière mise à jour du ticket (par exemple, le 18 mai).
ticket.updated_at_with_time	Date et heure de la dernière mise à jour du ticket. Par exemple, 10 février, 14:29.
ticket.updated_at_with_timestamp	Date et heure auxquelles le ticket a été créé, exprimées au format iso8601. Exemple : 2013-12-12T05:35Z, ce qui se traduit par 12 décembre 2013 à 05:35 UTC.
ticket.via	Type de source du ticket (formulaire Web, e-mail, Twitter, etc.).
account.incoming_phone_number_ID	Numéro de téléphone entrant de Zendesk Talk. Par exemple,{{account.incoming_phone_number_123}}.

Données de commentaire

Les commentaires sont ajoutés aux tickets et sont donc accessibles en tant qu’objet de données Ticket. Il existe trois types d’objets de ticket.

• Les objets standards vous permettent d’utiliser le hachage Liquid pour choisir ce que vous voulez afficher et retourner une collection de données de commentaires et de pièces jointes. Vous pouvez par exemple configurer des modèles pour faire des itérations sur les commentaires en utilisant {{ticket.comments}}.
• Les objets formatés vous permettent de retourner des représentations HTML rendues et préformatées des balises standards, mais avec un degré de personnalisation restreint. Ils renvoient simplement les commentaires dans des formats prédéfinis. Par exemple, {{ticket.comments_formatted}} renvoie un bloc de HTML rendu. Les commentaires du ticket incluent les dates, l’auteur, l’avatar de l’auteur, etc.
• Les objets en texte riche vous permettent d’utiliser le texte riche dans votre modèle personnalisé (comme avec les balises d’objets formatés) sans être limité par les règles de formatage prédéfinies, pour que vous ayez un meilleur contrôle de l’aspect de vos notifications. Cependant, les objets en texte riche n’autorisent pas l’inclusion de pièces jointes.

Tableau 5. Données de commentaire standards

Propriétés/balises	Description
ticket.comments	Utilisé comme balise, {{ticket.comments}} affiche tous les commentaires contenus dans un ticket sous la forme de texte non formaté. Remarque – Les agents reçoivent les commentaires publics et les notes internes, les utilisateurs finaux ne reçoivent que les commentaires publics. Ticket.comments sert également à regrouper les détails des commentaires et des pièces jointes. Vous pouvez accéder aux données suivantes à l’aide de balises Liquid : comment.author.name comment.created_at comment.created_at_with_time comment.is_public (true pour les commentaires publics et false pour les commentaires privés) comment.value comment.value_rich comment.id comment.attachments attachment.filename attachment.url Pour un exemple d’accès à ces données dans des règles de gestion, reportez-vous à la section Personnalisation du formatage et du placement de texte dans les commentaires et notifications par e-mail. Remarque – Le même ensemble de données de commentaires est disponible quand vous utilisez les balises ticket.public_comments, ticket.latest_comment et ticket.latest_public_comment.
ticket.public_comments	Tous les commentaires publics, en commençant par le plus récent. Texte non formaté.
ticket.latest_comment	Commentaire le plus récent. Texte non formaté. N’inclut pas les pièces jointes. Pour renvoyer des pièces jointes, utilisez ticket.latest_comment_formatted. Remarque – Les agents reçoivent la note interne ou le commentaire public le plus récent, les utilisateurs finaux reçoivent le commentaire public le plus récent.
ticket.latest_public_comment	Commentaire public le plus récent. Texte non formaté.

Tableau 6. Données de commentaire formatées

Propriétés/balises	Description
ticket.comments_formatted	Tous les commentaires, en commençant par le plus récent. Remarque – Les agents reçoivent les commentaires publics et les notes internes, les utilisateurs finaux ne reçoivent que les commentaires publics.
ticket.public_comments_formatted	Tous les commentaires publics, en commençant par le plus récent.
ticket.latest_comment_formatted	Commentaire le plus récent, pièces jointes incluses. Remarque – Les agents reçoivent la note interne ou le commentaire public le plus récent, les utilisateurs finaux reçoivent le commentaire public le plus récent.
ticket.latest_public_comment_formatted	Commentaire public le plus récent.

Tableau 7. Données de commentaire en texte riche

Propriétés/balises	Description
ticket.latest_comment_rich	Commentaire le plus récent. Formatage en texte riche. N’inclut pas les pièces jointes (pour qu’elles le soient, utilisez ticket.latest_comment_formatted). Remarque – Les agents reçoivent la note interne ou le commentaire public le plus récent, les utilisateurs finaux reçoivent le commentaire public le plus récent.
ticket.latest_public_comment_rich	Commentaire public le plus récent. Formatage de texte riche

Données de notes de satisfaction (Professional et Enterprise)

Les propriétés de données suivantes sont disponibles pour les notes de satisfaction client (consultez Utilisation des notes de satisfaction client).

Remarque – Si vous suspectez que les notes de satisfaction proviennent d’autres utilisateurs que le demandeur, il est possible que vous utilisiez des balises de notes de satisfaction hors des règles de gestion. Cela permet à d’autres utilisateurs d’envoyer des notes de satisfaction pour le demandeur (consultez Notes de satisfaction envoyées par des utilisateurs autres que le demandeur).

Tableau 8. Objet de données Note de satisfaction

Propriétés	Description
satisfaction.rating_section	Bloc de texte formaté invitant l’utilisateur à choisir une note de satisfaction.
satisfaction.rating_url	URL permettant d’attribuer une note à l’assistance.
satisfaction.current_rating	Texte de la note de satisfaction actuelle (par ex. « Bien, je suis satisfait »).
satisfaction.positive_rating_url	URL permettant d’attribuer une note positive à l’assistance.
satisfaction.negative_rating_url	URL permettant d’attribuer une note négative à l’assistance.
satisfaction.current_comment	Commentaire ajouté par l’utilisateur lorsqu’il a noté le ticket.