מודול API - תקשור עם מחשבים וממשקי נתונים חיצוניים - שרשור ישן

eliyahu

ב"ה

שימו לב! זהו שרשור ישן. השרשור החדש והמעודכן נמצא כאן.

מודול API - תקשור עם מחשבים וממשקי נתונים חיצוניים

מודול זה יתכן ויעלה בעתיד סכום עבור כל פרויקט שישתמשו בו
עם זאת כרגע המודול חינמי עד להודעה אחרת בפורום

type=api
api_link=https://www.abc.co.il/API.aspx

הגדירו את כתובת הלינק של השרת שלכם
ערך זה הינו חובה
אחרת המערכת תודיע
M1609 לא מוגדר לינק
ותחזור שלב אחורה

שיטת שליחה
ברירת מחדל המערכת שולחת את הפרטים בצורת HTTP GET
אם רוצים ניתן להגדיר לשלוח את הפרטים בצורת HTTP POST

api_url_post=yes

תיקיה שממנה יושמעו הקבצים
ברירת מחדל התיקיה שממנה יושמעו כל הקבצים, קבצי wav או קבצי tts, הינם מתוך התיקיה הנוכחית
ניתן להגדיר הפעלת קבצים מתוך תיקיה אחרת במערכת שלכם

api_dir=/5/6

בדוגמה הקבצים שיופעלו הם מתוך תיקיה /5/6
הערה חשובה: שימו לב שכתובת תיקיה חייבת להתחיל בסלש "/" ולהסתיים ללא סלש.

ערכים הנשלחים בברירת מחדל
כברירת מחדל המערכת מצרפת את הערכים הבאים:

ApiCallId=מזהה יחודי לאורך השיחה
ApiPhone=מספר הטלפון של הלקוח
ApiDID= מספר טלפון הראשי של המערכת שלכם
ApiRealDID=המספר אליו חייג הלקוח, במידה ויש כמה מספרים משויכים למערכת שלכם, והלקוח צלצל למספר משנה, הערך הזה יהיה שונה מהערך הקודם
ApiExtension=מספר השלוחה
ApiEnterID=סוג ומספר זיהוי אישי. אם התחבר באחד מהצורות של כניסה עם זיהוי אישי (אם לא נכנס הערך בכלל לא יצורף).התחברות עם ערכים enter_id=yes וכו'
ApiEnterIDName= שם משוייך לזיהוי האישי. כפי שמוסבר בערך של login_add_val_name=yes (אם אין שם הערך בכלל לא יצורף)
ApiTime= זמן בשניות מ1970, Epoch, i.e., since 1970-01-01 00:00:00 UTC.

אם רוצים לבטל את הערכים הנ"ל או את חלקם ניתן להגדיר

api_call_id_send=no
api_phone_send=no
api_did_send=no
api_extension_send=no
api_enter_id_send=no
api_enter_id_name_send=no
api_time_send=no

שליחה בניתוק שיחה
לאחר שהלקוח ניתק את השיחה (מכל שלוחה שהיא במערכת) המערכת תשלח לכם את כל הערכים שנאספו עד עכשיו בשלוחה בתוספת שלוחת הניתוק ApiHangupExtension=שלוחה וכן hangup=yes בשביל שתוכלו בשרת שלכם לדעת שהלקוח ניתק ואלו הנתונים עד עכשיו.

ניתן להגדיר שבניתוק ישלח ללינק אחר (ברירת מחדל שולח ל api_link) הגדרת כתובת מיוחדת לניתוק:

api_hangup_link=https://www.abc.co.il/API_hangup.aspx

כדי לבטל את השליחה בניתוק שיחה יש להגדיר

api_hangup_send=no

הוספת ערכים קבועים
ניתן להוסיף גם ערכים קבועים משלכם
שימו לב! לא ניתן להוסיף ערכים קבועים באותם שמות של הערכים הנשלחים כבחירת מחדל

api_add_0=Mosad=1111
api_add_1=ClientName=mml
api_add_2=Adresse=jj
api_add_3=xxx=yyy

וכן הלאה

ניתן להחליף בשליחת ערכים כל רווח ב"+" - יש שרתים שרווח עושה בעיות.
יש להגדיר:

api_add_replace_space=yes

חייב לשמור על רצף סידורי החל מהסיפרה 0 - כמה ערכים שאתם צריכים להוסיף
בדוגמא הנ"ל מה שיצטרף למחרוזת יהיה

Mosad=1111&ClientName=mml&Adresse=jj&xxx=yyy

חדש!
בכל ערך שמוסיפים, אם הערך הוא "YM_Phone" זה יוסיף את הטלפון,
למשל:

api_add_X=TEST=YM_Phone

ישלח:

http://XXX/?TEST=07731377770

קבלת נתונים מהלקוחות
המערכת תחפש בהתחלה את קובץ 000 בתוך התיקיה ולאחר מכן את קובץ 001 ואח"כ 002 לפי הרצף
בפורמט wav של הקלטה שלכם
או פורמט tts עם המלל והמערכת תפעיל על מנוע הדיבור

ההגדרות הקבועות לקבצי tts
ברירת מחדל המערכת משמיע בקול "גלעד"
למערכות של נשים וכד' ניתן לשנות לקול של אשה "סיוון" או "סיוון 3"

tts_voice=Gilad
tts_voice=Sivan
tts_voice=Sivan3

אם רוצים לשנות מהירות
ברירת מחדל היא 0
ניתן להגדיר

tts_rate=10

המהירות הגבוהה ביותר

tts_rate=-10

המהירות הנמוכה ביותר

ניתן לבחור כל מספר מעשר ועד מינוס עשר

במקביל תהיה חייבים לשים בקובץ הגדרות של השלוחה את ההגדרות של הקבלת נתונים

דוגמא

api_000=ID,yes,8,4,7,Number,yes,no,*/,
api_001=ZIP,yes,8,4,7,Number,yes,yes,*/
api_002=AAA,yes,1,1,7,Number,yes,yes,*/,*#123456
api_003=BBB,yes,2,2,7,Number,yes,yes,*/,11.12.13.14,3,Ok,VarNoDigits
api_004=CCC,yes,voice
api_005=DDD,yes,voice,en-US,no
api_006=EEE,yes,voice,en-US,,30
api_007=ZAW,yes,record,/1/2,file_name,no,yes,yes
api_008=FFF,,voice,,,,record,6,9

הסבר לערכים

הערך הראשון
השם שיצורף למחרוזת עם התוצאה שהלקוח הקיש
בדוגמא
הערך לשמירה של הקובץ הראשון קובץ 000 הוא ID
והערך לשמירה בקובץ השני קובץ 001 הוא ZIP

הערך השני
במידה וכבר קיבלת את הערך שמופיע בערך הראשון לדוגמא הלקוח כבר הקיש את התעודת זהות שלו בשיחה הנוכחית בשלב קודם, האם להשתמש במה שקיים במערכת או לא להשתמש ולקבל מחדש.
ברירת מחדל המערכת תקבל מחדש, במידה ומוגדר yes המערכת תשתמש במה שהלקוח הקיש מקודם ותצרף אותו לסטרינג של השליחה

ערכים להקלטה record:

הערך השלישי
בדוגמא של 007 מופיע record
בשביל לקבל הקלטה מהלקוח שתשמר במערכת במיקום שתבחרו יש להגדיר בערך השלישי record
הודעת מערכת קשורות להקלטה:
M3345 לשמיעת ההודעה הקישו אחת לאישור הקישו שתיים או סולמית להקלטה מחדש הקישו שלוש להמשך הקלטה הקישו ארבע
כל ההקלטות נשמרות גם תחת תיקיית ApiRecord שבסל המחזור

