Endpointy — Rozmowy (Spaces)
| Metoda | Ścieżka | Opis |
|——–|———|——|
| GET | /webchat/spaces.json | Lista rozmów |
| GET | /webchat/spaces/:id.json | Pojedyncza rozmowa |
| POST | /webchat/spaces.json | Utworzenie rozmowy |
| PATCH | /webchat/spaces/:id.json | Aktualizacja rozmowy |
| DELETE | /webchat/spaces/:id.json | Usunięcie rozmowy |
| GET | /webchat/spaces/my_spaces.json | Moje rozmowy |
| POST | /webchat/spaces/:id/close | Zamknięcie rozmowy |
| POST | /webchat/spaces/:id/open | Ponowne otwarcie |
| POST | /webchat/spaces/:id/change_responsible | Zmiana operatora |
| POST | /webchat/spaces/:id/add_client | Powiązanie z klientem CRM |
| POST | /webchat/spaces/:id/remove_client | Usunięcie powiązania |
Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: webchat)
Pola space
| Pole | Typ | Opis |
|——|—–|——|
| name | string | Nazwa rozmowy |
| widget_id | integer | ID widgetu (wymagane) |
| client_id | integer | ID klienta CRM |
| contact_id | integer | ID kontaktu CRM |
| responsible_id | integer | ID operatora |
| closed | boolean | Czy zamknięta |
| email | string | E-mail klienta |
Endpointy — Wiadomości (Messages)
| Metoda | Ścieżka | Opis |
|——–|———|——|
| GET | /webchat/messages.json | Lista wiadomości |
| GET | /webchat/messages/:id.json | Pojedyncza wiadomość |
| POST | /webchat/messages.json | Wysłanie wiadomości |
| PATCH | /webchat/messages/:id.json | Edycja wiadomości |
| DELETE | /webchat/messages/:id.json | Usunięcie wiadomości |
Pola message
| Pole | Typ | Opis |
|——|—–|——|
| message | string | Treść wiadomości (wymagane) |
| space_token | string | Token rozmowy |
| widget_id | integer | ID widgetu |
| name | string | Imię nadawcy (klient) |
| email | string | E-mail nadawcy |
| url | string | URL strony klienta |
| kind | string | Typ wiadomości |
Przykład utworzenia rozmowy
{
"api_token": "TOKEN",
"space": {
"widget_id": 1,
"name": "Jan Kowalski",
"email": "jan@firma.pl",
"message": "Cześć, potrzebuję pomocy"
}
}