Cómo listar plantillas de tickets en Zoho Desk

Listar plantillas de tickets en Zoho Desk es sencillo a través de la API REST: una única solicitud GET al endpoint /api/v1/ticketTemplates devuelve todas las plantillas disponibles en tu portal.

Por qué esto es importante

Las plantillas de tickets permiten a los equipos de soporte rellenar previamente campos, asuntos y descripciones para que los agentes puedan abrir tickets consistentes y bien estructurados con mayor rapidez. Si estás creando una integración, automatizando la creación de tickets o auditando tu configuración de Desk, necesitarás recuperar mediante programación la lista completa de plantillas antes de hacer referencia a cualquiera de ellas o actualizarlas. Este es también un primer paso útil antes de llamar al endpoint de actualización para una plantilla específica. ^[6]

Paso a paso

Paso 1. Confirma que tu token OAuth incluye los scopes correctos de Zoho Desk. Como mínimo, necesitarás Desk.tickets.READ o Desk.settings.READ en tu conjunto de scopes autorizados — ambos forman parte del paquete de scopes estándar de Desk. ^[5]

Paso 2. Envía una solicitud GET al endpoint de plantillas de tickets:

GET /api/v1/ticketTemplates

Esta es la operación canónica (listtickettemplates) que devuelve todas las plantillas de tickets de tu organización en Desk. ^[4]

Paso 3. Opcionalmente, pasa parámetros de consulta a través del diccionario p (por ejemplo, argumentos de paginación o filtrado) como parte de la solicitud. El endpoint acepta un objeto de parámetro p, por lo que puedes acotar los resultados si tu portal tiene un gran número de plantillas. ^[4]

Paso 4. En Python, usando el wrapper del cliente de Desk, la llamada tiene este aspecto:

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

Pasa p=None para obtener una lista sin filtrar, o proporciona un diccionario de parámetros de consulta para acotar los resultados. ^[4]

Paso 5. Analiza el payload de la respuesta. Cada elemento de la colección devuelta representa una plantilla de ticket. Los campos clave que debes capturar incluyen el ID de la plantilla (necesario para cualquier actualización posterior mediante PATCH /api/v1/ticketTemplates/{templateId}) y el nombre de la plantilla. ^[6]

Errores comunes

• Scopes faltantes. Si tu token OAuth fue generado sin Desk.tickets.READ o Desk.settings.READ, la API rechazará la solicitud. Verifica los scopes indicados en la configuración de tu entorno antes de depurar cualquier otra cosa. ^[5]
• URL base incorrecta. La URL base de la API de Desk varía según el centro de datos. Para la región .com es https://desk.zoho.com; para otras regiones, sustituye el sufijo de dominio correspondiente (por ejemplo, .eu, .in). Mezclar las URL base de CRM y Desk es un error frecuente — son servicios independientes. ^[3]
• Portal vs. ID de organización. Las URL y los contextos de la API de Desk pueden estar vinculados a un nombre de portal o a un ID de organización. Asegúrate de que las credenciales y el contexto de portal que estás usando corresponden al entorno donde se encuentran tus plantillas. ^[3]

Qué verificar

• Confirmación de scopes: Verifica que Desk.tickets.READ o Desk.settings.READ aparezca en el token OAuth activo antes de realizar la llamada. ^[5]
• Respuesta no vacía: Confirma que el array de respuesta contiene al menos una plantilla; una lista vacía puede indicar que estás autenticado en el portal o departamento incorrecto. ^[4]
• IDs de plantilla capturados: Asegúrate de haber almacenado los valores de templateId de la respuesta — los necesitarás para cualquier operación posterior de PATCH o referencia. ^[6]

---

*Beam Help ofrece soporte experto independiente para los productos de Zoho y no es el soporte oficial de Zoho. Consulta siempre la documentación propia de Zoho para conocer los últimos cambios en la API.*