ערך רביעי
תיקיה להעברה - record_folder_move
ברירת מחדל התיקיה המוגדרת בapi_dir (ברירת מחדל של ערך זה הוא התיקיה הנוכחית)

באם רוצים לשנות פשוט להגדיר את הערך הרביעי
בהגדרה
חובה לשים / בהתחלה,
אסור לשים / בסוף

ערך חמישי - הקלטה record
שם הקובץ להקלטה - record_file_name
ברירת מחדל ישמר בשם הגבוה לפי הסדר הנמצא בשלוחה
ניתן להגדיר את שם הקובץ שעל שמו ישמר,
באם יש כבר קובץ כזה הוא יעבור לשינוי שם באותו מיקום - כלומר יתווסף לו תאריך ושעה של השיחה ששינתה אותו
באם רוצים שההקלטה תמשיך על אותו קובץ כלומר שבמקום להחליף הוא יוסיך יש לעדיין בהגדרות של הערך השמיני

באם רוצים שלא ישמיע "ביפ" לפני תחילת ההקלטה יש להגדיר:

api_record_beep=no

ערך שישי
ברירת מחדל שבסיום ההקלטה מקישים # ושומעים תפריט עם אפשרויות: 1- לשמיעה, 2- לאישור, 3- להקלטה מחדש, 4- להמשך הקלטה.
באם מגדירים:

record_ok=no

אז לא יושמע תפריט לאחר ההקלטה, אלא בלחיצה על # ההקלטה תאושר מיידית

ערך שביעי
האם לשמור שיחה שהתנתקה כאלו אושרה - record_hangup
ברירת מחדל לא
באם רוצים לשנות יש להגדיר

record_hangup=yes

ערך שמיני
האם להוסיף את ההקלטה או למחוק אותה - record_attach
במידה והגדרתם בערך החמישי שם קובץ להקלטה בערך השמיני תוכלו להגדיר yes בשביל שיוסיף במקום למחוק
במקרה כזה , מיד לאחר ההקלטה יחזור כאלו הלקוח שמע ואישר.

ערך תשיעי
כמה מינימום אורך ההקלטה, אם ריק כל אורך תקין
הקלטות קשורות:
M1305 ההודעה קצרה מידי

ערך עשירי
כמה מקסימום אורך ההקלטה, אם ריק יקליט עד ליציאה על ידי המשתמש

ערכים לקבלת נתונים בהקשות:

הערך השלישי
בערך השלישי ניתן להגדיר כמה ספרות לקבל מהמשתמש בהקשות, או קבלת הטקסט מ"זיהוי הדיבור" של המאזין, או הגדרה של הקלטה ושמירה במערכת.

כמה ספרות לקבל מהמשתמש
בדוגמאות 000 וכן 001 מופיע 8
הסבר הערך: מקסימום כמות ספרות לקבל מהלקוח ברירת מחדל ללא הגבלה כלומר כל כמות ספרות עד שהלקוח מקיש סולמית, או עד שנגמר הזמן לסיום הקשה (ראה ערך חמישי) ניתן להגביל את הכמות המקסימלית של הספרות, למשל אם אתם מקבלים תעודת זהות אז תגבילו ל9 ספרות , בדוגמא הגבלנו ל 8 ספרות

הערך הרביעי
בערך הרביעי - הערך מתיחס בהתאם להגדרות הקודמות,
במידה ומדובר על הכנסות ספרות על ידי המשתמש כמו בדוגמא 000 מופיע 4
אז המשמעות של הערך הרביעי היא כמות ספרות מינימלית, ברירת מחדל לפחות ספרה אחת, ניתן להגביל שהלקוח יהיה חייב להקיש מינימום ספרות, למשל בתעודת זהות ההגבלה היא בדרך כלל מינימום 8 ספרות

הערך החמישי
בדוגמא מופיע 7
כמות שניות לסיום המתנה במידה והלקוח לא הגיע למקסימום ספרות שיכול להקיש, בשביל שהמערכת תתקדם לבדוק מה הקיש
ברירת מחדל זה 7 שניות

הערך השישי
באיזה צורה להשמיע ללקוח את מה שהקיש
האפשרויות הם
Number,Digits,File,Alpha,Price,TTS,Time,Date,HebrewDate,TeudatZehut,HebrewKeyboard,EnglishKeyboard,EmailKeyboard,DigitsKeyboard,No

Number- השמעת ההקשה בצורת מספר כלומר במידה והלקוח הקיש 100 המערכת תאמר "מאה"
Digits - השמעת ההקשה בצורת ספרות כלומר במידה והלקוח הקיש 100 המערכת תאמר "אחת אפס אפס"
File - ניתן לפתוח תחת התיקיה הנוכחית תיקיה בשם File ולהכניס לתוכה קבצים של wav כשם ההקשה - למשל אם הלקוח הקיש 100 אז המערכת תפעיל את קובץ 100.wav
במידה ולא קיים קובץ כזה המערכת המערכת תשמיע את ההקשה בצורת ספרות
Alpha- בצורת אותיות, במקרה של הקשה טלפונית של ספרות זה ישמע כמו הקשת ספרות, במידה ויש אותיות כמו abc אז ישמעו את האותיות אחת אחרי השניה
Price ישמיע את הנתון בצורת מחיר
TTS - מאפשר להשמיע מלל מתוך קובץ, יש ליצור בשלוחה קובץ ini (בקידוד utf-8) ששמו יהיה כשם השאלה, לדוגמא בשאלה 050 יש ליצור קובץ

050-SayTTS.ini

Time ניתן להגדיר השמעה בצורה שעה (Time) כלומר 2359 המערכת תשמיע "עשרים ושלוש חמישים ותשע" (יש צורך להגדיר מינימום ומקסימום 4 ספרות)

Date ניתן להגדיר את ההשמעה בצורה תאריך (Date) כלומר 10122019 המערכת תשמיע "עשר דצמבר אלפיים ותשע עשרה" (יש צורך להגדיר מינימום ומקסימום 8 ספרות)

HebrewDate ניתן להגדיר את ההשמעה בצורה תאריך (HebrewDate) כלומר 23125779 המערכת תשמיע "כ"ט אלול תשע"ט" (יש צורך להגדיר מינימום ומקסימום 8 ספרות)

TeudatZehut ניתן להגדיר להשמיע את הנתונים בצורת תעודת זהות (TeudatZehut) כלומר המערכת תתן להכניס רק ת.ז. ישראלי תקין המערכת תשמיע את ההקשה בצורת ספרות (יש צורך להגדיר מינימום 8 ספרות ומקסימום 9 ספרות)

Phone ניתן להגדיר שניתן יהיה להקיש מספר טלפון תקין בלבד (מספר ישראלי) יש להגדיר מינימום 9 ספרות ומקסימום 10 ספרות

No - לא להשמיע את מה שהלקוח הקיש אלא ישר ימשיך כאלו הלקוח שמע ואישר.

ניתן להגדיר HebrewKeyboard המערכת תעביר את המשתמש להקלדה במקלדת עברית בדומה להקשת SMS ובסיום ההקלדה תשמיע את מה שהוקלד במילים או באותיות. הלקוח יכול להחליף ולשלב גם שפות נוספות. למידע אודות אפשרויות ההקשה במקלדת לחץ כאן. לביטול אפשרות הלקוח להחלפת שפות נוספות עיינו בערך הארבע עשרה להגדרת InsertLettersTypeChangeNo

ניתן להגדיר EnglishKeyboard המערכת תעביר את המשתמש להקלדה במקלדת אנגלית בדומה להקשת SMS ובסיום ההקלדה תשמיע את מה שהוקלד במילים או באותיות. הלקוח יכול להחליף ולשלב גם שפות נוספות. למידע אודות אפשרויות ההקשה במקלדת לחץ כאן. . לביטול אפשרות הלקוח להחלפת שפות נוספות עיינו בערך הארבע עשרה להגדרת InsertLettersTypeChangeNo

