Wiadomosc

Wiadomości konwersacji

Endpoint /v1/api/conversation-messages/:id umożliwia pobranie wszystkich wiadomości z określonej konwersacji.

Endpoint

GET /v1/api/conversation-messages/:id

Gdzie :id to unikalny identyfikator konwersacji.

Struktura odpowiedzi

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

{
  "id": 10906,
  "message": "Kim jesteś",
  "userId": "781a207d-8ca7-44e5-9939-03d18e9a99a8",
  "isUser": true,
  "type": "freeshot",
  "createdOn": "2024-06-23T11:58:10.169778Z"
}

Opis pól

• id: Unikalny identyfikator wiadomości
• message: Treść wiadomości
• userId: Identyfikator użytkownika, który wysłał wiadomość
• isUser: Flaga wskazująca, czy wiadomość pochodzi od użytkownika (true) czy od bota (false)
• type: Typ wiadomości (np. "freeshot")
• createdOn: Znacznik czasu utworzenia wiadomości

Przykładowe zapytania

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

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

Pamiętaj, aby zastąpić TWOJ_KLUCZ_API swoim faktycznym kluczem API, a 1234 odpowiednim identyfikatorem konwersacji 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/conversation-messages/1234?page=2&per_page=50

To zapytanie pobierze drugą stronę wyników, z 50 wiadomościami na stronę dla konwersacji o ID 1234.

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 (np. nieprawidłowe ID konwersacji), a kody z zakresu 5xx wskazują na błąd po stronie naszych serwerów.