Cómo listar los comentarios de un ticket en Zoho Desk

Listar los comentarios de un ticket en Zoho Desk es sencillo a través de la API REST: envía una solicitud GET al endpoint de comentarios para un ticket determinado y Zoho Desk devuelve todos los comentarios asociados a ese ID de ticket. Aquí en Beam Help — soporte experto independiente para Zoho, no soporte oficial de Zoho — te explicamos exactamente cómo hacerlo.

Por qué esto es importante

Cuando construyes integraciones, automatizaciones o paneles de soporte, a menudo necesitas recuperar de forma programática el hilo de conversación completo de un ticket. El endpoint de comentarios te proporciona acceso estructurado a cada nota interna y respuesta pública de un ticket, lo que lo hace esencial para la generación de informes, la sincronización de datos con sistemas externos o la incorporación de contexto en flujos de trabajo asistidos por IA.

Paso a paso

Paso 1. Asegúrate de que tu token OAuth incluye los scopes correctos de Zoho Desk antes de realizar cualquier llamada a la API. Como mínimo necesitas Desk.tickets.READ en tu lista de scopes, aunque las configuraciones más amplias también incluyen Desk.tickets.ALL y Desk.tickets.WRITE para la gestión completa de tickets.^[3]

Paso 2. Identifica el ticket_id del ticket cuyos comentarios deseas recuperar. Este es el identificador numérico único que Zoho Desk asigna a cada ticket — puedes encontrarlo en la URL del ticket dentro del portal de agentes de Desk, que sigue el patrón https://desk.zoho.com/agent/{portal}/tickets/details/{TicketId}.^[7]

Paso 3. Realiza una solicitud GET al siguiente endpoint, sustituyendo el ID de ticket real:

GET /api/v1/tickets/{ticket_id}/comments

Esta operación se identifica internamente como listticketcomments y acepta el ticket_id como parámetro de ruta obligatorio. También puedes pasar parámetros de consulta opcionales a través del diccionario p (por ejemplo, opciones de paginación o filtrado).^[4]

Paso 4. En Python, la llamada tiene este aspecto:

def list_ticket_comments(self, ticket_id: str, p: dict = None):
    """List ticket comments"""
    return self.c.request("GET", f"/api/v1/tickets/{ticket_id}/comments", p, None)

Pasa el ID de tu ticket como cadena de texto y proporciona cualquier parámetro de consulta como diccionario en el argumento p. Si no tienes parámetros adicionales, pasa None.^[4]

Paso 5. Analiza el cuerpo de la respuesta, que contendrá la lista de comentarios de ese ticket. Cada objeto de comentario incluirá el contenido del comentario, los detalles del autor y las marcas de tiempo — utiliza estos campos para mostrar o procesar el hilo de conversación según sea necesario.^[4]

Paso 6. Si necesitas realizar alguna acción sobre un comentario específico después de listarlos — por ejemplo, editar su contenido — ten en cuenta que existe un endpoint PATCH separado en /api/v1/tickets/{ticketid}/comments/{commentid}, que acepta tanto el ID del ticket como el ID del comentario como parámetros de ruta.^[5] Del mismo modo, para añadir un comentario nuevo se utiliza un POST a /api/v1/tickets/{ticket_id}/comments con un payload de datos.^[2]

Errores comunes

• Scopes ausentes o insuficientes. Si tu token OAuth se generó sin Desk.tickets.READ (o Desk.tickets.ALL), la API devolverá un error de autorización. Verifica la configuración de tus scopes y regenera el token si es necesario.^[3]

• Formato incorrecto del ID de ticket. El ticket_id debe pasarse como cadena de texto en la ruta. Pasar un entero o un valor mal formado hará que la solicitud falle o devuelva resultados inesperados.^[4]

• Confundir comentarios con respuestas. Zoho Desk distingue entre respuestas públicas (visibles para el cliente) y comentarios internos (visibles solo para los agentes). El endpoint /comments apunta específicamente al recurso de comentarios — asegúrate de que estos son los datos que necesitas y no los del endpoint de respuestas.^[2]

• Paginación no gestionada. Si un ticket tiene un gran número de comentarios, la API puede paginar los resultados. Comprueba siempre si la respuesta incluye metadatos de paginación y utiliza el parámetro p para solicitar las páginas siguientes.^[4]

Qué verificar

• Verificación de scopes: Confirma que Desk.tickets.READ o Desk.tickets.ALL está presente en la lista de scopes de tu token OAuth activo antes de llamar al endpoint.^[3]
• Endpoint y método correctos: Verifica que estás realizando un GET a /api/v1/tickets/{ticket_id}/comments — no un POST (que añade un comentario) ni un PATCH (que actualiza uno).^[2][4][5]
• Completitud de la respuesta: Tras recibir la respuesta, comprueba si todos los comentarios esperados están presentes o si es necesario proporcionar parámetros de paginación para recuperar el conjunto completo.^[4]