ניתן להגדיר EmailKeyboard המערכת תעביר את המשתמש להקלדה במקלדת אנגלית בדומה להקשת SMS מותאמת למייל (ללא סימן שאלה וסימן קריאה, וכן בהקשת שטרודל עזרה בהשלמת הספק) . הלקוח יכול להחליף ולשלב גם שפות נוספות. למידע אודות אפשרויות ההקשה במקלדת לחץ כאן. לביטול אפשרות הלקוח להחלפת שפות נוספות עיינו בערך הארבע עשרה להגדרת InsertLettersTypeChangeNo

ניתן להגדיר DigitsKeyboard המערכת תעביר את המשתמש להקלדה במקלדת ספרות כאשר המערכת תשמיע כל הקשה בצורה מיידית בהתאם למקשים שהוקשו. הלקוח יכול להחליף ולשלב גם שפות נוספות.למידע אודות אפשרויות ההקשה במקלדת לחץ כאן. הערה חשובה במצב זה אין הגבלה של מינימום או מקסימום, והערכים של ההגבלה לא פעילים, מעלת מקלדת ספרות זה השמעת כל ספרה מיידית ללקוח. לביטול אפשרות הלקוח להחלפת שפות נוספות עיינו בערך הארב עשרה להגדרת InsertLettersTypeChangeNo

להקלטות קשורות למקלדת בעברית, אנגלית, מייל או ספרות לחץ כאן.

ניתן להגדיר שלפני שישמיע את ההקשה של הלקוח בכל צורה מהצורות לעיל שישמיע קובץ
למשל אם ביקש תעודת זהות אז ניתן להכניס קובץ בשם של הקובץ הראשי להשמעה עם תוספת
לדוגמא לקובץ 000
ניתן להוסיף קובץ

000-AskBeforeOk.wav

ולהקליט שם "תעודת הזהות שהקשתם היא"
ואז המערכת תמשיך להשמעת ההקשה בהתאם לבחירתכם

הערך השביעי
;האם לחסום את מקש הכוכבית - לדוגמא במקרה שצריך להקיש כמות ספרים אז אין צורך במקש הכוכבית וניתן לחסום
ברירת מחדל ניתן להקיש כוכבית, באם רוצים שבהקשה זו לא יוכלו להקיש כוכבית יש להגדיר yes

הערך השמיני
האם הכמות של ההקשה יכולה להיות אפס
ברירת מחדל כמות יכולה להיות אפס אולם באם רוצים לחסום לדוגמא בכמות שקלים לתרומה שלא ניתן לתרום אפס אז ניתן לסמן yes בשביל לחסום את מקש אפס

הערך התשיעי
החלפת מקש בכל סימן אחר
לדוגמא במידה ואתם רוצים שישלח כתובת ספריה
כאשר המפריד בין התיקיות זה \
בטלפון לא ניתן להקיש סלש
אבל ניתן לבקש מהלקוח להקיש כוכבית בין ספריה לספריה
ולסמן להחליף את הסולמית בסלש

ערך זה יכול להכיל 2 סימנים
הסימן הראשון את איזה ערך להחליף
הסימן השני זה מה לשים במקום מה שהוחלף

בדוגמא מופיע
*/
כלומר להקיש מקש כוכבית בסלש

הערך העשירי
בדוגמאות בקבצים 000,001 הערכים ריקים
בקובץ 002 מופיע בדוגמא *#123456
ובקובץ 003 מופיע 11.12.13.14

בערך העשירי אנחנו קובעים איזה ספרות הלקוח יוכל להקיש
באם הלקוח יקיש משהו שלא כתבנו אז המערכת תודיע
M1224 בחירה לא חוקית
ברירת מחדל הלקוח יוכל להקיש את כל הספרות
באם הערך ריק - אז יוכל להקיש הכל

אם מדובר על הקשה של מינימום ומקסימום ספרה אחת (ערכים שלוש וארבע)
שימו לב שבדוגמא של קובץ 002 שמנו מינימום ומקסימום ספרה אחת
אז ניתן לרשום את כל הספרות המורשות ברצף, בדוגמא מופיע שניתן להקיש *#123456 כלומר את כל הספרות למעט 789 שאם יקיש אותם אז המערכת תודיע שהבחירה לא חוקית

אם מדובר על הקשה שמעל ספרה אחת, ואני רוצה להגביל את הלקוח אז ניתן להפריד בין הערכים המותרים עם נקודה.
שימו לב שבדוגמא של קובץ 003 המינימום והמקסימום הם 2 ספרות,
ואני רוצה שהלקוח יוכל לבחור רק 11 או 12 או 13 או 14, וכל דבר אחר יגיד לו בחירה לא חוקית אז אני כותב 11.12.13.14

הערך האחד עשרה
Attempts - במידה והלקוח עדיין לא הקיש כלום, כמות הפעמים לחזרה על התפריט לפני שמודיע "לא הוקשה בחירה" או שמתקדם עם ערך שהלקוח לא הקיש כלום, ברירת מחדל - ריק.
בדוגמא בקובץ 003 מופיע לחזור 3 פעמים

הערך השתים עשרה
ReadNone=Ok האם בפקודת הread במידה והערך הוא ריק והלקוח לא הקיש כלום, האם זה בסדר, ולהתקדם ולשדר למערכת שלכם שהלקוח לא לחץ כלום, ברירת מחדל זה לא, כלומר במידה ולקוח הקיש סולמית, או חיכה ולא לחץ כלום המערכת תודיע "לא הוקשה בחירה" ותחזור שוב על התפריט, במידה ויש לכם הודעה מסוג "אם אין ברצונכם להזמין ממוצר זה הקישו סולמית או המתינו" אז הערך הזה מיועד בשבילכם, הכניסו בערך זה Ok , והמערכת תתקדם הלאה, שימו לב במצב כזה שהלקוח אכן לא הקיש כלום, המערכת ישר מתקדמת ולא משמיע ללקוח את מה שלחץ (או לא לחץ..) וגם לא מבקשת אישור, אלא ישר מתקדמת לשלוח לכם API עם הערך.

הערך השלוש עשרה
במידה ובערך שתים עשרה הגדרתם Ok , ברירת מחדל תקבלו בAPI שלכם שמקשי הלקוח היה None
במידה וברצונכם לשנות לערך אחר שישודר אליכם בתור בחירת הלקוח הכניסו אותו בערך זה
בדוגמא של קובץ 003 הערך שישודר במקום None יהיה ערך VarNoDigits

הערך הארבע עשרה
במידה והגדרתם בערך השישי מצב מקלדת עברית / אנגלית / מקלדת מייל /מקלדת ספרות
ברירת מחדל הלקוח יכול להכנס בתפריט סיום או ביטול (במקש כוכבית) לשינוי לכל אחד ממצבי ההקלדה, אם ברצונכם שהלקוח לא יוכל לשנות את השפה שהגדרתם שאתה הלקוח יתחיל
ניתן להגדיר בערך הארבע עשרה InsertLettersChangeLanguageNo
במקרה כזה במידה והלקוח מנסה לשנות שפה ישמיע הודעה:
M4186 שינוי שפת הקלדה חסום בכתיבה זו.

הקצאת מקש לשמיעת קובץ
ניתן להגדיר שבהקשה על מקש מסוים יעבור לשמיעת קובץ מתוך השלוחה ובסיום ישמיע שוב את השאלה

api_002_key_2_say=100

בדוגמה, במידה ובשאלה 002 הקיש 2 יועבר לשמיעת קובץ 100.wav שבשלוחה.
חשוב! הקובץ חייב להיות בפורמט wav (ולא tts) ובנוסף בעת שמיעת הקובץ לא ניתן להקיש על אף מקש

