Konwersacje

Struktura konwersacji

Endpoint /v1/api/conversations umożliwia pobranie pełnej listy konwersacji. Konwersacja reprezentuje sesję rozmowy między użytkownikiem a botem.

Endpoint

GET /v1/api/conversations

Struktura odpowiedzi

Każdy obiekt konwersacji w odpowiedzi będzie miał następującą strukturę:

{
   "id": 7202,
   "type": "freeshot",
   "count": 10,
   "sessionid": "tC4lQY781a207d-8ca7-44e5-9939-03d18e9a99a8",
   "firstUserMessage": "Hej",
   "firstBotMessage": "{\"message\":\"Hej! W czym mogę Ci dzisiaj pomóc\"}",
   "createdOn": "2024-06-23T11:34:35.397713Z"
}

Opis pól

• id: Unikalny identyfikator konwersacji
• type: Typ konwersacji (np. "freeshot")
• count: Liczba wiadomości w konwersacji
• sessionid: Unikalny identyfikator sesji
• firstUserMessage: Pierwsza wiadomość od użytkownika
• firstBotMessage: Pierwsza odpowiedź od bota (ciąg JSON)
• createdOn: Znacznik czasu utworzenia konwersacji

Przykładowe zapytania

Oto przykłady, jak wykonać zapytanie do endpointu /v1/api/conversations przy użyciu różnych języków programowania i narzędzi:

curl -X GET "https://botuj.pl/v1/api/conversations" \
     -H "Authorization: Bearer TWOJ_KLUCZ_API"

Pamiętaj, aby zastąpić TWOJ_KLUCZ_API swoim faktycznym kluczem API we wszystkich przykładach.

Paginacja

API obsługuje paginację, aby efektywnie zarządzać dużymi zbiorami danych. Użyj następujących parametrów zapytania:

• page: Numer strony (domyślnie: 1)
• per_page: Liczba elementów na stronę (domyślnie: 20, maks: 100)

Przykład:

GET /v1/api/conversations?page=2&per_page=50

To zapytanie pobierze drugą stronę wyników, z 50 konwersacjami na stronę.

Obsługa błędów

API używa konwencjonalnych kodów odpowiedzi HTTP, aby wskazać sukces lub niepowodzenie zapytań. Kody z zakresu 2xx oznaczają sukces, kody z zakresu 4xx wskazują na błąd wynikający z dostarczonych informacji, a kody z zakresu 5xx wskazują na błąd po stronie naszych serwerów.