18 במאי 2022, 17:44

שליחת קמפיין הודעת TTS

הפקודה היא - SendTTS

הפרמטרים הנדרשים

פרמטר תיאור סוג
token טוקן string
callerId זיהוי שולח, בחירת מחדל זיהוי המערכת הראשי. ניתן לכתוב מספר מאושר במערכת או מספר משני. string
ttsMessage תוכן הטקסט string
callbackUrl קישור לקבלת hooks בזמן אמת על סטטוס הקמפיין (הסבר למטה) string
repeatFile כמה פעמים לחזור על ההשמעה. בחירת מחדל 2 פעמים. int
ttsRate מהירות השמעה כאשר 10 זה הכי מהיר ו 10- זה הכי לאט (בחירת מחדל רגיל) int
ttsVoice הקול של ההשמעה (מידע על הקולות כאן) string
SendMail האם לקבל דוח קמפיין 0/1
phones נמענים בהפרדה של : בין כל מספר, או tpl:X על מנת לשלוח לרשימת תפוצה במערכת שבמקום הX יש לכתוב את מזהה הקמפיין. ניתן גם לקחת את המספרים מרשימת צינתוקים חינמית (בעלות יחידות מלאה!) על ידי ציון tzl:XX ובמקום XX את שם הרשימה. string

החיוב על שליחת שיחה TTS הוא יחידה לדקה ראשונה ואחריה חיוב יחסי של יחידה לדקה.

מענה בעת הצלחה:

מאפיין סוג הסבר דוגמא
responseStatus string סטטוס הפעולה OK
CampaignId string מזהה קמפיין
OKCalls int ספירת שיחות מוצלחות
ErrorCalls object שיחות שגויות וסיבה
billing float עלות
units string יחידות בלקוח

במקרה של שגיאה השגיאה תפורט.


הסבר ודוגמא בנוגע לקבלת hooks בזמן אמת על סטטוס הקמפיין:

באם מציינים פרמטר callbackUrl המערכת תשלח בזמן אמת בעת פעילות הקמפיין לשרת שלכם את סטטוס השיחות.
הדבר אפשרי בעת הפעלה לרשימה של עד 500 מספרים לע״ע.

הפניות יגיעו לכתובת שלכם בPOST באופן הבא:


בעת שיחה שנענתה:

{
  "CampaignId": "YA-3-xxxxx-Yemot-1672066954231731",
  "Number": "077xxxxx",
  "Status": "UP",
  "Time": 1672066959116
}

בעת שיחה שנכשלה:

{
  "CampaignId": "YA-3-xxxxx-Yemot-1672066954231731",
  "Number": "077xxxxx",
  "Status": "FAILD",
  "Time": 1672066959865,
  "FailReason": "5"
}

בעת שיחה שהסתיימה:

{
  "CampaignId": "YA-3-xxxxx-Yemot-1672067627514828",
  "Number": "077xxxxx",
  "Status": "DOWN",
  "Time": 1672067636731,
  "CallTimeMS": 4969,
  "BridgeCallStart": null,
  "BridgeCallStop": null
}

בעת סיום הקמפיין:

{
  "CampaignId": "YA-3-xxxxx-Yemot-1672068098471003",
  "Number": null,
  "Status": "END",
  "Time": 1672068114027,
  "moreData": {
    "CampaignBilling": 3,
    "notEnteris": 0,
    "enteris": 3,
    "done": 2,
    "fail": 1,
    "createTS": "2022-12-26 17:21:38",
    "runTS": "2022-12-26 17:21:38",
    "endTS": "2022-12-26 17:21:53"
  }
}