**הקלטות הקשורות **
M1001 המקש שֶהוֹקַש שגוי
M1002 לא הוקשה בחירה
M1034 לאישור הקישו 1, להקשה מחודשת 2.
M1035 לא הקּשתּם את מינימום הספרות הנדרשות
M1368 לא ניתן להקיש מקש כוכבית
M1625 הכמות לא יכולה להיות אפס

ערכים לvoice:

הערך השלישי
קבלת הטקסט מזיהוי הדיבור של המשתמש שימו לב, אופציה זו מחייבת יחידות על כל זיהוי דיבור שנערך. למחירון
בדוגמא של 004 מופיע voice
הסבר הערך: המשתמש יתבקש להקליט, המערכת תזהה את הדיבור (ברירת מחדל בעברית, לשפות אחרות הסתכלו בערך החמישי) ותמיר אותו לטקסט, הקטסט יצורף לסטרינג שנשלח אליכם. לאחר שהמערכת מפענחת את הטקסט שהוקרא על ידי המאזין המערכת מקריאה לו את הטקסט שזוהה לצורך "שיקוף" ווידוא שאכן זוהה הטקסט אליו התכוון המאזין.
ניתן "לעזור" למערכת לנסות להבין את אמירות הלקוח
צרו קובץ כמו שם ההודעה להשמעה (הקובץ להשמעה הוא בפורמט wav או tts) קובץ העזרה צריך להיות בסיומת ini כאשר בין כל ערך עזרה צריך להיות בשורה חדשה
לתשומת ליבכם: לפני השליחה הקבצים של המערכת הם 000.wav או 000.tts ואח"כ 001.wav או 001.tts וכו' ולכן הקבצים הנלווים לעזרה גם יהיו בשמות 000.ini ואח"כ 001.ini

לאחר השליחה במידה ועניתם read אז הקובץ שהמערכת מחפש זה כשם הערך כלומר אם עניתם שישמור את התשובה של הלקוח בערך בשם AAA אז הקובץ לעזרה באותה השלוחה צריך להיות בשם AAA.ini

מה לעשות לאחר המרת הדיבור:
אם מעונינים שלא יושמע ללקוח את ההקראה של הטקסט שהתקבל לצורך שיקוף יש להגדיר

api_say_tts=no

ברירת מחדל לאחר ההשמעה (שיקוף ההקלטה בהקלטה מהטקסט) מיד עובר לשלב הבא,
אם רוצים שיבקש אישור, או אפשרות להקליט מחדש ניתן להגדיר

api_voice_ask_ok=yes

אם רוצים שהקובץ של ההקלטה ישאר אצלכם במערכת יש להגדיר

api_save_file=yes

הקובץ נשמר זמנית בסך המחזור בתוך תיקיה ApiVoice

ערכים נוספים
tts_voice,tts_rate,lang
קיימים כמו בכל מנועי הדיבור

הקלטות קשורות:
M1611 דיבור לא ברור. אנא אמרו שוב
M1613 לא זוהה דיבור
M1353 לאישור הקישו 1 להקלטה מחודשת 2

במידה ויש טקסט שהתקבל בעברית, ולצורך שליחה רציפה של המילים כחלק משורת הכתובת
אנו ממירים את הטקסט ל URIENCODE, בדרך כלל המערכות web שלכם כבר ימירו את זה אוטומטית לעברית תקנית

הערך הרביעי
המידה ובערך השלישי הגדרתם voice כמו בדוגמאות 004 ו 005 אז ניתן לשנות את השפה שבה המנוע דיבור יחזיר את הנתונים
ברירת מחדל במידה וערך זה ריק, אז המנוע ינסה להחזיר תוצאות בעברית.
ניתן להגדיר שפות נוספות
לדוגמא אנגלית en-US, לרשימה המלאה של השפות האפשריות לחצו כאן (בבניה), בנתיים פנו לשרות לקוחות יש יותר מ100 שפות נתמכות.

שימו לב שהמערכת ממירה את השפה ברירת מחדל בעברית, באם מוגדר במערכת או בשלוחה ערך lang, המערכת מתחשבת בו, ובאם הגדרתם בערך הרביעי את השפה, זה יגבור מעל כולם.

הערך החמישי - voice
במידה והגדרתם בערך השלישי voice אז הערך החמישי הוא האם לחסום הקשות במהלך דיבור, ברירת מחדל ניתן גם להקיש ספרות והמערכת תשלח לכם את ההקשות הכותרת Digits לדוגמא הלקוח הקיש 1234 אז תקבלו לAPI בחזרה Digits-1234
בשביל לחסום את ההקשות - ובמידה והלקוח הקיש יודיע שלא זוהה דיבור וינסה שוב להקליט ולזהות דיבור הכניסו בערך החמישי no - כמו בדוגמא 005

הערך השישי - voice
במידה והגדרתם בערך השלישי voice אז הערך השישי הוא הכמות הקמסימלית של הספרות שהלקוח יכול להקיש, ברירת מחדל 0 כלומר ללא הגבלה, ניתן לראות בדוגמא 006 הגבלה ל 30 ספרות.

הערך השביעי - voice
במידה והגדרתם בערך השלישי voice, כברירת מחדל המערכת מפעילה מנוע תפריט שמזהה הקשה או דיבור של המאזין. במידה והמאזין הקיש המערכת מתייחסת לזה כהקשה, במידה והמאזין דיבר המערכת מתייחס לזה כדיבור ומתמללת את זה.
החיסרון במנוע הזה, שהדיבור מוגבל לזמן קצר.
כדי להשתמש במנוע זיהוי דיבור של הקלטות בלבד יש להגדיר בערך הזה record (כמו בדומה למעלה בקובץ 008).

הערך השמיני - voice
במידה והגדרתם בערך השביעי שהמערכת תפעיל את מנוע זיהוי דיבור של הקלטות, תוכלו להגדיר כאן זמן מקסימלי של שקט לסיום ההקלטה. (בדוגמה בקובץ 008 מוגדר 6 שניות)

הערך התשיעי - voice
במידה והגדרתם בערך השביעי שהמערכת תפעיל את מנוע זיהוי דיבור של הקלטות, תוכלו להגדיר כאן את הזמן המקסימלי להקלטה (בדוגמה בקובץ 008 מוגדר מקסימום 9 שניות)

בסטרינג שישלח יצורף שם הערך והתוצאה

למשל בדוגמאות הנ"ל
אם בקובץ 000 הלקוח הקיש 123456789
ובקובץ 001 הקיש 555555
אז בסטרינג ישלח

ID=123456789&ZIP=555555

דוגמא לסטרינג שישלח לפי הדוגמאות לעיל
במידה ולא חסמו את האפשרות של משלוח הטלפון מערכת והשלוחה

 https://www.abc.co.il/API.aspx?ApiPhone=0501111111&ApiDID=0771234567&ApiExtension=5/6&Mosad=1111&ClientName=mml&Adresse=jj&xxx=yyy&ID=123456789&ZIP=555555

המערכת מקבלת את התשובה ומייחסת אליה ב3 שלבים

שלב 1:
אם יש קובץ wav או tts ששמו כשם התשובה המלאה - המערכת תשמיע את הקובץ
לדוגמא התקבלה תשובה ok ויש קובץ בתיקיה בשם ok.wav המערכת תשמיע אותה

בנוסף ניתן להגדיר שמנוע הדיבור יקריא את התשובה כמו שהתקבלה

say_api_answer=yes

במידה ומוגדר המערכת תפעיל את מנוע הדיבור ותשמיע את התשובה, שימו לב שאם תחילת התושבה באנגלית, המערכת תתיחס לכלל התשובה באנגלית ולכן גם ספרות תשמעו באנגלית.

