Konradodocs
PołączeniaIntegracjeHelpdesk

Podłącz własny helpdesk

Podłącz helpdesk, dla którego Konrado nie ma gotowej integracji. Twój programista buduje małe API, a Konrado czyta Twoje zgłoszenia i odpowiada na nie przez to API.

Gdy podłączysz własny helpdesk, Konrado czyta Twoje zgłoszenia, pisze szkice odpowiedzi i zna klienta, którego dotyczy każde zgłoszenie, tak samo jak przy WHMCS. Wymaga to pracy programisty po Twojej stronie. Twój helpdesk musi obsługiwać API wtyczki Konrado: zestaw adresów internetowych, które zwracają zgłoszenia, klientów i produkty w formacie, który czyta Konrado. Dodatek Konrado do WHMCS obsługuje to samo API.

Co czyta Konrado

DaneJak to pomaga
Zgłoszenia i ich wiadomościKonrado pisze odpowiedź na podstawie tego, co napisał klient
DziałyWybierasz, z którymi działami pracuje Konrado
Osoby z Twojego zespołu w helpdeskuAutomatyczna odpowiedź wychodzi od osoby, którą wybierzesz
Statusy zgłoszeńAutomatyczna odpowiedź może ustawić status zgłoszenia
Klienci, ich usługi i fakturyKonrado wie, kto napisał i za co płaci
Produkty, dodatki, promocje i ceny domenTwój katalog trafia do sekcji Baza wiedzy
Zamknięte zgłoszeniaW sekcji Wcześniejsze zgłoszenia Konrado uczy się, jak odpowiadał Twój zespół

Co zapisuje Konrado

ZapisKiedy
Odpowiedź w zgłoszeniuTylko gdy Automatyczne odpowiedzi działają w trybie Na żywo. Konrado nigdy sam nie publikuje szkicu z funkcji Copilot
Nowe zgłoszenieGdy odwiedzający wyśle formularz zgłoszenia z czatu na stronie (ustawiany w sekcji Eskalacje)

Czego Konrado nie potrafi

Nie da sięDlaczego
Zmienić niczego innego w Twoim helpdeskuKonrado wywołuje tylko trasy, które zbuduje Twój programista. Zobacz trasy
Przeczytać zgłoszenia spoza zakresu zgłoszeńO tym, co widzi Konrado, decydują działy, zablokowane tagi i zablokowani nadawcy ustawieni w połączeniu
Działać obok drugiego helpdeskuTwoja organizacja może mieć tylko jeden helpdesk naraz
Działać, gdy Twoje API nie odpowiadaPołączenie zmienia status na Nie działa, dopóki API znowu nie odpowie
Model bezpieczeństwa

Konrado wywołuje Twoje API z kluczem z pola Klucz API. Twój helpdesk wysyła do Konrado zdarzenia zgłoszeń z tokenem z pola Token webhooka. Klucz API utworzył Konrado dla Twojego modułu, więc administrator może go ponownie odczytać pod przyciskiem Zarządzaj. Konrado przechowuje tylko odcisk tokenu webhooka, więc pokazuje cały token tylko raz. Przycisk Nowy token zastępuje go nowym.

Przykładowe pytania w zgłoszeniach
  • "Czy moja faktura z zeszłego tygodnia jest opłacona?"
  • "Jaki mam plan i kiedy się odnawia?"
  • "Dlaczego moja usługa została zawieszona?"
  • "Możesz sprawdzić status mojego drugiego zgłoszenia?"

Zanim zaczniesz

  • Twój programista zbudował API na Twoim helpdesku oraz moduł, który wysyła zdarzenia zgłoszeń. W konsoli nazywa się to Twoim modułem Konrado. Zobacz, co buduje Twój programista.
  • Konto właściciela lub administratora w Konrado.
  • Żaden inny helpdesk nie jest podłączony w Konrado.
  • Jeśli Twój helpdesk stoi za zaporą sieciową, zezwól na adresy IP Konrado.

Podłączanie

Otwórz formularz

