Zasób odpowiedzialny za przechowywanie wiadomości czatu z klientami.

Endpointy obsługujące żądanie:

  • https://api.5ways.com
  • https://api.client.5ways.com

Uprawnienia:

  • ekspert - GET|POST
  • specjalista - GET|POST
  • praktykant - GET|POST
  • klient - GET|POST

Pobieranie danych

GET /rest/chat_message

Zwracane dane
{
    "ChatMessage": {
        "id": "2", // identyfiaktor
        "customer_id": "86"
        "external_id": "6565", // id z zewnetrznego systemu
        "user_id" // id użytkownika który utowrzył wiadomość
        "user_client_id": "86", // identyfikator kilienta (z zasobu users). Do tych wiadomości klient ma dostęp.
        "chat_thread_id": "56" // id wątku konwersacji do którego należy wiadomość
        "message": "lorem ipsum" // treść wiadomości
        "is_read": 1 // flaga oznaczjąca odczytanie wiadomości
        "is_reply": 1 // flaga oznaczjąca że wiadomość jest odpowiedzia pracownika
        "type": "text" //typ waidomości
        "created": datatime // data utowrzenia
        "modified": datatime // data modyfikacji
    }
}

Typy odpowiedzi:

  • text - wiadomość tekstowa (domyślnie)
  • file - plik
  • system - informacja systemowa

Tworzenie wiadomości

POST /rest/chat_message

Treść żądania
{
  "ChatMessage": {
      "chat_thread_id": "54545",
      "message": "lorem ipsum"
  }
}
Odpowiedź

Zwraca obiekt z id nowej wiadomości

HTTP/1.1 201 Created
location: https://api.5ways.com/rest/chat_message/{id}
{
    "id": 8989
}