שלב 2:
לאחר ההשמעה או אם לא קיים, המערכת בודקת האם יש התיחסות במערכת

לדוגמא לתשובה של ok המערכת תחפש בערכים של הגדרות התיקיה

api_answer_ok=

ואם הערך קיים, המערכת תחפש גם ערכים נוספים אם קיימים

    api_answer_ok_1=
    api_answer_ok_2=
    api_answer_ok_3=

ובמידה והתשובה היא
id-error
אז המערכת תחפש הגדרה של

api_answer_id-error=

ואם הערך קיים, המערכת תחפש גם ערכים נוספים אם קיימים

    api_answer_id-error_1=
    api_answer_id-error_2=
    api_answer_id-error_3=

ההגדרות במערכת יכולות:
מעבר לתיקיה אחרת go_to_folder
השמעת נתונים id_list_message
קבלת נתונים נוספת מהמשתמש ושליחתה לשרת - read
מעבר לסליקת אשראי - credit_card
מעבר למערכת אחרת בימות המשיח routing_yemot
חיוג דרך מודול routing

go_to_folder

לדוגמא מעבר לשלוחה
/5/9
כאשר התשובה היא ok
נגדיר

api_answer_ok=go_to_folder=/5/9

לקוחות המעוניינים להעלות קבצים גלובלים להשמעה במודול API יכולים לפנות לשירות הלקוחות במייל special@yemot.co.il עם הנושא "הודעות להוספה למאגר גלובלי במודול API". בצירוף ההקלטות מהשמות שלהם כפי שיקראו במאגר ושההקלטות יהיו מומרות לאיכות של המערכת.
שימו לב, המאגר הוא ציבורי לכל הלקוחות.

דוגמא לשימוש במאגר:

מענה ב `id_list_message`:

id_list_message=f-YM_LOCAL/GlobalTest&

בדוגמא, ישמיע את הודעה GlobalTest מתוך המאגר הגלובלי.
ניתן גם לציין תיקיה בתוף המאגר:

id_list_message=f-YM_LOCAL/Pesach/GlobalTest&

ישמיע את קובץ GlobalTest מתוך התיקיה Pesach שבמאגר הגלובלי.

מענה ב `read`

read=f-YM_LOCAL/GlobalTest=vall,no,3,3,20,Digits,yes,no

בדוגמא, ישמיע את הודעה GlobalTest מתוך המאגר הגלובלי.
גם כאן ניתן לציין תיקיה בתוך המאגר הגלובלי כמו בדוגמא למעלה.

ניתן להגדיר בדיקה האם הקובץ קיים בתיקיית הלקוח ורק אם לא להשמיע מהתיקיה הגלובלית:

global_folder_check=yes

ניתן גם לבקש נתיב בתוך התיקיה הגלובלית כולל סלש בהתחלה:

global_folder_share=/Pesach

במקרה כזה עליכם לענות תשובה רגילה, ללא ציון YM_LOCAL בהתחלה. למשל:

id_list_message=f-000&

ואז, אם הקובץ קיים בשלוחה הוא יושמע, במידה שלא יתבצע בדיקה ב

YM_LOCAL/000

או אם צויין תיקיה לבדיקה הבדיקה תיהיה

YM_LOCAL/Pesach/000

id_list_message

ובשביל להשמיע נתונים כאשר התשובה היא ok נגדיר

api_answer_ok=id_list_message=f-57750730.f-/5/6/57881001.a-www012@.d-5567.n-5123.t-שלום אני מדבר בעברית.t-Hello I speak English.s-say123.s-/1/2/fileTts

אם רוצים לתת 2 פקודות במקביל
לדוגמא
להשמיע את הקבצים, ולאחר מכן ללכת לתיקיה אחרת
אז נגדיר

api_answer_ok=id_list_message=ff-57750730.f-/5/6/57881001.a-www012@.d-5567.n-5123.t-שלום אני מדבר בעברית.t-Hello I speak English.s-say123.s-/1/2/fileTts

api_answer_ok_1=go_to_folder=/5/9

read

שימו לב, במידה ואתם עונים read לא ניתן לשרשר פעולות!
ברגע שהלקוח ענה על ה read הפעולה מסתיימת ואנחנו שולחים לשרת שלכם את התשובה.
למשל עם שלחתם

read=f-000=abc,yes,8,4,7,Number,yes,no,*/&read=f-001=def,yes,8,4,7,Number,yes,no,*/&

ברגע שהלקוח ענה על abc נשלח לכם את התשובה שהלקוח ענה בלי def

ואם רוצים שהמערכת תשאל את הלקוח עוד שאלה
ואחרי קבלת תשובת הלקוח
תבדוק האם יש לפי ההגדרה בשלוחה read_answer ותפעל לפי ההגדרה
ובאם אין אז תשלח את תשובת הלקוח לשרת שלכם
נגדיר

api_answer_ok=read=f-StringAll.a-www012@.d-5567.n-5123.t-אחד שתיים שלוש.t-Hello I speak English.s-StringAllbbb=DFGH,yes,8,4,7,Number,yes,no,*/

הסבר
הסימן = הוא מפריד בין הערכים
הערך הראשון אומר להפעיל את האפשרות של read כלומר קבלת נתונים מהלקוח

הערך השני אומר איזה הודעה להפעיל ללקוח
כאשר בין סוג לסוג של הפעלה יש את הסימן נקודה"." בתור מפריד
ניתן להפעיל כל אחד מ6 סוגים של צורות הדיבור, וכל אחד מהם כמה פעמים שצריך
בדוגמא כתוב

f-StringAll.a-www012@.d-5567.n-5123.t-אחד שתיים שלוש.t-Hello I speak English.s-StringAllbbb

הסבר על הצורות הניתנות להפעלה של "f" "a" "d" "n" "t" "s" ראה יותר למטה

הערך השלישי
מחולק ל10 ערכים פנימים שמופרדים בפסיק ","
כאשר הערך הראשון הוא השם של הערך שאתם תרצו לקבל בתשובה,
הסבר על כלל הערכים ראה לעיל - על ה10 ערכים בקבלת נתונים הראשונית בתיקיה, וכאן זה זהה
בדוגמא כתוב

DFGH,yes,8,4,7,Number,yes,no,*/

כלומר הערך לקבלה - הערך הראשון הוא DFGH, והערך העשירי - איזה ספרות ניתן להקיש ריק כלומר ניתן להקיש את כל המקשים

לאחר שהלקוח ענה על פקודה זו
המערכת בודקת האם יש תשובה מוגדרת להתיחסות read_answer
ואם לא אז היא שולחת לAPI את הסטרינג מכל הערכים שהיו מקודם + את הערך ותשובת הלקוח שהתקבל עכשיו

הסבר על read_answer
לאחר שקיבלנו מהלקוח את מה שהקיש, על הערך
במקום שנשלח אליכם את כל הסטרינג והמערכת שלכם תענה לאיפה צריך ללכת
ניתן להגדיר בתוך השלוחה בקובץ ext.ini מה לעשות
דוגמא: הערך שהשרת ענה שצריך לקבל בread הוא לדוגמא DFGH (כך מופיע בדוגמא לעיל) והלקוח ענה לי 1234
אז אפשר להגדיר המערכת למקרה שהלקוח ענה 1234 יעשה 3 פקודות לדוגמא
ישמיע מילים, שוב ישמיע עוד מילים, ואחרי זה יעבור לתיקיה אחרת
ואחרי זה יעבור לתיקיה
דוגמא למה שתכניסו בקובץ ext.ini

