API czatu

Za pomocą tego interfejsu API można pobrać listę utworzonych czatów, uzyskać informacje o czatach, oznaczyć je jako "przeczytane" lub "zamknięte".

Można również odbierać wiadomości z czatu lub wysyłać wiadomości.

Przeczytaj.

Umożliwia przeglądanie istniejących czatów.

GET https://api.smartsender.com/v1/chats

Parametry podstawowe:

Tytuł

Opis

Walidacja

Tytuł

Opis

Walidacja

page

Żądana strona

Wartość minimalna 1

limitation

Ilość danych, które mają być wyświetlane na stronie

Wartość minimalna 1, wartość maksymalna 20

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje

{ "cursor": Cursor, "collection": Chats[] }

Opis odpowiedzi:

Tytuł

Opis

Tytuł

Opis

page

Obiekt typu Kursor

limitation

Tablica obiektów typu Czat

 

Wyszukuj według identyfikatora.

Umożliwia pobieranie informacji o określonym czacie.

GET https://api.smartsender.com/v1/chats/{chatId}

Jeśli odpowiedź jest pomyślna, otrzymasz obiekt Chat.

 

Przeczytaj wybraną czat.

Umożliwia odczytanie wszystkich powiadomień na wybranym czacie.

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje

 

Zamknąć wybraną czat.

Umożliwia zamknięcie wybranej rozmowy.

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje

 

Przypisz czat.

Umożliwia przypisanie wybranej rozmowy do konkretnego operatora.

Parametry podstawowe:

Tytuł

Opis

Tytuł

Opis

text

Tekst informacyjny - opis miejsca docelowego

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje

 

Odbieranie wiadomości z wybranego pokoju rozmów.

Umożliwia pobieranie wiadomości z wybranego pokoju rozmów.

Parametry podstawowe:

Tytuł

Opis

Walidacja

Tytuł

Opis

Walidacja

page

Żądana strona

Wartość minimalna 1

limitation

Ilość danych, które mają być wyświetlane na stronie

Wartość minimalna 1, wartość maksymalna 20