Beam Help
Solicitar ayuda

How-to · Zoho DESK

Cómo obtener el recuento de resultados de búsqueda en Zoho Desk

Recupera el número total de registros que coinciden con tus criterios de búsqueda.

La recuperación del recuento total de resultados de búsqueda en Zoho Desk se realiza mediante una única solicitud GET al endpoint de recuento de búsqueda de Desk, y requiere que el ámbito OAuth Desk.search.READ esté autorizado previamente.


Por qué esto es importante


Al crear dashboards, automatizaciones o asistentes basados en IA sobre Zoho Desk, a menudo necesitas saber *cuántos* registros coinciden con una consulta antes de decidir si paginar o mostrar un resumen. Conocer el recuento de antemano evita recuperaciones de datos innecesarias y mantiene tu integración eficiente. Esta es también la base para cualquier consulta en lenguaje natural del tipo «¿cuántos tickets coinciden con X?» enrutada a través de una integración de Zoho Desk. Como soporte experto independiente para Zoho — no soporte oficial de Zoho — Beam Help te guía por los pasos exactos a continuación.


---


Paso a paso


Paso 1. Asegúrate de que el ámbito OAuth correcto esté concedido.


Antes de que cualquier operación de búsqueda pueda completarse con éxito, tu token OAuth debe incluir el ámbito Desk.search.READ. Este ámbito se encuentra junto a otros grupos de permisos de Desk, como tickets, contactos, tareas y configuración, en la configuración de ámbitos de tu aplicación. [4] Sin él, la API rechazará la solicitud con un error de autorización.


Paso 2. Confirma que tu token cubre la organización de Desk correcta.


Tu sesión conectada debe llevar los valores correctos de deskorgid y desk_portal para que las solicitudes se enruten al portal de Zoho Desk deseado. [8] Si trabajas en varios centros de datos (EU, AU, IN, etc.), asegúrate de que la URL base refleje el dominio regional correcto — por ejemplo, https://desk.zoho.eu en lugar del predeterminado https://desk.zoho.com. [8]


Paso 3. Llama al endpoint de recuento de búsqueda.


Emite una solicitud GET a:


GET /api/v1/search/count

Pasa tus parámetros de búsqueda como un diccionario de cadena de consulta (el argumento p en el wrapper del SDK). El nombre de la operación es getsearchresults_count y devuelve el número total de registros que coinciden con tus criterios de búsqueda. [3]


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


result = desk_client.get_search_results_count(p={"searchStr": "billing issue"})

El método emite un GET a /api/v1/search/count con los pares clave-valor que suministres en p. [3]


Paso 4. Gestiona la respuesta y extrae el recuento.


La API devuelve un diccionario de resultados. En un contexto de asistente de IA, un helper como extractrecord_count puede analizar este diccionario y devolver un entero simple. [5] Si el resultado contiene una clave error, trátalo como una solicitud fallida e inspecciona el mensaje de error antes de reintentar. [5]


Paso 5. (Opcional) Incorpora el recuento en la lógica posterior.


Una vez que tengas el recuento entero, puedes ramificar tu lógica — por ejemplo, mostrar «Tienes *N* registros que coinciden con ese filtro» a un usuario final, o decidir si activar una recuperación paginada. [6] Si el recuento devuelve None o el resultado es ambiguo, muestra un mensaje aclaratorio en lugar de fallar silenciosamente. [6]


---


Errores comunes


  • Falta el ámbito Desk.search.READ. Esta es la causa más frecuente de una respuesta 401 o 403 en el endpoint de recuento de búsqueda. Verifica que Desk.search.READ aparezca explícitamente en tu cadena de ámbito OAuth — no está implícito en Desk.tickets.ALL ni en ningún otro grupo. [1] [4]

  • Portal o identificador de organización incorrectos. Si deskportal está configurado, tiene precedencia sobre deskorg_id al construir la URL base. Pasar un valor incorrecto enrutará tu solicitud al portal equivocado y devolverá resultados inesperados o un error 404. [8]

  • Pasar None como diccionario de parámetros. El método getsearchresults_count acepta p=None como valor predeterminado, pero omitir los parámetros de búsqueda por completo puede devolver un recuento de todos los registros en lugar de un subconjunto filtrado — confirma que esto coincide con tu intención. [3]

  • Zoho rechaza la solicitud tras un error de parámetro. Si la API devuelve un objeto de error dentro del diccionario de resultados, el patrón recomendado es mostrar un mensaje como «Zoho rechazó la solicitud — ¿qué debo ajustar para poder reintentar?» en lugar de ignorar el error silenciosamente. [5]

---


Qué verificar


  • Lista de ámbitos: Verifica que Desk.search.READ aparezca en la cadena de ámbitos de tu token OAuth activo antes de realizar la llamada. [4]
  • Forma de la respuesta del endpoint: Confirma que el diccionario devuelto contiene un campo de recuento (no una clave error) antes de pasarlo a la lógica posterior. [5]
  • Enrutamiento de portal/organización: Tras una llamada exitosa, contrasta el recuento con la interfaz de Zoho Desk en https://desk.zoho.{dc}/agent/{portal} para asegurarte de que los resultados pertenecen a la organización correcta. [8]

Sources cited

  1. [1] config.py
  2. [2] server.py: chat_stream
  3. [3] GET /api/v1/search/count
  4. [4] server.py: chat
  5. [5] server.py: _count_shortcut_outcome
  6. [6] server.py: build_zoho_links
Recuento de Resultados de Búsqueda | Beam Help — Beam Help