read_answer_DFGH_1234=id_list_message=t-ענית אחד שתים שלוש ארבע
read_answer_DFGH_1234_1id_list_message=t-הנך מועבר לשלוחה אחד
read_answer_DFGH_1234_2=go_to_folder=/1

ניתן גם כמובן להשתמש בפקודות האחרות של לקבל עוד נתון של read
או לעבור לסליקה של קרדיט

במידה ואין התיחסות בשלוחה להקשות הלקוח אז המערכת שולחת את הסטרינג לשרת
הערה חשובה
לתשומת לבכם
בשלב זה, לאחר שהמערכת כבר שלחה סטרינג לשרת שלכם, המערכת רק מוסיפה לסטרינג שנשלח אליכם את הערך והתשובה של מה שהתקבל
ולא!!! משנה את כל הסטרינג הקיים
כלומר המערכת שולחת את מה שנשלח כבר לפני - בתוספת הערך והקשת הלקוח
מה שחשוב שתשימו לב שלא תחזירו בתשובה מהשרת שלכם אלינו - בקשה לקבלת ערך שכבר קיים בסטרינג כי אז זה יצור אצלכם קונפליקט שתקבלו את הערך פעמיים.
אם אתם צריכים שהלקוח יתקן ערך מסויים - פשוט תשתמשו במעבר לשלוחה אחרת ותחזירו לשלב שמקבל את אותו ערך מחדש
הערה: אם קיבלתם את הנתון בשלוחה אחרת במערכת ועדיין לא צירפתם אותו לסטרינג בשלוחה זו, אז כן תוכלו לענות למערכת שיקבל את הערך הזה
ובמידה ומוגדר שלא יקבל מחדש את הערך אם הוא שמור, והערך באמת שמור מלפני כן, המערכת מיד תשלח אליכם בקשה חדשה עם הערך השמור.

תוכלו לענות גם פעם שניה וכו' תשובה של read והמערכת שוב תקבל את הנתון ותשלח אותו אליכם, כמה פעמים שצריך.

credit_card

דוגמא לתשובה בשביל להגדיר מעבר לתשלום

api_answer_ok=credit_card=pelecard,100,999,3,1,DebitPaymntsType

הסבר על הערכים:
כל הערכים שמופיעים במודול של סליקה כללית - type=credit_card
עובדים כאן
ולכן לפני הכל חובה להגדיר בתיקיה את הערכים של סוג הסליקה ואת השם משתמש והסיסמה ובמקומות שבהם נדרש גם מספר חנות / פרויקט

בדרך כלל ערכי החובה הם

credit_card_type=nedarim_plus\kesherhk\cardcom\pelecard
credit_card_user_name=שם המשתמש שקבילתם מחברת הסליקה
credit_card_password=סיסמה שקיבלתם מחברת הסליקה
credit_card_terminal_number=מספר הטרמינל שקיבלתם מחברת הסליקה
credit_card_register_number=מספר החנות / מספר פרויקט - יש חברות שבהם הערך חובה

לא כל הערכים חובה בכל החברות מומלץ להסתכל בהגדרות של מודול הסליקה
ובמידת הצורך לשנות או להוסיף מהופיע לעיל

חלק מהערכים עשינו שתוכלו לשלוח דרך הAPI בתשובה
כאשר במידה והערכים מוחזרים על ידי הAPI הם גוברים גם על ההגדרות בתיקיה
אבל לא חובה לשלוח את התשובות, ובמידה והם כבר מוגדרים בתיקיה או שיש הגדרת ברירת מחדל אז המערכת תוכל להתקדם גם ללא ערכים אלו

הסבר על הערכים:
credit_card ערך ראשון
בדוגמא מופיע
pelecard
שם חברת הסליקה שדרכה אתם עובדים
אם לא הגדרתם את הערך בתיקיה, ערך זה הינו ערך חובה

credit_card ערך שני
בדוגמא מופיע 100
כאן בעצם זה הערך של billing_sum
הסכום לחיוב הינו 100 ש"ח

credit_card ערך שלישי
בדוגמא מופיע 999
מספר חנות / מספר פרויקט
כאן זה ערך credit_card_register_number
יש חברות שערך זה הינו ערך חובה

credit_card ערך רביעי
בדגומא מופיע 3
כמות התשלומים המקסימלית
כאן זה ערך credit_card_max_tashloumim
אם לא תכתבו כלום ואין הגדרה אחרת בתיקיה אז המקסימום זה 36

credit_card ערך חמישי
בדוגמא מופיע 1
סוג מטבע credit_card_currency
כרגע בכל מקרה פעיל רק מטבע 1 שזה שקל חדש, בהמשך יעודכן גם דולר ויורו, ניתן להסתכל במודול הסליקה.

credit_card ערך שישי
ערך זה מיועד רק לסולקים דרך חברת פלאקארד,
במידה ומוגדר יותר מתשלום אחד חובה להגדיר באיזה סוג רוצים לקבל תשלומים או קרדיט
האפשרויות הם:
DebitRegularType - תשלום אחד
DebitCreditType - תשלום בקרדיט
DebitPaymntsType - תשלום בתשלומים רגילים

credit_card ערך שביעי
שם המשתמש credit_card_user_name
אם לא הגדרתם את הערך בתיקיה, ערך זה הינו ערך חובה

credit_card ערך שמיני
מספר מסוף credit_card_terminal_number
אם לא הגדרתם את הערך בתיקיה, וחברת הסליקה שלכם דורשת ערך זה, אז ערך זה הינו ערך חובה

credit_card ערך תשיעי
סיסמה credit_card_password
אם לא הגדרתם את הערך בתיקיה, וחברת הסליקה שלכם דורשת ערך זה, אז ערך זה הינו ערך חובה

credit_card ערך עשירי
האם לשדר בחזרה את התשובה המלאה שמגיעה מחברת הסליקה
ברירת מחדל: בכל חברות הסליקה נשלח לאחר הסליקה בתשובה CreditCard_CODE כלומר מה סטטוס העיסקה
ברירת מחדל בסליקת פלאקארד: לאחר הסליקה נשלח התשובה בתוספת CreditCard_All עם הערכים החשובים

בשאר חברות האשראי: אם ברצונכם לקבל את הערכים הנוספים יש לשדר בערך העשירי all
כל תשובה אחרת או ריק, לא ישדרו את הערכים הנוספים שמגיעים מחברות הסליקה
הערה חשובה: מכיוון שבחלק מחברות הסליקה לא ניתן להחזיר את התשובה המלאה לכן יש לבדוק בהתאמה מול חברת הסליקה שלכם,
בנתיים בדקנו תקינות מול סליקה ריווחית - icredit
במידה וניתקלתם בבעיה בתשובה בעקבות הגדרת all אנא פנו לשרות הלקוחות שנוכל לבצע התאמת התשובה מחברות הסליקה, למה שנשדר אליכם בapi בחזרה

לאחר הסליקה בהצלחה
ישלח אליכם שוב הAPI עם כל הפרטים שהיו לפני כן
עם התוספת של המחרוזות הבאה

&CreditCard_CODE=קוד התשובה

וכן את התוספת הבאה בהתאם להגדרות בערך העשירי

&CreditCard_All=הערכים החשובים מהתשובה המלאה

הערכים החשובים מהתשובה המלאה

קארדקום cardcom
1)סטטוס אישור
2) מספר אישור
3) סכום העיסקה
4) ארבע ספרות אחרונות של הכרטיס המחוייב
הערכים יגיעו עם נקודה בין ערך לערך

טרנזילה tranzila

טוקן Token
מספר אישור ConfirmationCode
4 ספרות אחרונות ccno
פג תוקף של הכרטיס expdate

ריווחית - icredit
משודרים 5 ערכים בהפרדה של # בין ערך לערך

