Zasób odpowiedzialny za przechowywanie wątków konwersacji 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_thread

Zwracane dane
{
    "ChatThread": {
        "id": "2", // identyfiaktor powiązania
        "customer_id": "86"
        "external_id": "6565", // id z zewnetrznego systemu
        "user_client_id": "1258", // identyfikator kilienta (z zasobu users)
        "owner_id": "56" // ID użytkownika zajmującego się sprawą (z zasobu users) jest to informacja widoczna dla klienta
        "status": "active|inactive|closed"
        "client_info": "", // dodatkowe informacje o firmie klienta który założył wątek
        "created": datatime // data utowrzenia
        "modified": datatime // data modyfikacji
    }
}

Statusy wątku:

  • active - wątek aktywny. Zawiera wiadomość klienta bez odpowiedzi pracownika.
  • inactive - wątek w którym pracownik odpowiedział na ostatnie pytanie klienta
  • closed - wątek zamknięty przez użytkownika lub automatycznie przez system.

Tworzenie wątku konwersacji

POST /rest/chat_thread

Treść żądania
{
  "ChatThread": {
      "status": "active"
  }
}
Odpowiedź

Zwraca obiekt z id nowego wątku

HTTP/1.1 201 Created
location: https://api.5ways.com/rest/chat_thread/{id}
{
    "id": "15",
    "customer_id": "0",
    "user_client_id": "360",
    "owner_id": "0",
    "status": "active",
    "created": "2020-10-01 22:46:57",
    "modified": "2020-10-01 22:46:57"
}