Tikety
Sdílená schránka, formuláře a automatizace pro požadavky zákazníků.
API tiketů umožňuje softwaru mimo Xuda pracovat se stolem: otevřít tiket, vypisovat a číst tikety, odpovídat, přiřazovat, přesouvat tiket mezi fázemi a uzavírat ho a číst témata a tým. Formuláře, workflow, AI agenti, interní poznámky a nastavení zůstávají v dashboardu.
Každé volání je POST na https://xuda.ai/cpi/<method> s tělem JSON, které nese klíč API vašeho účtu jako api_key. Volání pracuje se stolem účtu, který klíč vlastní, v rámci tarifu tohoto stolu, a nemůže pojmenovat jiný stůl. Klíč vytvořte v dashboardu pod Vývojáři a držte ho mimo stránky a veřejný kód.
Odpověď je { "code": ..., "data": ... }. Kladný code je úspěch. Odmítnutí je záporný kód s větou v data.
name a details jsou povinné. Kontakt se vytvoří nebo znovu použije z email, tiket se založí se zdrojem api a odpověď je úzký pohled: číslo, id, stav, fáze, předmět, téma, žadatel, id přiřazené osoby a časová razítka. Interní id a stav automatizace se nikdy nevracejí.
email je volitelný, když tiket zakládá integrace nebo agent sám za sebe: pošlete jen name a nevytvoří se žádný kontakt a žadateli se nic neodešle.
Volitelná pole dávají tiketu subject, phone, company, topic_id a subtopic_id z témat stolu, vaše vlastní reference_id, priority od 1 (nejvyšší) do 4, type (issue, bug, feature nebo task) a attachments.
Chcete-li nový tiket někomu předat, pojmenujte ho pomocí assignee_uid nebo assignee_email, jedním z nich. Musí být v týmu pracovního prostoru stolu, což je jeho vlastník a přijatí členové pracovního prostoru. Odmítnutá přiřazená osoba nezaloží žádný tiket.
Najděte a čtěte tikety
ticket_api_list vypisuje tikety s filtry, které má dashboard: status (open nebo closed), source, topic_id, type, assignee_uid, reference_id, fulltextové search v předmětu, podrobnostech a čísle tiketu a rozsah created_from a created_to. Řaďte pomocí sort (date_created_ts, last_activity_ts, status_ts nebo priority) a dir a stránkujte pomocí limit (až 500) a bookmark z předchozí odpovědi.
ticket_api_get čte jeden tiket podle ticket_id, s jeho veřejnými interakcemi. Interní poznámky a koncepty AI se nikdy nevracejí.
ticket_api_topics vrací témata a podtémata stolu, aby váš vlastní formulář mohl ukázat stejný výběr jako hostovaný formulář. ticket_api_team vrací lidi, kterým lze tiket přiřadit, každého s uid, jménem a emailem.
ticket_api_replyvždy zveřejní veřejnou odpověď, nikdy interní poznámku. Je to odpověď stolu, pokud nezadáteas_requester: true, které ji zveřejní jako vlastní zprávu žadatele. V tom případě je upozorněna přiřazená osoba nebo vlastník stolu a nepočítá se jako první odpověď stolu.ticket_api_set_stagepřesune otevřený tiket nanew,in_progress,waiting_customerneboresolved. Uzavřený tiket je odmítnut, pokud nezadátereopen: true, které ho na této fázi znovu otevře. Pojmenování fáze, kterou tiket už má, nic nemění.ticket_api_assignpředá tiket osobě v týmu podleassignee_uidneboassignee_email. Pojmenování současné přiřazené osoby nic nemění. Pokud má tento email více členů týmu, volání je odmítnuto s-409a zadáte místo toho uid.ticket_api_closeuzavře tiket. Volitelnýreasonse zobrazí zákazníkovi. Odpověď zákazníka v okně pro znovuotevření tiket vrátí.
Čtěte vlastní seznam stolu
get_support_tickets čte tikety zpět přihlášenému účtu, který stůl vlastní, a lze ho omezit na jeden tiket pomocí _id. Má jiný tvar než pohled ticket_api_*, který je určen pro volajícího mimo Xuda.
Tarify a limity
Tarif rozhoduje, co klíč smí. Čtení (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) vyžaduje přístup ke čtení a zápis (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) vyžaduje plný přístup. Tarif bez něj odpoví -402. Každý tarif má také počet volání za minutu a nad ním je volání zodpovězeno -429 do další minuty. Historie se řídí oknem uchovávání tarifu, takže starší tiket nelze přečíst. Stránka tarifů má čísla.
Nový tiket se počítá do měsíčního přídělu, jako při jakémkoli jiném způsobu vstupu.