.png)
Webhook - Powiadomienie o przychodzących SMS
Webhook IncomingSmsNotification informuje o odebraniu wiadomości SMS w systemie Welyo. Zdarzenie jest generowane w momencie przyjęcia wiadomości SMS skierowanej do kampanii.
W panelu Welyo zdarzenie to odpowiada operacji: Powiadomienie o przychodzących SMS
Webhook może być wykorzystywany m.in. do:
- przekazywania informacji o przychodzących wiadomościach SMS do systemów zewnętrznych,
- automatycznego uruchamiania procesów biznesowych po otrzymaniu wiadomości od klienta,
- synchronizacji komunikacji SMS z systemami CRM lub systemami obsługi klienta.
Struktura zdarzenia
Webhook zawiera podstawowe informacje o zdarzeniu oraz dane dotyczące odebranej wiadomości SMS.
Parametry główne
| Pole | Opis |
|---|---|
| eventName | Nazwa zdarzenia webhooka informująca o odebraniu wiadomości SMS |
| fccInstance | Identyfikator instancji systemu(nazwa środowiska) |
| customerId | Identyfikator klienta w systemie Welyo |
| version | Wersja struktury webhooka |
| createdAt | Data i czas wygenerowania zdarzenia |
| data | Obiekt zawierający szczegółowe dane dotyczące zdarzenia |
Struktura pola data dla zdarzenia IncomingSmsNotification
| Pole | Opis |
|---|---|
| campaignId | Identyfikator kampanii, do której skierowano wiadomość |
| recordId | Identyfikator rekordu powiązanego z wiadomością |
| callId | Identyfikator połączenia SMS |
| replyTo | Identyfikator wiadomości, na którą odpowiada SMS; pole jest pomijane, jeśli wiadomość nie jest odpowiedzią |
| srcNumber | Numer nadawcy wiadomości |
| dstNumber | Numer odbiorcy wiadomości |
| message | Treść wiadomości SMS |
| queue | Nazwa kolejki, do której została skierowana wiadomość |
Przykładowy webhook
{
"eventName": "IncomingSmsNotification",
"fccInstance": "vcc1a",
"customerId": 12345,
"version": 2,
"createdAt": "2020-06-09T09:26:15+02:00",
"data": {
"campaignId": 321,
"recordId": 2,
"callId": 8719684,
"replyTo": null,
"srcNumber": "222289289",
"dstNumber": "222289289",
"message": "Test 123",
"queue": null
}
}