Co to są zapytania API?
API to metoda, za pomocą której jeden program może “negocjować” z innym. Możesz poprosić oki-toki o przesłanie lub odbiór potrzebnych danych. Na przykład, automatycznie wysyłać informacje o kliencie do twojego CRM lub wczytywać dane z powrotem do Oki-Toki.
Jakie korzyści niesie za sobą API dla call center?
- Automatyzacja procesów: API przejmuje zadania rutynowe. Na przykład nowy kontakt jest wysyłany do twojego CRM, automatycznie aktualizując dane;
- Integracja: dzięki API łatwo połączyć Oki-Toki z innymi systemami – CRM, analityką, chatbotami itp. Wszystkie narzędzia pracują razem jako całość, co upraszcza i przyspiesza procesy biznesowe.
- Dane w czasie rzeczywistym: system wysyła lub odbiera informacje, jak tylko się pojawią. To jest wygodne do analiz, monitoringu;
- Łatwa skalowalność: możesz dodawać nowe funkcje i narzędzia bez skomplikowanych zmian. To jest szczególnie wygodne, jeśli Twój projekt rośnie;
- Zmniejszenie liczby błędów: mniej pracy manualnej — mniejsze ryzyko popełnienia błędów. Wszystko dzieje się automatycznie, szybko i dokładnie.
Typy zapytań API w Oki-Toki
Oki-Toki używa standardowej metody interakcji z usługami sieciowymi – REST API. System odbiera informacje na żądanie i dostarcza odpowiedź w pożądanym formacie, najczęściej JSON. W Oki-Toki dostępne są następujące metody zapytań:
- GET – używane do pobierania informacji, takich jak kontakty z CRM czy statystyki połączeń;
- POST – wysyła nowe dane do systemu, na przykład masowe dodawanie lub usuwanie zadań автодозвона, włączanie/wyłączanie автодозвона.
Do testowania żądania, sprawdzenia poprawności danych lub znalezienia błędu, Postman jest odpowiedni.
Dokumentacja i konfiguracja API w Oki-Toki
Dokumentacja API oki-toki to Twój przewodnik po pracy, opisujący metody żądań, przykłady użycia i strukturę danych. Dla wygody, dokumentacja techniczna API jest podzielona na sekcje w oparciu o główne funkcje i narzędzia Oki-Toki.
Dostęp do API
Dostęp do API odbywa się za pomocą tokenów – to klucze, które pozwalają systemowi zrozumieć, kto do niego uzyskuje dostęp. Dzięki nim łatwo pracuje się z API i bezpiecznie przekazuje dane.
W Oki-Toki użytkownik może stworzyć swój token, gdy ma prawo “Zarządzanie użytkownikami” w swojej Roli. Takie prawo jest dostępne w domyślnych rolach “Admin” i “Supervisor” , ale może być również dodane do dowolnej roli, którą stworzysz.
“Zarządzanie zewnętrznymi zasobami, integracjami i zdarzeniami (Webhook)” to kolejne prawo potrzebne do pracy z API. Bez niego tworzenie integracji lub dodanie Webhooka nie będzie możliwe.
Dowiedz się więcej o rolach w osobnym artykule na blogu.
Jak zdobyć klucz API?
Aby stworzyć jakiekolwiek żądanie API, potrzebujesz tokenu. Aby go wygenerować, przejdź do sekcji Lista użytkowników. Wybierz pozycję “Bezpieczeństwo” w ustawieniach profilu. Tutaj możesz stworzyć, zobaczyć lub usunąć token.
Kody błędów żądania API
Każdy może popełnić błąd – nawet profesjonaliści napotykają trudności w przekazywaniu danych lub wykonywaniu zadań. Najważniejsze, to wiedzieć, jak to naprawić. Przygotowaliśmy listę błędów API najczęstszych podczas wykonywania zapytań API:
- 401 (Unauthorized) – żądanie określa nieistniejący obiekt lub Twój token jest niepoprawny;
- 403 (Forbidden) – oznacza, że serwer zrozumiał żądanie, ale odmawia dostępu. Możesz nie mieć praw i uprawnień do wykonania tego żądania;
- 404 (Not Found) – w linku URL są błędy, sprawdź dokładność wprowadzonych danych;
- 405 Method Not Allowed – niepoprawny typ żądania. Na przykład, próbowałeś użyć metody POST zamiast GET;
- 422 (Unprocessable Entity) – żądanie zostało przyjęte, ale nie zostało przetworzone z powodu błędu semantycznego w “ciele” danych;
- 429 Too Many Requests – przekroczenie limitu żądań;
- 500 (Internal Server Error)– problemy z działaniem serwera lub przetwarzaniem twojego żądania.
Każdy błąd API jest zaopatrzony w kod i wiadomość, które pomogą określić przyczynę problemu i naprawić go.
Przykłady użycia API w Oki-Toki
API oki-toki to narzędzie do rozwiązywania wielu zadań w call center. Oto kilka przykładów, gdzie jego użycie może zaoszczędzić czas i uprościć procesy:
- Dodawanie klientów do dialers do ponownej obróbki przychodzących połączeń/bazy zimnej – po udanym połączeniu z operatorem, dane są automatycznie przekazywane do dalszego обзвона. Oszczędza to czas i zmniejsza ryzyko błędów poprzez eliminację obróbki ręcznej;
- Usuwanie zadań z dialers – zadania, które zostały przetworzone i nie są już aktualne, bo klienci zrezygnowali, zostaną usunięte z listy автодозвона;
- Przekazywanie danych rozmowy do CRM – wszystkie niezbędne dane rozmowy potrzebne do dalszej pracy z klientem zostaną przekazane do CRM;
- Aktualizacja kontaktu w CRM – Na przykład, zmiana statusu zadań lub dodawanie nowych parametrów do analizy.
Jak stworzyć żądanie API?
Aby stworzyć żądanie do pracy z danymi w oki-toki, najpierw zapoznaj się z dokumentacją API. Tutaj zebrane są informacje o tym, jakie dane można przekazać lub odbierać. Wybierz potrzebne żądanie i zobacz, jakie dodatkowe informacje mogą być potrzebne, na przykład ID Dialer.
Aby znaleźć te dane, przejdź do wymaganego автодозвона. ID będzie wskazane w linku w pasku adresu przeglądarki — to numer po nazwie narzędzia.
Przykład żądania API w Postman: dodanie do czarnej listy
Sformułujemy link żądania w programie Postman, który będzie musiał być zainstalowany na Twoim urządzeniu. Znajdujemy w Dokumentacji sekcję “Listy”, wybieramy żądanie “Dodawanie wartości do listy” . Żądanie dodaje dane do Twoich List. Nie musi to być koniecznie “Czarna lista”, może chcesz uzupełnić “Listę klientów VIP” lub jakąkolwiek inną, która pasuje do Twoich procesów biznesowych.Przejdźmy do formułowania linku API:
- szukaj w dokumentacji typu żądania – w naszym przypadku to post i kopiuj link URL https://home.oki-toki.net/api/v1/lists/add. Przejdź do Postmana, ustaw typ i wklej link.
- następny krok – Twój token. Jak wygenerować token opisaliśmy powyżej w artykule;
- w żądaniu niezbędne jest określenie parametru ID listy. Aby to zrobić, przejdź do sekcji Listy, znajdź wymaganą, skopiuj numer z paska adresu i przekaż go do Postmana.
- Parametr “values” należy uzupełnić danymi, które trafią na listę, na przykład numerem telefonu;
Po wprowadzeniu wszystkich parametrów formułujemy link w tej formie: https://home.oki-toki.net/api/v1/lists/add?api_token=(TWÓJ TOKEN)list_id=101&values=(NUMER TELEFONU)Generujemy żądanie, jeśli wszystko jest poprawne otrzymujemy odpowiedź – 200 OK. Teraz wymagany numer jest dodany do czarnej listy.
Aby ustawić różne warunki dla wyzwalania żądań, użyj zdarzeń. Umożliwiają one nie tylko przekazywanie danych o rozmowach i klientach, ale także informacje o naruszeniach, statusach użytkowników i wyzwalaniu analizy mowy. Pozwala to monitorować kluczowe wskaźniki wydajności operatorów, ich aktywność, rejestrowanie odchyleń od scenariuszy lub naruszeń dyscyplinarnych w celu utrzymania wysokiego poziomu jakości obsługi.
Jak skonfigurować integrację API?
Jeśli potrzebujesz połączyć oki-toki z zewnętrznym zasobem, integracja API może pomóc. Na przykład, transfer danych klienta lub dodanie numeru do автодозвона może być zautomatyzowany przez API. Ustawienia składają się z dwóch etapów:
Etap 1. Tworzenie webhooka
Na początku należy utworzyć webhook w sekcji Zewnętrzne zasoby:
- Podaj nazwę;
- W linii URL przekaż link, w zależności od zadania do wykonania. Na przykład, aby dodać zadanie do автодозвона, należy znaleźć w dokumentacji technicznej żądanie “Dodawanie zadania (numeru) do rozmowy“, skopiować link i wkleić go w linii URL;
- Wybierz metodę przekazywania danych z listy: GET, POST, JSON;
- W linii “Wspólne parametry żądania” wpisz swój klucz dostępu w formacie: api_token= TWÓJ TOKEN.
Przykład pokazuje, jak stworzyć webhook do automatyzacji zadań wewnątrz Oki-Toki. Jeśli w linii URL podano link do zewnętrznego systemu, wtedy oki-toki zintegruje się z nim. Czytaj jak zintegrować chatbota z Telegramem na naszym blogu.
Etap 2. Tworzenie zdarzenia
Przejdź do sekcji Zdarzenia i Integracje i stwórz nowe powiązanie.
- Wskaż nazwę i typ zdarzenia (akcje użytkowników, połączenia, naruszenia);
- Integracja zewnętrzna – wybierz z listy lub dodaj nowy zewnętrzny zasób;
- Warunki wyzwolenia – ustawiają trigger dla wystąpienia zdarzenia. Lista warunków zależy od typu zdarzenia;
- Parametry akcji – ta linia musi zawierać dane do szczegółowego opisu żądania. Dostępne parametry, które można wykorzystać w żądaniu, są wskazane w dokumentacji;
- Zmienne są wylistowane. Kliknięcie na potrzebną skopiuje ją do wypełnienia parametrów akcji.
Raporty i koszty za zapytania API
Możesz monitorować, jak wykonywane są żądania, korzystając z dziennika wywołań API. Raport jest generowany według daty, użytkowników, czasu wykonania i typu żądania – wybierz API. Gotowy raport zawiera informacje o dacie, godzinie, czasie trwania i nazwie użytkownika, który utworzył żądanie, a także o URL i parametrach żądania. Dostępny jest eksport do formatów HTML, Google Sheets i Microsoft Excel.
W dzienniku zdarzeń znajdziesz informacje o tym, które zdarzenia zostały przetworzone i z jakim wynikiem. Raport zawiera nazwę, typ zdarzenia, integrację, datę utworzenia i przetwarzania, bieżący stan (udany, nieudany lub oczekujący), a także dane używane do tworzenia zdarzeń i integracji przy użyciu API.
Żądania API – funkcja płatna, informacje o kosztach można znaleźć w sekcji Zarządzanie usługami. Możesz wygodnie śledzić swoje codzienne obciążenia w Dzienniku Salda.
Postępując zgodnie z tym przewodnikiem i korzystając z dokumentacji Oki-Toki, możesz skonfigurować przekazywanie danych i żądania API. Integracje i webhooks z Oki-Toki rozwiązują większość praktycznych zadań szybko, skutecznie i bez zbędnego wysiłku. To optymalizuje wiele procesów biznesowych Twojej firmy i pozwala skoncentrować się na głównej rzeczy — jakościowej pracy z klientami.
