Elencare i modelli di ticket in Zoho Desk è semplice tramite l'API REST — una singola richiesta GET all'endpoint /api/v1/ticketTemplates restituisce tutti i modelli disponibili nel tuo portale.
Perché è importante
I modelli di ticket consentono ai team di supporto di pre-compilare campi, oggetti e descrizioni, così gli agenti possono aprire ticket coerenti e ben strutturati più rapidamente. Se stai creando un'integrazione, automatizzando la creazione di ticket o verificando la configurazione di Desk, dovrai recuperare programmaticamente l'elenco completo dei modelli prima di fare riferimento a qualsiasi di essi o aggiornarli. Questo è anche un primo passo utile prima di chiamare l'endpoint di aggiornamento per un modello specifico. [6]
Procedura passo dopo passo
Passaggio 1. Verifica che il tuo token OAuth includa gli scope corretti di Zoho Desk. Come minimo avrai bisogno di Desk.tickets.READ o Desk.settings.READ nel tuo set di scope autorizzati — entrambi fanno parte del bundle di scope standard di Desk. [5]
Passaggio 2. Invia una richiesta GET all'endpoint dei modelli di ticket:
GET /api/v1/ticketTemplates
Questa è l'operazione canonica (listtickettemplates) che restituisce tutti i modelli di ticket per la tua organizzazione Desk. [4]
Passaggio 3. Facoltativamente, passa i parametri di query tramite il dizionario p (ad esempio, argomenti di paginazione o filtro) come parte della richiesta. L'endpoint accetta un oggetto parametro p, quindi puoi limitare i risultati se il tuo portale ha un numero elevato di modelli. [4]
Passaggio 4. In Python, utilizzando il wrapper client di Desk, la chiamata si presenta così:
def list_ticket_templates(self, p: dict = None):
"""List Ticket Templates"""
return self.c.request("GET", f"/api/v1/ticketTemplates", p, None)
Passa p=None per un elenco non filtrato, oppure fornisci un dizionario di parametri di query per restringere i risultati. [4]
Passaggio 5. Analizza il payload della risposta. Ogni elemento nella raccolta restituita rappresenta un modello di ticket. I campi chiave da acquisire includono l'ID del modello (necessario per qualsiasi aggiornamento successivo tramite PATCH /api/v1/ticketTemplates/{templateId}) e il nome del modello. [6]
Errori comuni
- Scope mancanti. Se il tuo token OAuth è stato generato senza
Desk.tickets.READoDesk.settings.READ, l'API rifiuterà la richiesta. Verifica gli scope elencati nella configurazione del tuo ambiente prima di eseguire qualsiasi altra operazione di risoluzione dei problemi. [5] - URL base errato. L'URL base dell'API di Desk varia in base al data center. Per la regione
.comèhttps://desk.zoho.com; per altre regioni sostituisci il suffisso di dominio appropriato (ad esempio,.eu,.in). Confondere gli URL base di CRM e Desk è un errore comune — sono servizi separati. [3] - Portale vs. ID organizzazione. Gli URL di Desk e i contesti API possono essere limitati a un nome di portale o a un ID organizzazione. Assicurati che le credenziali e il contesto del portale che stai utilizzando corrispondano all'ambiente in cui si trovano i tuoi modelli. [3]
Cosa verificare
- Conferma degli scope: Verifica che
Desk.tickets.READoDesk.settings.READsia presente nel token OAuth attivo prima di effettuare la chiamata. [5] - Risposta non vuota: Conferma che l'array della risposta contenga almeno un modello; un elenco vuoto potrebbe indicare che sei autenticato nel portale o nel reparto sbagliato. [4]
- ID modello acquisiti: Assicurati di aver memorizzato i valori
templateIddalla risposta — ti serviranno per qualsiasi operazione successiva diPATCHo di riferimento. [6]
---
*Beam Help fornisce supporto esperto indipendente per i prodotti Zoho e non è il supporto ufficiale di Zoho. Fai sempre riferimento alla documentazione ufficiale di Zoho per le ultime modifiche all'API.*