Otwórz Ustawienia obszaru roboczegoIntegracje, kliknij Dodaj integrację, wybierz Helpdesk, a potem Własny helpdesk.

Wpisz adres

PoleCo wpisać
Nazwa integracjiNazwa znana Twojemu zespołowi. Taką nazwę dostaje kanał helpdesku
Bazowy adres APIAdres, pod którym odpowiada Twoje API, na przykład https://yourdomain.com/api. Konrado dodaje do niego /v1/tickets i pozostałe trasy
Adres zgłoszeńOpcjonalne. Adres, pod którym Twój zespół otwiera zgłoszenie. Konrado uzupełnia go na podstawie pierwszego zgłoszenia podczas testu połączenia

Skopiuj klucze do modułu

Pole Klucze do modułu Konrado zawiera dwie wartości, każdą z przyciskiem kopiowania. Wklej obie do swojego modułu.

  • Klucz API: utworzył go Konrado. Opcja Użyj własnego klucza pozwala wpisać klucz, który Twój moduł już ma.
  • Token webhooka: cały token widzisz tylko teraz. Skopiuj go, zanim klikniesz Podłącz.
Pole Klucze do modułu Konrado: Klucz API z przyciskiem kopiowania i opcją Użyj własnego klucza oraz Token webhooka z przyciskiem kopiowania

Nie zamykaj formularza podczas wklejania. Klucze zapisują się dopiero po kliknięciu Podłącz.

Przetestuj i podłącz

Kliknij Testuj połączenie. Konrado czyta jedno zgłoszenie przez Twoje API. Gdy test się powiedzie, kliknij Podłącz.

Sprawdź, czy działa

W tabeli integracja ma status Połączono. Konrado dodaje agenta o nazwie Ticket Agent z kanałem Helpdesk dla tego helpdesku i włączoną funkcją Copilot. Otwórz testowe zgłoszenie w swoim helpdesku: pojawi się na stronie Skrzynka. Skonfiguruj kanał Helpdesk.

Co buduje Twój programista

API

Konrado wywołuje te trasy pod adresem z pola Bazowy adres API. Każde wywołanie przekazuje klucz API w nagłówku Authorization jako Token <API Key> oraz tę samą wartość w AuthorizationX dla serwerów, które usuwają nagłówek Authorization.

TrasyDo czego Konrado ich używa
GET /v1/tickets, GET /v1/tickets/{id}Test połączenia, czytanie zgłoszeń i sekcja Wcześniejsze zgłoszenia
POST /v1/tickets/{id}/send-replyWysyłanie automatycznej odpowiedzi: tekst w Markdown, e-mail nadawcy i nowy status
POST /v1/ticketsOtwieranie zgłoszenia z czatu na stronie
GET /v1/departmentsZakres zgłoszeń i formularz zgłoszenia na czacie na stronie
GET /v1/agents, GET /v1/ticket-statusesNadawca i status automatycznej odpowiedzi
GET /v1/clients, GET /v1/clients/{id}Znajdowanie klienta, którego dotyczy zgłoszenie lub czat
GET /v1/clients/{id}/services, GET /v1/clients/{id}/invoicesUsługi i faktury klienta
GET /v1/clients/{id}/services/{service_type}/{service_id}/invoicesFaktury jednej usługi
GET /v1/clients/{id}/services/{service_type}/{service_id}/ssoFunkcja SSO do serwera w rozszerzeniu przeglądarki
GET /v1/products, GET /v1/product-addons, GET /v1/promotions, GET /v1/tlds/pricingKatalog produktów
GET /v1/infoWersja widoczna przy połączeniu
GET /v1/check-domain-availability/{domain}Sprawdzanie, czy domena jest wolna

Test połączenia wywołuje GET /v1/tickets?limit=1&offset=0. Trasa GET /v1/info, trasy katalogu i trasa domeny są opcjonalne. Jeśli trasa katalogu odpowie 404, Konrado wie, że katalog jest niedostępny, i zachowuje zapisaną wcześniej kopię.

