Zgłoszenia
Wspólna skrzynka, formularze i automatyzacje dla próśb klientów.
API zgłoszeń pozwala oprogramowaniu spoza Xuda obsługiwać biurko: otworzyć zgłoszenie, wyświetlać i czytać zgłoszenia, odpowiadać, przypisywać, przenosić zgłoszenie między etapami i je zamykać oraz czytać tematy i zespół. Formularze, przepływy pracy, agenci AI, notatki wewnętrzne i ustawienia zostają w dashboardzie.
Każde wywołanie to POST na https://xuda.ai/cpi/<method> z treścią JSON, która niesie klucz API Twojego konta jako api_key. Wywołanie działa na biurku konta, które jest właścicielem klucza, w ramach planu tego biurka, i nie może wskazać innego biurka. Utwórz klucz w dashboardzie w sekcji Developers i trzymaj go z dala od stron i publicznego kodu.
Odpowiedź ma postać { "code": ..., "data": ... }. Dodatni code oznacza sukces. Odmowa to ujemny kod ze zdaniem w data.
name i details są wymagane. Kontakt jest tworzony lub używany ponownie na podstawie email, zgłoszenie jest zakładane ze źródłem api, a odpowiedź to wąski widok: numer, id, status, etap, temat, zgłaszający, id osoby przypisanej i znaczniki czasu. Wewnętrzne identyfikatory i stan automatyzacji nigdy nie są zwracane.
email jest opcjonalny, gdy integracja lub agent zakłada zgłoszenie dla siebie: wyślij samo name, a kontakt nie powstaje i nic nie jest wysyłane do zgłaszającego.
Pola opcjonalne nadają zgłoszeniu subject, phone, company, topic_id i subtopic_id z tematów biurka, Twój własny reference_id, priority od 1 (najwyższy) do 4, type (issue, bug, feature lub task) i attachments.
Aby przekazać nowe zgłoszenie komuś, wskaż osobę przez assignee_uid lub assignee_email, jedno z dwóch. Musi być w zespole przestrzeni roboczej biurka, czyli jej właścicielem i zaakceptowanymi członkami przestrzeni roboczej. Odrzucona osoba przypisana oznacza, że zgłoszenie nie jest zakładane.
Znajdź i czytaj zgłoszenia
ticket_api_list wyświetla zgłoszenia z filtrami, które ma dashboard: status (open lub closed), source, topic_id, type, assignee_uid, reference_id, wyszukiwanie tekstowe search w temacie, szczegółach i numerze zgłoszenia oraz zakres created_from i created_to. Sortuj przez sort (date_created_ts, last_activity_ts, status_ts lub priority) i dir, a stronicuj przez limit (do 500) i bookmark z poprzedniej odpowiedzi.
ticket_api_get czyta jedno zgłoszenie po ticket_id, z jego publicznymi interakcjami. Notatki wewnętrzne i szkice AI nigdy nie są zwracane.
ticket_api_topics zwraca tematy i podtematy biurka, więc Twój własny formularz może pokazać ten sam wybór co formularz hostowany. ticket_api_team zwraca osoby, którym można przypisać zgłoszenie, każdą z uid, nazwą i emailem.
ticket_api_replyzawsze wysyła publiczną odpowiedź, nigdy notatkę wewnętrzną. To biurko odpowiada, chyba że przekażeszas_requester: true, co wysyła ją jako własną wiadomość zgłaszającego. W takim przypadku osoba przypisana albo właściciel biurka dostaje powiadomienie, a odpowiedź nie liczy się jako pierwsza odpowiedź biurka.ticket_api_set_stageprzenosi otwarte zgłoszenie nanew,in_progress,waiting_customerlubresolved. Zamknięte zgłoszenie jest odrzucane, chyba że przekażeszreopen: true, co otwiera je ponownie na tym etapie. Wskazanie etapu, który zgłoszenie już ma, niczego nie zmienia.ticket_api_assignprzekazuje zgłoszenie osobie z zespołu przezassignee_uidlubassignee_email. Wskazanie obecnej osoby przypisanej niczego nie zmienia. Jeśli więcej niż jeden członek zespołu ma ten email, wywołanie jest odrzucane z-409i przekazujesz zamiast tego uid.ticket_api_closezamyka zgłoszenie. Opcjonalnereasonjest pokazywane klientowi. Odpowiedź klienta w oknie ponownego otwarcia przywraca zgłoszenie.
Odczytaj własną listę biurka
get_support_tickets odczytuje zgłoszenia dla zalogowanego konta, które jest właścicielem biurka, i można go ograniczyć do jednego zgłoszenia przez _id. Ma inny kształt niż widok ticket_api_*, który jest zbudowany dla wywołującego spoza Xuda.
Plany i limity
O tym, co może klucz, decyduje plan. Odczyt (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) wymaga dostępu do odczytu, a zapis (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) wymaga pełnego dostępu. Plan bez niego odpowiada -402. Każdy plan ma też liczbę wywołań na minutę, a po jej przekroczeniu wywołanie dostaje -429 do następnej minuty. Historia zależy od okna przechowywania planu, więc zgłoszenia starszego od niego nie można odczytać. Liczby są na stronie planów.
Nowe zgłoszenie wlicza się do miesięcznego limitu, tak jak z każdej innej drogi.