API dla deweloperów aplikacji CRM

Endpointy IVRAPI

AKCJE - Funkcjonalności i ich zastosowania.

make_call

Dodaj w aplikacji opcję CALL i nasze IVRAPI zadzwoni do agenta a następnie do klienta.

{
"targetNumber": "string", - numer telefonu klienta
"agentClip": "string", - CLI dla klienta
"agentNumber": "string", - numer telefonu agenta
"direction": "a2c", - kolejność połączenia (agent =>klient)
"externalUserId": "string", - identyfikator agenta
"transferredCallClip": "string", - CLI dla agenta
}

make_announcement

Realizuje powiadomienie bądź predictive call. Zadzwoni do klienta, odtworzy komunikat głosowy i opcjonalnie aktywuje reakcję. Reakcją jest np. połączenie na życzenie do agentów.

{
"name": "string", - nazwa akcji announcement
"promptId": 0, - identyfikator standardowego komunikatu
"promptText": "string", - treść komunikatu w formie tekstowej, który zostanie utworzony za pomocą TTS
"smsFollowUp": "string", - opcjonalne wysłany SMS,
"retries": 0, - ilość prób dodzwonienia się do klienta,
"retriesDelay": 0, - przerwa pomiędzy kolejnymi próbami dodzwonienia się do klienta
"clipForTarget": "string", - CLI dla klienta
"phoneNumbers": [
{
"phoneNumber": "string", - lista numerów do realizacji
"phoneNumber": "string"
}
],
"startTime": "string", - timestamp startu akcji
"activetime": [
{
"dayOfWeek": "string",
"active": true,
"start": "string",
"stop": "string"
}
] - tygodniowy plan realizacji zadania
,
"voice": {
"language": "string", - język przetwarzania TTS
"name": "string", - nazwa lektora TTS
},
"responseId": 0 - identyfikator reakcji - postępowania na życzenie klienta (np. wysłanie SMS, połączenie z agentem
}

transcription

Transkrypcja pliku dźwiękowego (nagrania rozmowy) zawierającego rozmowę.

{
"languageCode": "string", - język pliku dźwiękowego
"label": "string", - nazwa pliku
"file": "string" - plik w postaci base64
}