ניתן לבצע שליחה של הודעות קוליות לרשימות תפוצה או לרשימה של מספרי טלפון ישירות ממערכות מחשוב שונות, מערכות CRM, אתרים ועוד.
השליחה מתבצעת באמצעות API בפרוטוקול HTTP סטנדרטי המאפשר העברת הפרמטרים בשיטת GET או POST.
הכתובת לפנייה לממשק שליחת הודעות קוליות היא:
https://www.micropay.co.il/extApi/scheduleVms.php
לכתובת הזו יש להוסיף את הפרמטרים המתאימים על מנת לבצע את השליחה
חלק מהפרמטרים הינם חובה, וחלקם רשות
יש לשלוח את כל השמות של הפרמטרים ב- Lower Case
רשימת הפרמטרים הבסיסית לביצוע שליחה
token – טוקן שיצרת במערכת, עם הרשאה לשירותי טלפוניה
ניתן לפתוח ולנהל את הטוקנים על ידי כניסה למערכת, לחיצה על האייקון הירוק למעלה משמאל, ובחירה באפשרות "טוקנים לממשקים"
from – המספר שיופיע כמספר המתקשר
יש לרשום מספר ללא מקף או רווח
ניתן לרשום רק מספרים שהוגדרו לך בחשבון, או את הספרה 0 למספר חסוי
desc – תיאור קצר של נושא השליחה
יש לרשום תיאור קצר שמכיל בין בין 2 ל- 100 תווים
חובה לבצע URL encoding לטקסט של ההודעה
קביעת שיטת השליחה: GET או POST
ניתן לשלוח את הפרמטרים בשיטת GET או POST
ככלל אצבע, בשליחה לעד 10 מספרים ניתן להשתמש בשיטת GET, מעל 10 מספרים יש לבצע את השליחה בשיטת POST
במידה ואתה מבצע את השליחה בשיטת GET יש להוסיף את הפרמטר: get=1
במידה ואתה שולח בשיטת POST יש להוסיף את הפרמטר post=2
שים לב, הגדרת הפרמטר אינה משנה את שיטת השליחה, אלא רק מגדירה למערכת את סוג השליחה שבחרת
אתה צריך לבצע את השליחה בשיטה המתאימה בקוד עצמו
קביעת הנמענים אליהם תבוצע השליחה
על מנת לבצע שליחה לרשימת טלפונים יש להוסיף את הפרמטר list עם רשימת המספרים מופרדים בפסיק, לדוגמא:
list=0501234567,0541234567,0521234567
מומלץ לשלוח את הטלפונים עם ספרות בלבד, וניתן לשלוח אותם בפורמט מקומי או בינלאומי
ניתן לשלוח עד כ- 10,000 מספרים בשליחה בודדת.
על מנת לבצע שליחה לרשימת תפוצה יש להוסיף את הפרמטר pid עם רשימת קודים של רשימות תפוצה מופרדים בפסיק, כפי שהם מוגדרים במערכת, לדוגמא:
pid=12345,23456
קביעת השירות הראשון שיופעל
המערכת מאפשר שלוש אפשרויות לקביעת השירות הראשון שיופעל:
אפשרות 1: בחירת שירות קיים במערכת
sid – שמכיל את קוד השירות שיופעל ברגע המענה לשיחה
ניתן לבחור כל קוד שירות שקיים במערכת תחת שירותים טלפוניים
אפשרות 2: שליחת טקסט שיומר להודעה קולית
tts – טקסט של עד 1000 תווים שהמערכת תמיר להודעה קולית, כברירת מחדל הקול של ההודעה יהיה קול של גבר, על מנת להמיר את ההודעה בקול של אישה יש לשלוח את הפרמטר gender שמופיע בפרמטרים נוספים בהמשך.
getdigits – מגדיר האם ניתן ללחוץ על מקשים במהלך השמעת ההודעה, במידה ואפשרת להקיש על מקשים, ניתן לקבל את הספרות שהוקשו בשירות לאחר מכן, ניתן לשלוח אחד מהערכים הבאים:
all – הלקוח יוכל להקיש על כל מקש בזמן השמעת ההודעה, לחיצה על מקש תפסיק מיידית את ההודעה ותתקדם לשירות הבא או לסיום השיחה
num – הלקוח יוכל להקיש על כל מקש בזמן השמעת ההודעה, ברגע ההקשה המערכת תפסיק את השמעת ההודעה, ותמתין לקבלת ספרות נוספות למשך כחמש שניות בין כל ספרה, או עד הקשת כוכבית או סולמית, לאחר מכן המערכת תתקדם לשירות הבא או לסיום השיחה
0123456789 – ניתן לשלוח רשימת ספרות שהמערכת תאפשר ללקוח להקיש בזמן השמעת ההודעה, לחיצה על ספרות אחרות לא תתקבל, לחיצה על מקש מאושר תפסיק מיידית את ההודעה ותתקדם לשירות הבא או לסיום השיחה, לדוגמא ניתן לשלוח 159, שיאפשר להקיש רק על הספרות 1 או 5 או 9 (לא ניתן לשלוח רק את הספרה 0)
nextsid – מגדיר איזה קוד שירות יופעל לאחר השמעת ההודעה, אם הפרמטר לא נשלח השיחה תסתיים מידית לאחר השמעת ההודעה
השימוש באפשרות זו מחייב פתיחת האפשרות לשימוש בהמרת טקסט לקול בחשבון שלך
אפשרות 3: שליחת קישור לקובץ MP3
fileurl – קישור ישיר לקובץ MP3 שמכיל את ההודעה שתרצו לשלוח, המערכת תפנה לקישור, תמשוך את הקובץ, תמיר אותו לפורמט המתאים ותבצע שליחה
ניתן להוסיף לפרמטר הזה את שני הפרמטרים שמופיעים לעיל: getdigits ,nextsid
דוגמאות שליחה בשיטת GET
להלן דוגמא לשליחה בסיסית של הודעה קולית למספר טלפון
https://www.micropay.co.il/extApi/scheduleVms.php?get=1&token=xxxxx&desc=Test&from=0501234567&list=0500000000&sid=2000
להלן דוגמא לשליחה בסיסית לקוד מאגר 2300
https://www.micropay.co.il/extApi/scheduleVms.php?get=1&token=xxxxx&desc=Test&from=0501234567&pid=2300&sid=2000
התשובה שמתקבלת מהמערכת
המערכת מחזירה תשובה ראשונית מיידית שתאפשר לכם לדעת האם השליחה התקבלה בצורה תקינה ונכנסה לתור במערכת
התשובה מתקבלת כטקסט חוזר פשוט, שמתחיל באחת מהאפשרויות:
ERROR – יוחזר במידה ויש שגיאה באחד הפרמטרים, ולאחריו רווח ותיאור של השגיאה
OK – יוחזר במידה והכל תקין, ולאחריו רווח וקוד הקמפיין שהוקצה לשליחה על ידי המערכת, ניתן לשמור את קוד הקמפיין לצרכי מעקב או מחיקה של שליחה עתידית
פרמטרים לתזמון תאריך ושעה של השליחה
stop – מאפשר להגביל את ביצוע השליחה עד שעה מסויימת
במידה והשליחה מתארכת היא תפסק בכל מקרה בשעה שתגדיר בפרמטר הזה
יש לשלוח 4 ספרות ברצף שמכילים את השעה והדקות: HHMM
ניתן לתזמן את השליחה לתאריך ושעה מסויימים, במידה ושולחים אחד מהפרמטרים חובה לשלוח את כולם:
dh – שעה בפורמט של 24 שעות, כלומר מספר בין 00 ל- 23
di – דקות, מספר בין 00 ל- 59
dy – שנה, בארבע ספרות
dm – חודש בשתי ספרות, מספר בין 01 ל- 12
dd – יום בשתי ספרות, מספר בין 01 ל- 31
ערך ברירת המחדל לתאריך ושעת התזמון הוא תאריך ושעת שליחת הבקשה.
פרמטרים לקביעת נסיונות שליחה חוזרים
ניתן להגדיר למערכת לבצע שליחות חוזרות למספרים שלא ענו על ידי שימוש בפרמטרים הבאים:
retry – קביעת מספר הנסיונות החוזרים
צריך להיות מספר בין 1 ל- 10
retryint – קביעת זמן ההמתנה בין כל נסיון
צריך להיות מספר בדקות בין 1 ל- 30 (זמן ההמתנה מחושב מסיום השליחה לכל סבב עד לתחילת הסבב הבא של השליחה)
הפעלת מנגנון זיהוי תא קולי
באפשרותכך לבחור האם המערכת תנסה לזהות הגעה לתא קולי ואם כן, אז מה לבצע
להפעלת זיהוי תא קולי יש להשתמש בפרמטר: amd עם אחד מהערכים הבאים: 0, 1, 2, 3
להלן הסבר על כל אחד מהערכים:
0 – המערכת לא תנסה לזהות האם השיחה הגיעה לתא קולי
במידה והגדרת נסיונות שליחה חוזרים המערכת תחזור לרק למספרים שלא ענו, מספרים שהגיעו לתא קולי יחשבו כאילו הם ענו
1 – המערכת תנסה לזהות האם השיחה הגיעה לתא קולי, ובמידה והיא תזהה שזה תא קולי היא תמתין עד לסיום הפתיח של התא הקולי ולאחר מכן תמשיך להשמיע את ההודעה שלך כך שהיא תשמר בתא הקולי
באפשרות זו גם שיחות שהגיעו לתא קולי נחשבות תקינות ואם הגדרת נסיונות שליחה חוזרים המערכת לא תנסה לחזור למספרים שהושארה להם הודעה בתא הקולי
2 – המערכת תנסה לזהות האם השיחה הגיעה לתא קולי, ובמידה והיא תזהה שזה תא קולי היא תנתק מיידית את השיחה
באפשרות זו כל שיחה שהגיעה לתא קולי נחשבת ללא מענה ולכן אם הגדרת נסיונות שליחה חוזרים המערכת תנסה לחזור למספרים הללו שוב
שים לב, השיחה תחשב כאילו לא נענתה לצורך ביצוע שיחות חוזרות בלבד, אולם בפועל השיחה כן נענתה ולכן השיחה תחוייב כהודעה רגילה!
3 – המערכת תגדיר שהשיחה הגיעה לתא קולי רק במידה והמשתמש לא הקיש על מקש בשירותים הבאים: תפריט רגיל, תפריט שלוחות, קבלת קוד מספרי
שים לב, על מנת להשתמש באפשרות זו חובה להפעיל אחד מהשירותים לעיל בהודעה הקולית ובהגדרות של השירות שמופעל חובה לבחור "כן" בשדה "שמירה כנתון אחרון", אחרת כל השיחות יוגדרו ללא מענה
באפשרות זו כל מספר שלא הקיש על מקש בזמן השיחה המערכת תתייחס אליו כאילו השיחה לא נענתה ולכן אם ביקשתם לבצע נסיונות שליחה חוזרים המערכת תנסה להתקשר למספרים הללו שוב
לפני השימוש במנגנון זיהוי תא קולי חשוב לדעת:
מנגנון הזיהוי בנוי על שימוש בלוגיקה, והמערכת מחכה למענה מספר שניות ולפי המענה מחליטה האם מדובר בתא קולי או אדם
מכיוון שהמערכת מנסה לחכות למענה, אם הלקוח לא עונה מידית, המערכת תנסה להמתין כשתי שניות לפני ההחלטה, ולכן, אם השליחה מתבצעת למספרים מסויימים באופן קבוע אין להשתמש באפשרויות 1 או 2
עדיין, אפשרי להשתמש באפשרות 3 שבה הזיהוי הוא לפי הקשה ואין בעיה להשתמש בו בכל מצב
פרמטרים נוספים שניתן להגדיר בשליחה
np – מספר טלפון סלולרי לקבלת התראות על תחילת וסיום השליחה, וכן על תקלות
המספר יכיל 10 ספרות, ללא רווח או מקף
ne – כתובת דואל לקבלת התראות על תחילת וסיום השליחה, וכן על תקלות
שים לב, לא ניתן לשלוח את הפרמטר הזה בשליחה של הודעה קולית למספר בודד
lang – קביעת השפה שבה יושמעו הודעות גנריות ומספרים במערכת
ניתן לשלוח אחת מהאפשרויות הבאות:
לעברית – he, לערבית – ar, לרוסית – ru, לאנגלית – en
ברירת המחדל של המערכת היא עברית
gender – קביעת הקול (גבר או אישה) שבו ישמעו הודעות גנריות ומספרים במערכת
ניתן לשלוח אחת מהאפשרויות הבאות:
לגבר – male, לאישה – female
ברירת המחדל של המערכת היא גבר
פרמטרים לשימוש מתקדם
המערכת מאפשרת לשלוח מספר פרמטרים לשימוש לצרכים מתקדמים:
data – מאפשר לשלוח נתון של עד 50 תווים שמוכנס למערכת כנתון אחרון וניתן להשתמש בו כאילו הוא המספר האחרון שהוקש, המספר הזה ימחק ברגע שהמשתמש יקיש על מקשים אחרים (רק במידה וביקשת לשמור כנתון האחרון שהוקש בשירותים כגון: תפריט, קבלת קוד מספרי וכדומה)
דוגמא פופולרית לשימוש בפרמטר data היא שליחת מספר טלפון בפרמטר הזה, והפעלת שירות של "ניתוב שיחה ישיר" עם מספר דינמי, כך שהמערכת תתקשר למספר הראשון שתגדיר בפרמטר list ומיד תתקשר למספר ששלחת בפרמטר data ותחבר בין שניהם, כך ניתן להפעיל שירותים של click to call שבו המשתמש מקיש את מספר הטלפון שלו באתר שלך ואתה מיידית יוצר קשר בין המשתמש לנציג מטעמך
constdata – מאפשר לשלוח נתון של עד 50 תווים שמוכנס למערכת כנתון קבוע שנשמר לכל אורך השיחה
נתון זה גם מועבר כחלק מהנתונים בממשקים שמעבירים מידע לשרת שלך
endsid – מאפשר לכם להגדיר קוד של שירות מסוג "מידע דינמי" שיופעל תמיד בסיום השיחה
שימוש בפרמטר זה יאפשר לך לקבל בכל סיום שיחה עדכון ישירות לעמוד בשרת שלך