סטטוס עיסקה
CustomerTransactionId
3)Token
4)ReceiptLink
5)מספר אישור עיסקה של ריווחית

פלאקארד:
כאשר הסליקה היא דרך פלאקארד, מכיוון שלא ניתן להעביר אליכם את התשובה המלאה - מכיוון שמכילה תווים מיוחדים
לכן ריכזנו את הדברים החשובים
כאשר הערכים יגיעו עם הפרדה של נקודה
לדוגמא

0004580123412341234.1.1217.00000500.1.01.1.0000000.00000000.00000000.00

מספר כרטיס
מספר חברה סולקת 1 - ישראכרט 2 - ויזה 3 - דיינרס 4 - אמקס 6 - לאומי קארד
תוקף
סכום באגורות
קוד חברת אשראי
סוג עיסקה
סוג מטבע
מספר אישור
סכום תשלום ראשון
סכום קבוע
מס' תשלומים קבועים (שימו לב שמדובר על יתרת התשלומים אחרי התשלום הראשון, ולכן אם מדובר על תשלום אחד תקבלו תשובה של 00, ואם הגדרתם 5 תשלומים אז תקבלו תשובה של 04)

כמובן השרת שלכם יוכל לענות בכל אחד מהצורות המופיעות
ותוכלו להודיע ללקוח שהסליקה התקבלה בהצלחה עם מספר האישור ועוד כפי המופיע בתשובה המלאה שקיבלתם

credit_card ערך אחד עשר

במידה ותכתבו בערך האחד עשר את המילה EnterPhone
המשמעות תהיה כאלו הגדרתם
credit_card_enter_phone=yes
הסבר:
ברירת מחדל בנדרים פלוס - מספר הטלפון שנשלח בערך Phone הינו מספר הטלפון ממנו התקשרתם
מכיוון שבנדרים פלוס ישנם חשבונות טלפון רבים, לכן הגדרנו שניתן לתת תפריט ללקוח שיבחר איזה טלפון לשדר

במקרה שלקוח בוחר את הזיהוי הטלפוני
אז המערכת תשדר בנפרד את הטלפון שממנו הלקוח חייג,
הערך ישודר בתוך הערך Avour ושם יופיע

OriginalPhone-0771234567

במידה והפעלתם את ההגדרה המערכת תשאל:
M1589 "לשידור מספר הטלפון ממנו התקשרתם הקישו 1 וסולמית
לשידור מספר טלפון אחר הקישו את מספר הטלפון וסולמית לסיום"

הערך הזה בנתיים פעיל רק בנדרים פלוס, במידת הצורך בקשו משרות הלקוחות שנוסיף שאלה זו בחברות סליקה נוספות

credit_card ערך שנים עשר
במידה ותכתבו בערך השנים עשר את המילה
NameStt
גורם לכך שהמערכת תשדר
credit_card_name_stt=yes
שמשמעותו להקליט את השם ולשלוח אותו לחברת הסליקה בתור שם בעל הכרטיס
(עיין בהרחבה במודל סליקה)

credit_card ערך שלושה עשר
במידה ותכתבו בערך השלשה עשר את המילה
NoAsk
גורם לכל שהמערכת תשדר
credit_card_name_stt_record_no_ask=yes
שמשמעותו שבמידה ויש תוצאה של השם שנקלט , לא יבקש אישור על השם מהלקוח
אלא מיד יתקדם הלאה

credit_card ערך ארבע עשר
במידה ותכתבו בערך הארבע עשר את המילה
CreateToken
גורם לכל שהמערכת תשדר
credit_card_create_token=yes
שמשמעותו שלאחר סליקה בהצלחה המערכת תבקש מחברת האשראי לייצר טוקן
במידה ונוצר טוקן הוא יצטרף לערכים שחוזרים אליכם בAPI
הערה 16/01/2020: נכון להיום ניתן לבקש לייצר טוקן ב Tranzila,
חברת cardcom מייצרת טוקן גם ללא בקשה
כל שאר החברות עדיין לא פותח נושא הטוקן

