Utilisation de l’API d’e-mail pour mettre à jour les propriétés de ticket à partir de votre boîte de messagerie

Disponible avec toutes les éditions Suite

L’API d’e-mail vous permet de définir les propriétés des tickets en ajoutant des commandes au corps de votre e-mail de réponse à une notification ou d’un e-mail de création d’un nouveau ticket. Seuls les agents peuvent utiliser l’API d’e-mail. Si ces commandes sont utilisées par un utilisateur final, Zendesk les ignore.

Voici un exemple d’un agent définissant le statut et l’assigné d’un ticket dans la réponse à une notification par e-mail :

Un agent peut également utiliser les commandes dans un nouvel e-mail envoyé à son adresse d’assistance. Ce type d’e-mail crée un nouveau ticket.

Quand Zendesk Support reçoit un e-mail d’un agent, nous vérifions la présence de commandes en haut de cet e-mail et, le cas échéant, exécutons ces commandes sur le ticket concerné.

Remarque – Vous ne pouvez mettre à jour un ticket existant qu’en répondant à une notification par e-mail pour ce ticket. En d’autres termes, vous ne pouvez pas créer un e-mail séparé en faisant référence à un ticket existant déjà. En effet, Zendesk Support a besoin de l’ID du ticket, qui figure dans l’adresse e-mail Répondre à (comme l’illustre l’image ci-dessus).

Syntaxe

L’API d’e-mail analyse le haut de votre e-mail pour trouver la liste des commandes que vous voulez exécuter.

Les commandes doivent être en texte brut, pas HTML, et suivre le format suivant :

#command value

Si, par exemple, vous voulez définir le statut d’un ticket, utilisez cette commande :

#status solved

Chaque commande doit être sur une ligne indépendante. Si, par exemple, vous voulez définir le statut et l’assigné, rédigez les commandes comme suit :

#status solved 

#assignee jake@zendesk.com

Saisissez le corps de votre e-mail après le bloc de commandes.

Remarque – Il doit y avoir un espace entre la commande et la valeur.

Commandes - Référence

Vous trouverez ci-après la liste de toutes les commandes prises en charge que vous pouvez ajouter, une ligne à la fois, au corps d’un e-mail valide. Cette liste inclut également les commandes abrégées, des commandes d’un seul mot pour les commandes courantes ne nécessitant pas de valeur. Par exemple, vous pouvez utiliser la commande abrégée #solved au lieu de #status solved.

Remarque – L’utilisation des noms de champs personnalisés comme commandes n’est pas prise en charge.

Commande	Description
`#status`	Les valeurs valides sont open (ouvert), pending (en attente) et solved (résolu). Remarque - #assignee doit être défini pour définir un ticket sur le statut Résolu. Syntaxe abrégée : `#open #pending #solved` Remarque – La commande `#solved` fonctionne uniquement pour les tickets qui ne contiennent pas de champs obligatoires que l’agent doit remplir avant que le ticket puisse être résolu.
`#requester`	Définit le demandeur du ticket. Il peut s’agir de l’ID utilisateur dans votre compte ou simplement de son adresse e-mail. S’il n’existe pas dans votre compte, Zendesk le créera pour vous. Cette commande n’est pas disponible pour les agents light.
`#group`	Affecte le ticket à un groupe. Les valeurs valides sont le nom ou l’ID du groupe. Cette commande est particulièrement utile pour transférer les e-mails. Quand un agent transfère un e-mail à Zendesk, par défaut le ticket qui en résulte est soit non affecté ou affecté au groupe par défaut de l’agent. (consultez Transfert direct d’un e-mail à votre adresse d’assistance). Les agents peuvent utiliser cette commande pour affecter automatiquement le ticket transféré au groupe spécifié.
`#assignee`	Affecte le ticket à un agent. Les valeurs valides sont l’adresse e-mail ou l’ID Zendesk Support de l’assigné (obtenu, par exemple, par le biais d’une intégration REST). En utilisant cette commande, vous devenez automatiquement un collaborateur (CC) pour le ticket.
`#priority`	Définit la priorité du ticket. Les valeurs valides sont low (basse), normal (normale), high (élevée) et urgent (urgente). Remarque – Pour définir une priorité, vous devez aussi définir un type de ticket (voir ci-dessous). Syntaxe abrégée : `#low #normal #high #urgent`
`#type`	Les valeurs valides sont incident, question, task (tâche) et problem (problème). Syntaxe abrégée : `#incident #question #task #problem`
`#tags`	Définit n’importe quelle balise pour le ticket. Elles peuvent être séparées par des espaces ou des virgules. Remarque – La définition des balises supprime toutes les balises précédemment définies pour ce ticket.
`#public`	Définit la mise à jour d’un commentaire pour un ticket sur publique. Ne peut être utilisée que lors de la mise à jour d’un ticket. La valeur par défaut pour les tickets publics est true, ce qui signifie que le demandeur verra tout ce que vous incluez d’autre au corps de l’e-mail. La valeur par défaut pour les tickets privés, comme les tickets créés par les agents light, est false. Syntaxe abrégée : `#note` (les commentaires futurs de cet agent pour ce ticket seront privés, sauf si #public est ajouté à chaque commentaire individuel).

Commandes non valides

Si vous saisissez des commandes ou valeurs non valides, Zendesk les ignore.

Exemple

Dans cet exemple, l’agent utilise toutes les commandes.

L’e-mail effectue les actions suivantes sur le ticket 178 :

Définit le statut sur ouvert
Définit le groupe sur Assistance et l’assigné sur l’agent ayant jake@zendesk.com comme adresse e-mail
Définit la priorité sur normale
Définit le type sur question
Définit les balises sur aide et api
Définit la visibilité du commentaire sur privée
Ajoute un nouveau commentaire disant « Salut la compagnie ! » au ticket, qui associé à la commande ci-dessus ne sera pas visible par le demandeur.