Przejdź do treści

Czaty i wiadomości

Metody API służące do pobierania metadanych konwersacji ChatHub, zarządzania statusami i przeglądania historycznych łańcuchów wiadomości.

Adres URL: https://chatapi.smsbat.com


1. Uzyskaj wszystkie czaty

Pobierz listę czatów z dynamicznym filtrowaniem i paginacją.

Prośba - Metoda: GET - URL: /api/chat/chats - Autoryzacja: Token okaziciela (wymagane)

Parametry zapytania

Parametr Wpisz Opis
strona liczba całkowita Numer strony. Domyślnie: 1
na_stronę liczba całkowita Pozycje na stronę. Domyślnie: 20
szukaj ciąg Wyszukiwanie tekstowe (np. imię i nazwisko, telefon)
źródło liczba całkowita Wyliczenie źródła czatu (np. „1” dla Viber Bot, „2” dla Telegramu)
data datagodzina Pobiera czaty pomiędzy dwiema datami (wymaga dwóch identycznych kluczy parametrów w adresie URL). Np.: ?data=2026-01-28&data=2026-01-29
tg_id_użytkownika liczba całkowita Identyfikator użytkownika telegramu
telefon ciąg Numer telefonu
stan liczba całkowita 0 = Nowy, 1 = Otwarty, 2 = Oczekiwanie, 3 = Wstrzymany, 4 = Zamknięty
Identyfikator organizacji liczba całkowita Zawęź według organizacji
Identyfikator operatora liczba całkowita Zawęź według przypisanego operatora

Odpowiedź (200 OK) KOD_BLOKU_0


2. Zmień status czatu

Aktualizuje przypisany stan określonej sesji czatu.

Prośba - Metoda: PUT - URL: /api/chat/status - Autoryzacja: Token okaziciela - Nagłówki: Typ zawartości: aplikacja/json

Ciało: KOD_BLOKU_1

Wartości wyliczenia stanu: - 0: Nowy (nowo wygenerowany) - 1: Otwarty (aktywnie obsługiwany przez operatora) - 2: Oczekiwanie (Oczekiwanie na odpowiedź użytkownika) - 3: OnPause (stan wstrzymania) - 4: Zamknięte (zarchiwizowane)


3. Usuń czat

Trwale usuwa czat za pomocą jego unikalnego identyfikatora.

Prośba - Metoda: USUŃ - URL: /api/chat/chats/{id} - Autoryzacja: Token okaziciela

Odpowiedź (200 OK) Zwraca wartość HTTP „200” w celu potwierdzenia pomyślnego usunięcia. Treść jest zazwyczaj pusta lub ma wyłącznie stan „OK”.


4. Odzyskaj wiadomości czatu

Zrzuca wszystkie wiadomości wysłane i odebrane w przeszłości w ramach określonego czatu.

Prośba - Metoda: GET - URL: /api/chat/chats/{chatId}/messages - Autoryzacja: Token okaziciela

Odpowiedź (200 OK) KOD_BLOKU_2 Autorzy: - 0: Operator - 1: Klient - 2: Bot systemowy - „3”: Konto biznesowe Viber

Typy wiadomości: - 0: Tekst - 1: Zdjęcie - 2: Plik


5. Aktualizuj status wiadomości

Oznacza wiadomość (lub wiele wiadomości) w aktywnym czacie nowymi statusami dostarczenia.

Prośba - Metoda: PUT - URL: /api/chat/messages/status - Autoryzacja: Token okaziciela - Nagłówki: Typ zawartości: aplikacja/json

Ciało: KOD_BLOKU_3 (Status „3” oznacza identyfikatory wysłanych wiadomości jako „Przeczytane”)