POST /v1/tickets dostaje department_id, subject, message i requester_email, a także client_id dla zalogowanego klienta i requester_name, gdy Konrado je zna. W odpowiedzi zwraca id nowego zgłoszenia w polu data.

Otwórz dokumentację API, aby zobaczyć pola każdej trasy.

Zdarzenia zgłoszeń

Gdy zgłoszenie się zmienia, Twój moduł wysyła zdarzenie do Konrado:

  • Adres URL: https://app.konrado.ai/api/v1/webhooks/ticket, metoda POST.
  • Nagłówek Authorization: token webhooka w niezmienionej postaci, bez prefiksu.
  • Nagłówek Content-Type: application/json.
eventTypeWyślij, gdyTreść zawiera
ticket.updatedZmienia się cokolwiek w zgłoszeniu: nowe zgłoszenie, odpowiedź, notatka, status, temat, działdata: całe zgłoszenie w formacie, który zwraca GET /v1/tickets/{id}
ticket.deletedZgłoszenie zostaje usunięteticketId
ticket.mergedZgłoszenia zostają połączoneticketId zgłoszenia, które zostaje, i mergedTicketIds zgłoszeń do niego dołączonych. Zgłoszenie, które zostaje, wyślij też jako ticket.updated

Każda treść zawiera też source, czyli nazwę Twojej platformy. Konrado rozpoznaje Twój helpdesk po tokenie, nie po source. Po zdarzeniu ticket.updated Konrado ponownie czyta zgłoszenie przez GET /v1/tickets/{id}.

{
  "source": "my-helpdesk",
  "eventType": "ticket.deleted",
  "ticketId": "1042"
}

Konrado odpowiada 202, gdy dodał zgłoszenie do kolejki, 200, gdy od razu obsłużył zdarzenie, i 401, gdy brakuje tokenu lub token jest błędny.

Wybierz, którzy agenci korzystają z wyszukiwania

Na czacie na stronie Konrado może sprawdzić usługi, faktury, zgłoszenia i dane konta zalogowanego klienta, a także narzędzia serwerowe jego usługi. Zakładka Narzędzia w połączeniu pokazuje te funkcje wyszukiwania. Każdy agent może z nich korzystać. Aby ograniczyć jedną z nich, kliknij ją i wybierz Wybrani agenci.

Wyszukiwanie działa tylko dla klientów, których Twoja strona loguje na czacie. Skonfiguruj weryfikację tożsamości.

Zakładka Narzędzia podłączonego własnego helpdesku: pięć funkcji wyszukiwania dla zalogowanych klientów, każdej używają Wszyscy agenci

Jeśli coś nie działa

Co widziszCo zrobić
Testuj połączenie kończy się błędemTwoje API musi odpowiadać na GET /v1/tickets?limit=1&offset=0 pod adresem z pola Bazowy adres API, z kluczem API z formularza
Inny helpdesk jest już połączony. Najpierw go rozłącz.Twoja organizacja może mieć tylko jeden helpdesk naraz. Odłącz drugi na stronie Integracje
Integracja zmienia status na Nie działaSprawdź, czy Twoje API działa i czy Twój moduł nadal ma klucz API widoczny pod przyciskiem Zarządzaj
Zgłoszenia nie docierają do KonradoSprawdź, czy moduł wysyła zdarzenia na powyższy adres z aktualnym tokenem webhooka. Kod 401 oznacza, że token jest błędny albo ktoś utworzył nowy token przyciskiem Nowy token
Źródło katalogu produktów pokazuje komunikat Platforma wsparcia nie udostępniła produktów (HTTP 404), więc nie udało się odświeżyć tego źródła.Twoje API nie ma jeszcze tras katalogu. Konrado zachowuje zapisane produkty

Usuń integrację

Otwórz Ustawienia obszaru roboczegoIntegracje, otwórz menu wiersza (...) i kliknij Odłącz. Konrado przestaje czytać zgłoszenia. Dane logowania i historia zgłoszeń zostają, więc możesz później podłączyć helpdesk ponownie. Potem wyłącz wysyłanie zdarzeń w swoim module.

Ostatnia aktualizacja:

Na tej stronie