Tikety
Spoločná schránka, formuláre a automatizácie pre požiadavky zákazníkov.
API tiketov umožňuje softvéru mimo Xuda pracovať so stolom: otvoriť tiket, zobraziť a čítať tikety, odpovedať, priradiť, presunúť tiket medzi fázami a zatvoriť ho a čítať témy a tím. Formuláre, workflow, agenti AI, interné poznámky a nastavenia zostávajú v nástenke.
Každé volanie je POST na https://xuda.ai/cpi/<method> s telom JSON, ktoré nesie kľúč API vášho účtu ako api_key. Volanie pracuje so stolom účtu, ktorému kľúč patrí, podľa plánu tohto stola, a nemôže pomenovať iný stôl. Kľúč vytvorte v nástenke v časti Vývojári a nedávajte ho do stránok ani verejného kódu.
Odpoveď je { "code": ..., "data": ... }. Kladný code je úspech. Odmietnutie je záporný kód s vetou v data.
name a details sú povinné. Kontakt sa vytvorí alebo znova použije podľa email, tiket sa založí so zdrojom api a odpoveď je zúžený pohľad: číslo, id, stav, fáza, predmet, téma, žiadateľ, id riešiteľa a časové značky. Interné id a stav automatizácie sa nikdy nevracajú.
email je voliteľný, keď tiket zakladá integrácia alebo agent sám pre seba: pošlite len name a nevytvorí sa žiadny kontakt a žiadateľovi sa nič neposiela.
Voliteľné polia dávajú tiketu subject, phone, company, topic_id a subtopic_id z tém stola, vaše vlastné reference_id, priority od 1 (najvyššia) do 4, type (issue, bug, feature alebo task) a attachments.
Ak chcete nový tiket odovzdať niekomu, pomenujte ho pomocou assignee_uid alebo assignee_email, jedného z dvoch. Musí byť v tíme pracovného priestoru stola, ktorý tvoria vlastník a prijatí členovia pracovného priestoru. Odmietnutý riešiteľ nezaloží žiadny tiket.
Nájdite a čítajte tikety
ticket_api_list zobrazí tikety s filtrami, ktoré má nástenka: status (open alebo closed), source, topic_id, type, assignee_uid, reference_id, voľný text search v predmete, podrobnostiach a čísle tiketu a rozsah created_from a created_to. Zoraďte pomocou sort (date_created_ts, last_activity_ts, status_ts alebo priority) a dir a stránkujte pomocou limit (do 500) a bookmark z predchádzajúcej odpovede.
ticket_api_get číta jeden tiket podľa ticket_id s jeho verejnými interakciami. Interné poznámky a koncepty AI sa nikdy nevracajú.
ticket_api_topics vracia témy a podtémy stola, takže váš vlastný formulár môže zobraziť rovnaký výber ako hostovaný formulár. ticket_api_team vracia ľudí, ktorým sa dá tiket priradiť, každého s uid, menom a emailom.
ticket_api_replyvždy pošle verejnú odpoveď, nikdy internú poznámku. Je to odpoveď stola, pokiaľ nezadáteas_requester: true, čo ju pošle ako vlastnú správu žiadateľa. V tom prípade sa upozorní riešiteľ alebo vlastník stola a nepočíta sa ako prvá odpoveď stola.ticket_api_set_stagepresunie otvorený tiket nanew,in_progress,waiting_customeraleboresolved. Zatvorený tiket sa odmietne, pokiaľ nezadátereopen: true, čo ho v tejto fáze znova otvorí. Zadanie fázy, ktorú tiket už má, nič nezmení.ticket_api_assigndá tiket osobe v tíme podľaassignee_uidaleboassignee_email. Zadanie súčasného riešiteľa nič nezmení. Ak viac ako jeden člen tímu má tento email, volanie sa odmietne s-409a namiesto toho zadáte uid.ticket_api_closezatvorí tiket. Voliteľnýreasonsa zobrazí zákazníkovi. Odpoveď zákazníka v rámci okna na znovuotvorenie tiket vráti.
Čítajte vlastný zoznam stola
get_support_tickets číta tikety späť prihlásenému účtu, ktorému stôl patrí, a dá sa obmedziť na jeden tiket pomocou _id. Má iný tvar než pohľad ticket_api_*, ktorý je určený pre volajúceho mimo Xuda.
Plány a limity
Plán určuje, čo smie kľúč robiť. Čítanie (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) vyžaduje prístup na čítanie a zápis (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) vyžaduje plný prístup. Plán bez neho odpovie -402. Každý plán má aj počet volaní za minútu a nad ním sa volanie odpovie -429 do ďalšej minúty. História sleduje okno uchovávania plánu, takže tiket starší než ono sa nedá prečítať. Čísla uvádza stránka Plány.
Nový tiket sa počíta do mesačného limitu, rovnako ako z ktoréhokoľvek iného vstupu.