Tichete
Inbox comun, formulare și automatizări pentru cererile clienților.
API-ul de tichete lasă un software din afara Xuda să lucreze un birou: să deschidă un tichet, să listeze și să citească tichete, să răspundă, să atribuie, să mute un tichet între etape și să-l închidă și să citească subiectele și echipa. Formularele, fluxurile de lucru, agenții AI, notele interne și setările rămân în dashboard.
Fiecare apel este un POST către https://xuda.ai/cpi/<method> cu un corp JSON care poartă cheia API a contului tău ca api_key. Un apel funcționează pe biroul contului care deține cheia, sub planul acelui birou, și nu poate numi alt birou. Creează cheia în dashboard la Developers și ține-o departe de pagini și de cod public.
Răspunsul este { "code": ..., "data": ... }. Un code pozitiv înseamnă succes. O refuzare este un cod negativ cu o propoziție în data.
name și details sunt obligatorii. Un contact este creat sau refolosit după email, tichetul este înregistrat cu sursa api, iar răspunsul este o vedere restrânsă: număr, id, stare, etapă, subiect, topic, solicitant, id-ul responsabilului și marcajele de timp. Id-urile interne și starea automatizărilor nu sunt returnate niciodată.
email este opțional când o integrare sau un agent înregistrează tichetul pentru sine: trimite doar un name și nu se creează niciun contact și nu se trimite nimic prin email solicitantului.
Câmpurile opționale dau tichetului un subject, phone, company, un topic_id și subtopic_id din subiectele biroului, propriul tău reference_id, o priority de la 1 (cea mai mare) la 4, un type (issue, bug, feature sau task) și attachments.
Ca să dai noul tichet cuiva, numește persoana cu assignee_uid sau assignee_email, unul dintre cele două. Persoana trebuie să fie în echipa spațiului de lucru al biroului, adică proprietarul și membrii acceptați ai spațiului de lucru. Un responsabil refuzat nu înregistrează niciun tichet.
Găsește și citește tichete
ticket_api_list listează tichete cu filtrele pe care le are dashboardul: status (open sau closed), source, topic_id, type, assignee_uid, reference_id, o căutare text liber search în subiect, detalii și numărul tichetului și un interval created_from și created_to. Sortează cu sort (date_created_ts, last_activity_ts, status_ts sau priority) și dir și paginează cu limit (până la 500) și bookmark din răspunsul anterior.
ticket_api_get citește un tichet după ticket_id, cu interacțiunile lui publice. Notele interne și schițele AI nu sunt returnate niciodată.
ticket_api_topics returnează subiectele și sub-subiectele biroului, ca propriul tău formular să poată arăta același selector pe care îl arată formularul găzduit. ticket_api_team returnează persoanele cărora le poate fi atribuit un tichet, fiecare cu uid, nume și email.
ticket_api_replypostează întotdeauna un răspuns public, niciodată o notă internă. Este biroul care răspunde, dacă nu transmițias_requester: true, care îl postează ca mesaj propriu al solicitantului. În acest caz, responsabilul sau proprietarul biroului este notificat, iar mesajul nu se numără ca primul răspuns al biroului.ticket_api_set_stagemută un tichet deschis lanew,in_progress,waiting_customersauresolved. Un tichet închis este refuzat dacă nu transmițireopen: true, care îl deschide din nou la acea etapă. Numirea etapei pe care tichetul o are deja nu schimbă nimic.ticket_api_assigndă un tichet unei persoane din echipă dupăassignee_uidsauassignee_email. Numirea responsabilului curent nu schimbă nimic. Dacă mai mult de un membru al echipei are acel email, apelul este refuzat cu-409și transmiți în schimb uid-ul.ticket_api_closeînchide tichetul.reasonopțional este arătat clientului. Un răspuns al clientului în fereastra de redeschidere readuce tichetul.
Citește lista proprie a biroului
get_support_tickets citește tichetele înapoi pentru contul autentificat care deține biroul și poate fi limitat la un tichet cu _id. Are o formă diferită de vederea ticket_api_*, care este făcută pentru un apelant din afara Xuda.
Planuri și limite
Planul decide ce poate face o cheie. Citirea (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) cere acces de citire, iar scrierea (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) cere acces complet. Un plan fără el răspunde -402. Fiecare plan are și un număr de apeluri pe minut, iar peste el un apel primește -429 până la minutul următor. Istoricul urmează fereastra de păstrare a planului, deci un tichet mai vechi decât ea nu poate fi citit. Pagina de planuri are cifrele.
Un tichet nou se numără la cota lunii, ca prin orice altă cale de intrare.