Comment lister les modèles de tickets dans Zoho Desk

Lister les modèles de tickets dans Zoho Desk est simple via l'API REST — une seule requête GET vers le point de terminaison /api/v1/ticketTemplates retourne tous les modèles disponibles dans votre portail.

Pourquoi c'est important

Les modèles de tickets permettent aux équipes de support de pré-remplir des champs, des sujets et des descriptions afin que les agents puissent ouvrir des tickets cohérents et bien structurés plus rapidement. Si vous créez une intégration, automatisez la création de tickets ou auditez votre configuration Desk, vous devrez récupérer par programmation la liste complète des modèles avant d'en référencer ou d'en mettre à jour. C'est également une première étape utile avant d'appeler le point de terminaison de mise à jour pour un modèle spécifique. ^[6]

Étape par étape

Étape 1. Vérifiez que votre jeton OAuth inclut les scopes Zoho Desk appropriés. Vous aurez besoin au minimum de Desk.tickets.READ ou Desk.settings.READ dans votre ensemble de scopes autorisés — les deux font partie du bundle de scopes Desk standard. ^[5]

Étape 2. Envoyez une requête GET vers le point de terminaison des modèles de tickets :

GET /api/v1/ticketTemplates

Il s'agit de l'opération canonique (listtickettemplates) qui retourne tous les modèles de tickets pour votre organisation Desk. ^[4]

Étape 3. Vous pouvez également transmettre des paramètres de requête via le dictionnaire p (par exemple, des arguments de pagination ou de filtrage) dans le cadre de la requête. Le point de terminaison accepte un objet paramètre p, ce qui vous permet de limiter les résultats si votre portail contient un grand nombre de modèles. ^[4]

Étape 4. En Python, en utilisant le wrapper client Desk, l'appel ressemble à ceci :

def list_ticket_templates(self, p: dict = None):
    """List Ticket Templates"""
    return self.c.request("GET", f"/api/v1/ticketTemplates", p, None)

Passez p=None pour une liste non filtrée, ou fournissez un dictionnaire de paramètres de requête pour affiner les résultats. ^[4]

Étape 5. Analysez le contenu de la réponse. Chaque élément de la collection retournée représente un modèle de ticket. Les champs clés à capturer incluent l'identifiant du modèle (nécessaire pour toute mise à jour ultérieure via PATCH /api/v1/ticketTemplates/{templateId}) et le nom du modèle. ^[6]

Erreurs courantes

• Scopes manquants. Si votre jeton OAuth a été généré sans Desk.tickets.READ ou Desk.settings.READ, l'API rejettera la requête. Vérifiez les scopes répertoriés dans votre configuration d'environnement avant de résoudre tout autre problème. ^[5]
• URL de base incorrecte. L'URL de base de l'API Desk varie selon le centre de données. Pour la région .com, elle est https://desk.zoho.com ; pour les autres régions, remplacez le suffixe de domaine approprié (par exemple, .eu, .in). Mélanger les URL de base de CRM et de Desk est une erreur courante — ce sont des services distincts. ^[3]
• Portail vs. ID d'organisation. Les URL Desk et les contextes API peuvent être limités à un nom de portail ou à un identifiant d'organisation. Assurez-vous que les identifiants et le contexte de portail que vous utilisez correspondent à l'environnement où se trouvent vos modèles. ^[3]

Ce qu'il faut vérifier

• Confirmation des scopes : Vérifiez que Desk.tickets.READ ou Desk.settings.READ apparaît dans le jeton OAuth actif avant d'effectuer l'appel. ^[5]
• Réponse non vide : Confirmez que le tableau de réponse contient au moins un modèle ; une liste vide peut indiquer que vous êtes authentifié sur le mauvais portail ou département. ^[4]
• Identifiants de modèles capturés : Assurez-vous d'avoir stocké les valeurs templateId de la réponse — vous en aurez besoin pour toute opération PATCH ou de référence ultérieure. ^[6]

---

*Beam Help fournit une assistance experte indépendante pour les produits Zoho et ne constitue pas le support officiel de Zoho. Référez-vous toujours à la documentation officielle de Zoho pour les dernières modifications de l'API.*