Elencare le voci di tempo per un'attività in Zoho Desk è semplice una volta che disponi dell'ID attività corretto e degli scope OAuth appropriati — una singola richiesta GET restituisce tutte le voci di tempo associate a quell'attività.
Perché è importante
Quando il tuo team di supporto registra il tempo sulle attività in Zoho Desk, potresti dover recuperare quei record in modo programmatico — per la fatturazione, la reportistica o l'integrazione con strumenti esterni. Conoscere l'endpoint esatto e le autorizzazioni necessarie ti evita debug per tentativi ed errori. Questo è particolarmente rilevante se stai creando automazioni o dashboard che mostrano i dati sull'impegno degli agenti.
Procedura passo dopo passo
Passaggio 1. Verifica che il tuo token OAuth includa lo scope corretto relativo alle attività. La tua connessione a Zoho Desk deve essere autorizzata con almeno Desk.tasks.READ (e idealmente Desk.tasks.ALL) per recuperare i dati delle voci di tempo. Senza questo scope, l'API rifiuterà la richiesta prima che raggiunga l'endpoint. [5]
Passaggio 2. Identifica il taskId dell'attività di cui vuoi recuperare le voci di tempo. Questo è l'identificatore univoco che Zoho Desk assegna a ogni record di attività. Puoi ottenerlo da una precedente chiamata di elenco attività o direttamente dall'URL dell'attività nell'interfaccia di Zoho Desk. [6]
Passaggio 3. Invia una richiesta GET al seguente endpoint, sostituendo il tuo identificatore di attività effettivo:
GET /api/v1/tasks/{taskId}/timeEntries
Il nome dell'operazione per questa chiamata è listtasktime_entries. L'endpoint accetta due parametri: taskId (obbligatorio, l'ID univoco dell'attività) e p (facoltativo, utilizzato per la paginazione o parametri di query aggiuntivi). [6]
Passaggio 4. In Python, la chiamata può essere strutturata come mostrato di seguito. Il parametro p viene passato come dizionario e può essere omesso se non hai bisogno di filtrare o paginare i risultati:
def list_task_time_entries(self, taskId: str, p: dict = None):
return self.c.request("GET", f"/api/v1/tasks/{taskId}/timeEntries", p, None)
Questo metodo invia la richiesta tramite il tuo client Zoho Desk configurato, che gestisce automaticamente l'autenticazione e l'ID organizzazione. [6]
Passaggio 5. Assicurati che l'ID organizzazione di Zoho Desk (deskorgid) sia impostato correttamente sul tuo client API prima di effettuare la chiamata. Se l'ID organizzazione è mancante o errato, la piattaforma non sarà in grado di instradare la richiesta all'account corretto. Gli strumenti del nostro team rilevano automaticamente l'ID organizzazione dal primo elemento restituito dall'endpoint delle organizzazioni e lo memorizzano per le chiamate successive. [7]
Errori comuni
- Scope mancante: Se
Desk.tasks.READoDesk.tasks.ALLè assente dal tuo token OAuth, la richiesta fallirà con un errore di autorizzazione. Ri-autorizza la tua connessione con l'elenco completo degli scope delle attività prima di riprovare. [5] taskIderrato o non aggiornato: Passare un ID che appartiene a un'attività eliminata o inaccessibile restituirà un risultato vuoto o un errore. Valida sempre l'ID attività rispetto a una risposta aggiornata dell'elenco attività. [6]- ID organizzazione non risolto: Se la proprietà
org_iddel tuo client è vuota, Zoho Desk non riesce a identificare quale organizzazione interrogare. Avvia il flusso di rilevamento dell'organizzazione per popolare questo valore prima di chiamare qualsiasi endpoint di Desk. [7]
Cosa verificare
- Verifica che il tuo token OAuth attivo includa
Desk.tasks.READoDesk.tasks.ALLnel suo elenco di scope. [5] - Conferma che il valore
taskIdsia valido e appartenga a un'attività all'interno dell'organizzazione Zoho Desk corretta. [6] - Controlla che
deskorgidsia popolato sul tuo client API in modo che le richieste vengano instradate all'account corretto. [7]
---
*Beam Help fornisce supporto esperto indipendente per Zoho — non siamo il supporto ufficiale di Zoho. Per problemi a livello di piattaforma, fai sempre riferimento direttamente alla documentazione API di Zoho Desk.*