credit_card ערך חמש עשרה
ברירת מחדל במידה ולקוח הקיש כוכבית במהלך התפריטים ליציאה, המערכת מחזירה למודול API ששם כתוב שאם הסליקה לא הסתימה בהצלחה שיחזור שוב לגביית אשראי, בקיצור המערכת בלופ אשראי עד לגבייה בהצלחה
ניתן להגדיר בערך
GoBack
במקרה כזה , במידה ולקוח הקיש כוכבית ליציאה במהלך התפריטים יחזור ל API , והAPI ישדר לכם
CreditCard_CODE=GoBack&CreditCard_All=GoBack
ואז תוכלו לענות שוב בAPI שלכם לאן ברצונכם לשלוח את הלקוח
(לדוגמא לגביה באמצעות נציג, לתפריט אפשרויות נוספות וכו')

credit_card ערך שש עשרה
בערך השש עשרה נשדר את ערך credit_card_remarks
שזה הערות שנשלחות כחלק מהסליקה, הערך נתמך בחלק מהחברות, יש לבדוק במודול סליקה באיזה חברות הערך נתמך

routing_yemot

לדוגמא מעבר למערכת אחרת
כאשר התשובה היא ok
נגדיר

api_answer_ok=routing_yemot=0773137770

routing

חיוג דרך מודול ראוטינג
כאשר התשובה היא ok
נגדיר

api_answer_ok=routing=0581234567

הערכים המלאים שניתן לשדר
הסבר על כל ערך ומה אפשר לשדר בו ניתן להסתכל במודול routing עצמו

*routing=routing_to_phone,routing_start,routing_tor,routing_multiple,routing_multiple_numbers,routing_your_id,routing_record,send_sms_befor_routing,routing_end_time,routing_end_goto,music_on_hold,routing_answer_play,routing_answer_tfr,routing_answer_tfr_hangup_goto,routing_email_address,routing_email_name

אם רוצים לשדר שיחה כאשר יש תפריט לעונה השיחה אם לקבל או לא ניתן להגדיר

    api_answer_ok=routing=0587706264,,,,,,,,,,,,yes

api_answer_okB=routing=05012345678.0556667777.05298765432,,,yes,1.3,,,,,,,

הסבר: כאשר התשובה היא ok הערך ה13 הוא routing_answer_tfr ובו רשמנו yes כלומר ישמיע תפריט למי שעונה האם לקבל או לדחות
כאשר התשובה היא okB אז הוא יפעיל חיוג בו זמנית למספרים 1 ו 3 כלומר ל 05012345678 וגם ל 05298765432

מצ"ב רשימת הערכים עם מספור

1=routing_to_phone
2=routing_start
3=routing_tor
4=routing_multiple

   (במידה ואתם מגדירים כאן `routing_multiple=yes` אז הערך הראשון יש לשדר את כלל המספרים שאתם רוצים להזין עם הפרדה של נקודה "." , המערכת ממספרת אותם לפי הסדר כלומר במידה והגדרתם 05012345678.0556667777.05298765432 אז המערכת תתרגם את זה ל routing1=05012345678 routing2=0556667777 routing3=05298765432)

5=routing_multiple_numbers
(יש לשים את כלל השלוחות שאותם אתם מעונינים להפעיל רק את 05012345678 ואת 05298765432 אז בעצם זה שלוחות 1+3 ולכן יש להגדיר 1.3 כלומר את השלוחות להפעלה עם מפריד נקודה "." )
6=routing_your_id
7=routing_record
8=send_sms_befor_routing
9=routing_end_time
10=routing_end_goto
11=music_on_hold
12=routing_answer_play
13=routing_answer_tfr
14=routing_answer_tfr_hangup_goto
15=routing_email_address
16=routing_email_name

music_on_hold

לדוגמא להפעלת מוזיקה בהמתנה
כאשר התשובה היא ok
נגדיר

api_answer_ok=music_on_hold=סוג המוזיקה שלכם

שלב 3: (תחליף לשלב 2)
עד כאן הסברנו מה קורה במידה והשרת שלכם עונה למשל ok המערכת מחפשת את הערך api_answer_ok בקובץ ההגדרות בשלוחה
או אם השרת שלכם ענה ABC המערכת מחפשת את הערך api_answer_ABC בקובץ ההגדרות בשלוחה

יש אפשרות נוספת שבו השרת שלכם עונה פשוט את כל ההגדרות בצורה ישירה
במקום להגדיר בתוך התיקיה מה לעשות במקרה של תשובה מהשרת שלכם
ניתן להגדיר שהשרת שלכם יענה ישר את הפקודות לביצוע
אם רוצים לתת כמה פקודות לביצוע ניתן להגדיר בין פקודה לפקודה את הסימון "&"

הערה כללית לשלב 3: שמנו לב שבחלק מהמערכות משום מה יש תו אחרון נסתר , והתוצאה היא שהמערכת קוראת גם את התו הנסתר ולכן למשל אם רציתם ללכת לתיקיה אחרת, המערכת לא מקבלת את התיקיה שרציתם לכתוב, ההמלצה שלנו היא תמיד בסוף הפקודה לשים את הסימון "&" ואז מבחינת המערכת הפקודה נגמרה ולאחר מכן יש פקודה הבאה, כך שהפקודה הראשונה "ננעלה" כמו שצריך, ולאחר מכן המערכת תראה שהפקודה השניה ריקה ותדע לבצע סיום.

דוגמאות לתשובות שתוכלו לענות:

go_to_folder=/5/9

בשביל מעבר לשלוחה אחרת

או לענות

id_list_message=f-57750730.f-/5/6/57881001.a-www012@.d-5567.n-5123.t-שלום אני מדבר בעברית.t-Hello I speak English.s-say123.s-/1/2/fileTts

בשביל להקריא את הנתונים

אם רוצים לתת 2 פקודות במקביל
לדוגמא
להשמיע את הקבצים, ולאחר מכן ללכת לתיקיה אחרת
אז נגדיר את הפקודות עם "&" בין פקודה לפקודה

id_list_message=f-57750730.f-/5/6/57881001.a-www012@.d-5567.n-5123.t-שלום אני מדבר בעברית.t-Hello I speak English.s-say123.s-/1/2/fileTts&go_to_folder=/5/9

או לענות

read=f-StringAll.a-www012@.d-5567.n-5123.t-אחד שתיים שלוש.t-Hello I speak English.s-StringAllbbb=DFGH,yes,8,4,7,Number,yes,no,*/

בשביל לקבל עוד נתונים מהלקוח

או לענות

credit_card=pelecard,100,999,3,1,DebitPaymntsType

בשביל סליקת אשראי

או לענות

music_on_hold=סוג המוזיקה שלכם

בשביל להפעיל מוזיקה בהמתנה

או לענות

routing_yemot=0773137770

בשביל לחייג למערכת אחרת בימות המשיח

או לענות

routing=0581234567

בשביל לחייג למספר טלפון אחר שלא בימות המשיח עם חיוב יחידות

הסבר על האפשרויות של id_list_message וכן ההודעה להשמעה ב read
ישנם 6 סוגי השמעת קבצים
;f - ברירת מחדל יש לרשום רק שם קובץ ואז מפעיל מתוך תיקית ברירת המחדל, ניתן לרשום כתובת מלאה שמתחילה בסלש "/" ואז המערכת תשמיע את הקובץ מתוך הכתובת המלאה שציינתם
;d- (Digits) ספרות
;n -(Number) מספר
;a -(Alpha) אותיות באנגלית
;t -(text) טקסט מילים עברית או אנגלית או שילוב של שניהם
;s - (Speech) הפעלת מנוע דיבור של כל הטקסט בעברית או באנגלית המופיע בקובץ. הקובץ חייב להיות בפורמט utf-8 ובסיומת של tts ברירת מחדל הקובץ נלקח מתוך תיקית ברירת מחדל, ניתן לרשום כתובת מלאה שמתחילה בסלש "/" והמערכת תשמיע את הכתובת המלאה

בין השמעה להשמעה יש לסמן"."
בין סוג ההשמעה לבין התוכן יש לסמן "-"
שימו לב ! יש להיזהר שלא יהיה נקודה (.) וגם לא מקף אמצעי (-) בתוך הטקסט, כדי שלא יהרוס את הרצף של ההקראה מה שעלול גם לגרום לניתוק השיחה.

הסבר לדוגמא המופיע לעיל

ישמיע מתוך תיקית ברירת המחדל את קובץ
57750730.wav
ואח"כ ישמיע מתוך תיקיה /5/6 את קובץ
57881001.wav
ואח"כ ישמיע בצורת אותיות באנגלית
"w" "w" "w" "0" "1" "2" "@"
ואח"כ ישמיע
"חמש חמש שש שבע"
ואח"כ ישמיע
חמשת אלפים מאה עשרים ושלוש
ואח"כ ישמיע
שלום אני מדבר בעברית
ואח"כ ישמיע
Hello I speak English
ואח"כ ישמיע מתוך תיקית ברירת המחדל את כל המלל המופיע בקובץ בשם say123
ואח"כ ישמיע מתוך תיקיה /1/2/ את כל המלל המופיע בקובץ בשם fileTts

## מעבר למיקום אחר במערכת במקרה של תקלה בתשובה
במקרה שהתשובה לא תקינה
המערכת מודיעה M1607 אין מענה משרת API
לאחר מכן
ברירת מחדל
המערכת חוזרת שלב אחד למעלה
ניתן להגדיר לנתק או לעבור לכל שלוחה אחרת

api_end_goto=hangup
api_end_goto=/5/8

בדוגמא הראשונה מנתק
בדוגמא השניה עובר לשלוחה /5/8

שמירת דוחות של השליחה והקבלה

כל השליחות והתשובות נמצאות בקובץ LogApi.ymgr שתחת תיקית Log שבתיקיה הראשית

בשביל לא ליצור קונפליקט במערכת - הוחלפו כמה תווים בקובץ
ApiSend - החלפנו את "=" בסימן "^" וכן את "&" בסימן ""
ApiAnswer - החלפנו את "," בסימן "^" וכן את "&" בסימן ""

ביטול כל הדוחות:
ניתן לבטל את כלל הדוחות של שלוחת API.
יש להגדיר בשלוחה:

api_log=no

אפשרות נוספת לביטול הדוחות לפי כל תשובה
כלומר תוכלו לשדר כחלק מהתשובה שלכם ב api האם לשמור את הלוג הזה או לא
ברירת מחדל תמיד שומר אלא אם כן הגדרתם בשלוחה לא לשמור
או אם הגדרתם בתחילת התשובה בapi את המילים api_log_no
דוגמא לתשובה שבה יש הגדרה שלא ישמור את הלוג, ויעבור לשלוחה אחרת

api_log_no&go_to_folder=/5/8

שימו לב זה הגדרה שאתם עונים מהשרת API שלכם
(ולא הגדרה בשלוחה עצמה)

מודול API - תקשור עם מחשבים וממשקי נתונים חיצוניים - שרשור ישן

שימו לב! זהו שרשור ישן. השרשור החדש והמעודכן נמצא כאן.

ערכים להקלטה record:

ערכים לקבלת נתונים בהקשות:

ערכים לvoice:

go_to_folder

מענה ב id_list_message:

מענה ב read

id_list_message

read

credit_card

routing_yemot

routing

music_on_hold

שמירת דוחות של השליחה והקבלה

מענה ב `id_list_message`:

מענה ב `read`