API - גישת מפתחים למערכות

[שמואל]

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

הפקודה היא - GetCustomerSmsTransactions

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

פרמטר	תיאור	סוג	הערות / דוגמא
token	טוקן	string

מביא 2000 תנועות אחרונות

---

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
yAfastVersion	string	גירסת מערכת
rows	array	מערך תנועות

פירוט איבר במערך:

שם	תיאור
transactionTime	זמן תנועה
amount	סכום תנועה ביחידות
description	תיאור החיוב
newBalance	יתרת יחידות עדכנית בביצוע הפעולה
expireDate	תאריך תפוגה עדכני בביצוע הפעולה
who	מבצע הפעולה

[שמואל]

בדיקה האם תיקייה קיימת

הפקודה היא - CheckIfFolderExists

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

פרמטר	תיאור	סוג
token	טוקן	string
path	נתיב במערכת. דוגמאות למטה	string

---

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
folderExists	bool	האם התיקייה קיימת
path	string	המיקום שלה	ivr/10

[שמואל]

חשבונות SIP

---

תיעוד api הנוגע לחשבונות SIP

כל השירותים שקשורים לSIP קיימים רק בשרתים תומכים.
בכל פניה לשרת שלא תומך תתקבל תגובה:

{
responseStatus: "ERROR",
message: "שרת זה אינו תומך במערכת SIP",
yAfastVersion: "any"
}

---

מאפיינים

לכל חשבון SIP במערכת יש מספר מאפיינים

1. מספר החשבון במערכת (למשל 1 2 וכן הלאה)
2. שם המשתמש להתחברות
   בדרך כלל שם המשתמש מורכב ממספר המערכת ומספר החשבון.
   למשל 0772222770=2 זהו שם המשתמש של חשבון 2 במערכת 0772222770
3. מספר שלוחה - כל מספר שנמצא בטווח מ-200 ועד 10,000
   מספר שלוחה הינו מאפיין הנתון לבחירה של מנהל המערכת וניתן לשנות אותו בכל עת.
   הדבר משמש עבור חיוגים פנימיים בין החשבונות. (למשל כדי לחייג משלוחה 200 לשלוחה 201 יש לחייג למספר "201" במקרה כזה מה שיופיע על הצג אצל מקבל השיחה זה "200")
4. סיסמת התחברות
5. פרוטוקול SIP להתקשרות (נכון לעכשיו התמיכה היא בפרוטוקולים UDP WSS)

---

יצירת חשבון

הפקודה היא - CreateSipAccount

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

פרמטר	תיאור	סוג
token	טוקן	string
extNumber	אפשר לציין מספר שלוחה. לא חובה. מספר שלוחה יכול להיות בין 200 ל10000.	int

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
accountID	string	שם המשתמש שם החשבון שנוצר.
accountNumber	int	מספר החשבון במערכת (לא מספר שלוחה)
PASS	string	הסיסמה של החשבון להתחברות

---

קבלת רשימת החשבונות במערכת

הפקודה היא - GetSipAccountsInCustomer

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

פרמטר	תיאור	סוג
token	טוקן	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
accounts	array	מערך חשבונות
accountLimit	int	כמות החשבונות שהלקוח יכול ליצור במערכת	6

מערך החשבונות

מאפיין	סוג	הסבר	דוגמא
id	string	שם המשתמש של החשבון
accountNumber	int	מספר חשבון במערכת
customerExtension	int	מספר שלוחה, אם מוגדר
transport	string	סוג התקשורת המותרת בחשבון. transport-udp \ transport-wss
callerid	string	מערכת לחיוב יחידות
specialCallerID	string	זיהוי מיוחד להוצאת שיחות
password	string	סיסמה להתחברות בsip
created_date	string	תאריך יצירה של החשבון

---

שינוי התעבורה המותרת בחשבון - UDP \ WSS

מאפשר לשנות את סוג התעבורה המותרת. תיתן להתחבר לחשבונות הsip עם תקשורת של UDP או עם חיבור לwebsocet של שרת הסיפ, למשל כדי להטמיע את השירות בדפדפן על ידי פרוטוקול webRTC למשל בשימוש עם ספריית jssip.

הכתובת של שרת הsip להתחברות עם websocket היא wss://sip.yemot.co.il:8089/ws, החיבור הוא על בחיבור מאובטח בלבד (wss://).

הפקודה היא - SipToWss | SipToUdp

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

פרמטר	תיאור	סוג
token	טוקן	string
accountNumber	מספר החשבון, אם לא צוין מוגדר על החשבון הראשון	int

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK

---

הגדרת זיהוי יוצא קבוע

מאפשר להגדיר את הזיהוי היוצא של החשבון

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

הפקודה היא - EditCallerIdInSipAccount

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

פרמטר	תיאור	סוג
token	טוקן	string
accountNumber	מספר חשבון	int
callerId	זיהוי יוצא	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK

ניתן לבקש זיהוי יוצא מיוחד גם בעת השיחה עצמה ללא שינוי בהגדרות החשבון על ידי צירוף של header בשם X-YemotCallerId ל INTIVE של השיחה היוצאת.
במקרה של סתירה בין המופיע בהגדרות החשבון להגדרות השיחה הנוכחית, הגדרות השיחה יגברו.

---

מחיקת חשבון

הפקודה היא - DeleteSipAccount

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

פרמטר	תיאור	סוג
token	טוקן	string
accountNumber	מספר החשבון למחיקה כמספר, או מערך של מספרי חשבונות sip למחיקה.	int / array

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
affected_rows	int	מספר חשבונות הsip שנמחקו

---

ניהול מספר שלוחה

הפקודה היא - SipExtensionManagement

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

פרמטר	תיאור	סוג
token	טוקן	string
SipExtensionManagement	פעולה לביצוע. Get עבור קבלת מספר השלוחה ללא ביצוע שינוי. Set עבור שינוי או הגדרה של מספר שלוחה.	string
accountNumber	מספר חשבון ברירת מחדל החשבון הראשון
extNumber	מספר שלוחה. לא חובה בפעולת Get, אם לא צויין בפעולת Set מספר השלוחה ימחק.

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
extNumber	int	מספר השלוחה. במידה שמדובר בפעולת Set זה יכיל את המספר שלוחה החדש.

---

מידע טכני נוסף על קבלת שיחות לחשבון SIP

בINVITE שמגיע מימות המשיח ללקוח בכל שיחה יש 2 header שנוספים בכל שיחה.

X-Yemot-Path = מספר השלוחה שממנה הגיע השיחה.
X-Yemot-CallID = מזהה השיחה. ניתן להשוות את זה עם מודול תור בשימוש עם queue_api_send=yes, שם זה מגיע לשרת בערך YemotCallID.

[שמואל]

שינוי שימוש (usage) של מספר משנה

הפקודה היא - SetSecondaryDidUsageDescription

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

פרמטר	תיאור	סוג
token	טוקן	string
secondaryDidId	מזהה המספר משנה. מתקבל במערך המספרים המשניים ב GetCustomerData	int
newUsage	שימוש חדש, כפי המוסבר מטה.	string

ניתן לשנות שימוש של מספר משנה לאחד משתי הקידומות האלה:

sip:[0-9]
goto:/[A-Za-z0-9א-ת/]

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

הסבר על שימוש sip:X:

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

הסבר על שימוש goto:/:

מאפשר לשייך מספר משנה לשלוחה ספציפית במערכת - למשל, כדי לשייך לשלוחה 1/20/11 יש לכתוב goto:/1/20/11.

---

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
status	bool	הצלחה	ture

[שמואל]

קבלת מידע כללי על תיקיה (שלוחה)

הפקודה היא GetIVR2DirStats

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

פרמטר	תיאור	הערות
token	טוקן	חובה
path	נתיב תיקייה	חובה. לדוגמה: / עבור שלוחה ראשית. 1 עבור שלוחה 1 ext/1 עבור שלוחה ext/1

---

מאפייני תגובת השרת

מאפיין	סוג	הסבר
type	string	סוג השלוחה
thisPath	string	נתיב תיקייה נוכחית
parentPath	string	נתיב תיקיית אב
dirsCount	int	כמות תיקיות בשלוחה
filesCount	int	כמות קבצים בשלוחה
contentFilesCount	int	כמות קבצי שמע בשלוחה
minFile	object	מידע על קובץ השמע הנמוך בשלוחה
maxFile	object	מידע על קובץ השמע הגבוה בשלוחה

מאפייני קובץ שמגיעים באובייקטים minFile/maxFile

מאפיין	סוג	הסבר
exists	boolean	האם התיקייה/קובץ קיימים
name	string	שם התיקייה/קובץ
uniqueId	string	מזהה ייחודי לתיקייה/קובץ
what	string	נתיב תיקייה/קובץ
fileType	string	סוג תיקייה/קובץ
size	int	גודל קובץ (בבתים)
mtime	string	תאריך שינוי אחרון
duration		אורך (בדקות)
durationStr	string	אורך בפורמט mm:ss
customerDid	string	מספר מערכת בה נוצר הקובץ
meta	string	אובייקט המכיל מיגע נוסף על הקובץ
date	string	זמן יצירת קובץ dd/mm/yyyy hh:mm
source	string	מקור הקובץ
phone	string	טלפון יוצר הקובץ
ip	string	כתובת IP של מעלה הקובץ

[שמואל]

ניהול תור אונליין

---

שימו לב, ניהול התור אונליין אפשרי לשיחות ממתינות בתור בלבד.

את הממתינים בתור מקבלים בשירות GetQueueRealTime - לכל ממתין יש מזהה שיחה.

---

הפקודה היא - QueueManagement

שימו לב, שירות זה מקבל מערך. לצורך זה ניתן לפנות אליו רק בPOST עם json בbody.

בכל פניה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string
queuePath	מיקום התור. זהה לצורה שבה שולחים שם תור ב GetQueueRealTime	string
callIds	מערך מזהי שיחות תור (מתקבל גם ב GetQueueRealTime במערך הממתינים	array
action	פעולה לביצוע	string
moreData	הוראות נוספות - רשות	string

פעולות:

---

הוצאה מהתור - kick

הפעולה היא - kick

הפרמטרים הנדרשים בנוסף

פרמטר	תיאור	סוג
moreData	ניתן לציין בפרמטר זה שלוחה להעברת המשתמש היוצא. הפרמטר רשות. כדי להעביר למשל לשלוחה 1 יש לציין: GOTO:/1	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
status	object	סטטוס פעולות, באופן שהkey הוא מזהה השיחה והvalue הוא הסטטוס.

דוגמא לתגובה מלאה:

{
    "responseStatus": "OK",
    "yAfastVersion": "6.6.20",
    "status": {
        "805c3b221d4b76bb53769aac9e2c57c1": "Call not found",
        "f6657b78a2f35d6d04dd203400828362": "OK"
    }
}

---

השהיית נציג / החזרת נציג לפעילות

בפעולת אלה לא צריך לשלוח callIds, אלא רק queuePath
הפעולה היא - pause - השהיית נציג
הפעולה היא - unpause - ביטול נציג מהשהייה

הפרמטרים הנדרשים בנוסף

פרמטר	תיאור	סוג
agent	שם הנציג. זהה לשם שמגיע ב GetQueueRealTime['members'][?]['agent']	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK

[שמואל]

ניהול פרסומפון

---

הפקודה היא - PirsumPhoneManagement

בכל פניה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string
action	פעולה לביצוע	string

פעולות:

---

קבלת סטטוס רישום לשירות - GetRegistrationStatus

הפעולה היא - GetRegistrationStatus

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
registrationStatus	boolean	האם רשום או לא	true

---

רישום לשירות - Registration

הפעולה היא - Registration

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
results	string	הודעת הצלחה	OK

---

הסרה מהשירות - UnRegistration

הפעולה היא - UnRegistration

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
results	string	הודעת הצלחה	OK

[שמואל]

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

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

הפקודה היא - CallExtensionBridging

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

פרמטר	תיאור	סוג
token	טוקן	string
phones	רשימת מספרים. ראה להלן צורות תמיכה ברשימת מספרים	string / json
ivrPath	שלוחה במערכת, למשל: ivr2:/1/100 - יכניס לשלוחה 1/100	string
callerId	זיהוי שיחה יוצא, ברירת מחדל זיהוי של המערכת/רשימת התפוצה שנבחרה	string
callsTimeOut	זמן חיוג מקסימלי - בשניות, ברירת מחדל 30 שניות, מקסימום 35 שניות.	number

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

פרמטר phones יכול להכיל רשימת מספרים בדומה לשירות RunTzintuk:

---

כאשר הפניה היא בGET או בPOST שהוא לא (Content-Type: application/json) יש 3 אפשריות:

• רשימה מפורשת עם הפרדה של : בין מספר למספר
• מספרים מתוך רשימת תפוצה קיימת על ידי ציון tpl:XX כשאשר במקום הXX יש לכתוב את מזהה רשימת התפוצה.
• צינתוק לרשימת צינתוק חינמי (שימו לב הערה למטה בנוגע לאפשרויות שליחה לכמה רשימות צינתוקים חינמיים) על ידי ציון tzl:XX כאשר במקום XX יש לכתוב את מספר הרשימה במערכת.
  כאשר הפניה היא json - ניתן גם לשלוח את רשימת המספרים כמערך:

{
    "phones": [
        "0510000",
        "0510001",
        "0510002",
        "0510003"
    ]
}

או כמערך עם אובייקטים לצורך ציון זיהוי יוצא ספציפי לכל מספר:

{
    "phones": [
        {
            "phone": "0511111",
            "callerId": "077313"
        },
        {
            "phone": "05111333",
            "callerId": "07731344"
        }
    ]
}

או על אותו הדרך עם קבוצות:

"phones": [
        {
            "phones": [
                "0511111",
                "051111221"
            ],
            "callerId": "077313"
        },
        {
            "phones": [
                "0511111999"
            ],
            "callerId": "077414"
        }
    ]

---

חיוב יחידות:

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

שימו לב, ניתן להפעיל בשירות זה קמפיין עם עד 500 מספרים.

---

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

פרמטר	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
module	string	המודול של השלוחה שהשיחות יגיעו אילה	menu
callerId	string	זיהוי השיחה היוצאת	0770770770
callsCount	int	כמות מספרים שנכנסו לקמפיין	6
bilingPerCall	int	חיוב לכל שיחה (משוער)	1
errors	object	מערך של מספרים שלא נכנסות לחיוג ושגיאה	{ "0510001": "not Vaild", "0510002": "not Vaild", "0510003": "not Vaild" }
callsTimeout	int	זמן שיחה יוצאת כפי שנקלט	30
campaignId	string	מזהה קמפיין במערכת הקמפיינים	YA-1-0770770770-Yemot-1695290243349441

[שמואל]

קבלת רישומים לחשבון SIP - SipGetContexts

---

הפקודה היא - SipGetContexts

בכל פניה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string
accountNumber	ניתן לציין מספר חשבון sip, באם ריק, זה החשבון הראשון	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
contexts	array	טבלאת רישומים	מערך, יבואר מטה מבנה האובייקט

אובייקט במערך contexts

בעיקרון, לא אמור להיות יותר מרישום אחד פעיל.

מאפיין	סוג	הסבר	דוגמא
expiration_time	string	זמן התפוגה של הרישום, באם השלוחה שולח keep_alive - הזמן מתארך	2024-06-04 15:43:38
uri	string	הURI לחיוג בפועל לשיחה נכנסת	sip:0773137770@192.168.1.99:5060
user_agent	string	הפלטפורה שמחוברת	Yealink SIP-T29G
via_addr	string	ניתוב דרך. זה יכול להיות גם כתובת פנימית של השלוחה	192.168.1.110
via_port	string	ניתוב בפורט	5060

[שמואל]

קבלת חשבונות הSIP במערכת בדגש על בדיקה אם הם רשומים - GetSipAccountsRegisteredStatus

---

הפקודה היא - GetSipAccountsRegisteredStatus

בכל פניה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string

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

מאפיין	סוג	הסבר	דוגמא
responseStatus	string	סטטוס הפעולה	OK
accounts	array	טבלאת חשבונות	מערך, יבואר מטה מבנה האובייקט

אובייקט במערך accounts

מאפיין	סוג	הסבר	דוגמא
userName	string	שם המשתמש של החשבון	0773137770
createdDate	string	זמן יצירת החשבון	2021-06-26 23:00:00
registered	bool	האם רשום?	true

[שמואל]

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

---

הפקודה היא - GetApprovedCallerIDs

כל המספרים הם במבנה e164

בכל פניה יש לצרף:

פרמטר	תיאור	הערות
token	טוקן

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

מאפיין	סוג	תיאור	דוגמה
responseStatus	string	סטטוס הפעולה	OK
call	object	זיהויים לשיחות	יבואר מטה מבנה האובייקט
sms	object	זיהויים לשיחות	יבואר מטה מבנה האובייקט

אובייקט call

מאפיין	סוג	תיאור
mainDid	string	המספר הראשי של המערכת
secondaryDids	array	מערך מספרי משני
callerIds	array	מערך זיהויים מאושרים חיצוניים

אובייקט sms

מאפיין	סוג	תיאור
smsId	string	זיהוי הסמסים (אם יש זיהוי סמסים, זה אומר שסמסים יוצאים רק איתו, אם לא, ניתן לבחור בכל זיהוי שיחה גם לסמס)
allowText	bool	האם מאושר זיהויים טקסט

[שמואל]

בדיקת זיהוי האם הוא מאושר לשימוש בשיחה/סמס

---

הפקודה היא - IsCallerIDApproved

בכל פניה יש לצרף:

פרמטר	תיאור	הערות
token	טוקן
callerId	זיהוי לבדיקה
serviceType	סוג שירות לבדיקה. ברירת מחדל שיחות	sms אוcall

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

מאפיין	סוג	תיאור	דוגמה
responseStatus	string	סטטוס הפעולה	OK
parsedCallerId	string	המספר כE164	+972773137770
isApproved	bool	האם מאושר
reason	string	סיבה	INVALID_CALLER = זיהוי לא תקין / SMS_ID = נעילת זיהוי סמסים / INCLUDE = רשימת מספרים מורשים

[אהרן שובקס]

ניהול בקשות לשיחה חוזרת (מודול תור)

---

הפקודה היא - QueueCallBack

בכל פנייה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string
action	פעולה לביצוע	string

---

פעולות:

קבלת רשימת התורים

הפעולה היא - getQueues

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

מאפיין	סוג	הסבר	דוגמה
responseStatus	string	סטטוס הפעולה	OK
callbackList	array	רשימת התורים	[{...}]

דוגמת אובייקט של תור:

מאפיין	סוג	הסבר	דוגמה
id	integer	מזהה התור	110
path	string	השלוחה שבו הלקוח נרשם	"/1"
queue_path	string	שלוחת התור	"/1"
caller_id	string	זיהוי לשיחה היוצאת	0773137770
callback_times	string	זמני התור	weekDay=1-5&monthDay=&month=&year=*&time=09:15-16:30&open=true
max_waiting_time	integer	זמן מקסימלי לחכות בתור (בדקות)	120
max_waiting_customers	integer	מספר הלקוחות המרבי בתור	1
waiting_customers	integer	מספר הלקוחות הממתינים כעת בתור	0
open	boolean	אם התור פתוח או לא	1

---

---

קבלת רשימת השיחות הממתינות לשיחה חוזרת

הפעולה היא - getList

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

פרמטר	תיאור	סוג
id	מזהה התור	integer

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

מאפיין	סוג	הסבר	דוגמה
responseStatus	string	סטטוס הפעולה	OK
callbackList	array	רשימת השיחות הממתינות	[{...}]

דוגמת אובייקט של שיחה:

מאפיין	סוג	הסבר	דוגמה
id	integer	מזהה השיחה	84299
calling_number	string	מספר המתקשר	"0533137770"
status	string	סטטוס השיחה	"waiting"
date_time	string	תאריך ושעת השיחה	"2025-05-14T14:37:11.000Z"
attempts	integer	מספר הניסיונות לבצע שיחה חוזרת	0
last_attempt	string	מועד הניסיון האחרון	null

---

מחיקת שיחה

הפעולה היא - removeNumber

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

פרמטר	תיאור	סוג
id	מזהה השיחה	integer

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

מאפיין	סוג	הסבר	דוגמה
responseStatus	string	סטטוס הפעולה	OK
callbackList	string	הודעת הצלחה	OK

---

[שמואל]

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

---

הפקודה היא - GetIncomingSms

בכל פניה יש לצרף:

פרמטר	תיאור	הערות
token	טוקן
limit	הגבלת תוצאות	ברירת מחדל 100 תוצאות. מקסימום 3000.
startDate	מתאריך	למשל: 2025-06-01 19:48:01
endDate	עד תאריך	למשל: 2025-06-03 00:00:00

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

מאפיין	סוג	תיאור	דוגמה
responseStatus	string	סטטוס הפעולה	OK
rows	array	מערך סמסים שהתקבלו	יבואר מטה

מבנה סמס במערך rows

מאפיין	סוג	תיאור	דוגמה
source	string	מקור	972773137770
destination	string	יעד	972773137770
message	string	תוכן ההודעה	הודעת בדיקה
receive_date	string	תאריך קבלת ההודעה	2025-06-03 19:58:03

[שמואל]

ניהול/ביצוע אימות דו-שלבי

---

הפקודה היא - MFASession
השירות מאפשר לנהל כמה חלקים שקשורים לאימות הדו-שלבי, לבצע אימות דו שלבי בחיבור הנוכחי, לנהל שיטות התחברות, ועוד.

בכל פניה יש לצרף:

פרמטר	תיאור	סוג
token	טוקן	string
action	פעולה לביצוע	string

שימו לב: לא כל הפעולות אפשריות בכל שלב. יבואר בכל פעולה השלב שניתן לפנות אליה.

פעולות:

---

בדיקת האם הסשן עבר אימות דו-שלבי - isPass

הפעולה היא - isPass

כל סשן חייב להיות במצב ״pass״ של מנגנון האימות הדו-שלבי, אחרת עליו לבצע אימות דו-שלבי בפועל - לפני היכולת להשתמש עם כל שירות אחר בAPI. כאשר סשן לא עבר אימות דו שלבי - הוא יכול לגשת רק לשירות MFASession - וגם בו - לחלקים מסויימים. הדברים יבוארו בהמשך.

---

דרישה מקדימה לשימוש בשירות זה: אין.
מצב שבו השירות לא זמין: אין.

פירוט מענה:

מאפיין	סוג	הסבר	דוגמא	הערה
responseStatus	string	סטטוס הפעולה	OK
isAvailable	boolean	האם יש יכולת לבצע אימות דו-שלבי - מבחינת שיש שיטות אימות זמינות.	true	כאשר סשן לא עבר אימות - ואין אפשרות טכנית לאמת אותו - לא ניתן לבצע שום פעולות.
isPass	boolean	האם הסשן עבר אימות בהצלחה	true	לאחר שהסשן אומת - ישנם פעולות שלא ניתן לבצע בגלל זה, אבל ניתן להשתמש בסשן לטובת גישה לכל השירותים (שלא דורשים אימות קשיח - יבואר בהמשך).
passReason	string	סיבת מעבר מנגנון האימות הדו שלבי.	MFA_PASSED	ישנם הרבה סיבות למה הסשן עבר את מנגנון האימות הדו שלבי - ניתן לראות בטבלא את הסיבות האפשריות.
isPassInThisSession	boolean	האם הסשן עבר אימות בפועל בחיבור הנוכחי (אימות קשיח)	true	בהמשך לפרמטר מעלה - ישנם מצבים שבו הסשן ״עבר״ את מנגנון האימות הדו-שלבי - בגלל סיבות ש״פוטרות״ אותו מהצורך לבצע אימות דו שלבי בפועל - אבל לא בוצע ממש באותו הסשן אימות דו-שלבי. ישנם פעולות שדורשות ״אימות קשיח״ = רמה חזקה יותר של אימות - וזה דורש שיבוצע אימות דו-שלבי ממש באותו החיבור ממנו רוצים לגשת לשירותים האלה.

פירוט סיבות מעבר אימות:

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

סיבת מעבר	הסבר	הערה
INACTIVE_SYSTEM	מנוע האימות הדו שלבי לא פעיל או לא זמין
WAIT_TO_BLOCK_DATE	תאריך אכיפת השירות לא הגיע	במצב שבו מגדירים זמן מסויים ממנו חובה לעבור אימות דו שלבי - כל עוד הזמן לא הגיע - כל הסשנים עוברים ״בהצלחה״ במנגנון - כי תאריך אכיפת השירות לא הגיע.
INIT_WHITELIST_IPS	כתובת IP ברשימה לבנה	כתובת הIP שממנה בוצעה הבקשה למעבר - קיבלה אישור כי היא נמצאת ברשימה הלבנה.
INIT_MASTER_LOGIN_WHITELIST_IPS	כתובת IP ברשימה לבנה בהתחברות מאסטר	כתובת הIP שממנה בוצעה הבקשה למעבר - קיבלה אישור כי היא נמצאת ברשימה הלבנה כאשר מתבצע התחברות עם סיסמת מאסטר של ריסיילר.
HAVE_ACTIVE_TRUST_TOKEN	בוצע מעבר על ידי אסימון ״זכור אותי״
INHERITED_FROM_ORIGINAL_SESSION	ירושה מסשן קודם כל שהוא	למשל, בעת מעבר מהאתר ניהול הרגיל לממשק חיצוני - נוצר טוקן API שסיבת המעבר שלו היא שכבר בוצע מעבר בסשן קודם.
MFA_PASSED	בוצע אימות בפועל בחיבור הנוכחי	אין להסתמך על הסיבה בלבד בנושא ״אימות קשיח״ - אלא להסתמך על isPassInThisSession
SPECIAL_VALID_TOKEN	טוקן שנוצר עם פטור מאימות מסיבה מיוחדת

---

ניסיון ביצוע אימות - try

הפעולה היא - try

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

---

דרישה מקדימה לשימוש בשירות זה: אין.
מצב שבו השירות לא זמין: לאחר מעבר שקיבל החלטת ״עבר״ (isPass: true).

פירוט מענה (מענה זהה ל isPass - רק שהנתונים יהיו לאחר ביצוע ניסיון אימות):

ניסיונות מרובים לבצע מעבר ב try שלא יצליחו - כלומר שלא יהיה מעבר בהם - יובילו לחסימת המערכת כולה לעבור אימות דו שלבי.

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

---

קבלת שיטות אימות זמינות - getMFAMethods

הפעולה היא - getMFAMethods

פעולה זו יכולה להחזיר נתונים שונים לפני ואחרי ביצוע אימות קשיח.

---

דרישה מקדימה לשימוש בשירות זה: אין.
מצב שבו השירות לא זמין: אין.

פירוט מענה:

מענה זהה ל isPass - בתוספת מערךmfaMethods עם שיטות האימות הזמינות. להלן פירוט של אובייקט מתוך המערך:

מאפיין	סוג	הסבר	דוגמא	הערה
ID	int	מזהה שיטה	1	מזהה השיטה אינו קבוע - ונבנה בצורה דינמית בעת הבקשה. צריך לפנות איתו בשביל לבצע אימות - אבל אי אפשר להתסמך לאורך זמן שהוא יהיה אותו הדבר.
STATUS	string	סטטוס שיטת האימות	ACTIVE	שיטה יכולה להיות ACTIVE = פעילה, או PENDING = ממתינה. שיטה ממתינה לאימות לא יכולה לשמש לטובת ביצוע אימות קשיח. יש לאמת אותה קודם.
MFA_METHOD_ID	int	מזהה שיטה קבוע	6598	בניגוד לשדה ID - מזהה השיטה שפה הוא קבוע, אבל זה אומר שהוא נוסף בצורה יזומה - ולא מוצע בצורה אוטמאטית, ויתכן שיהיה ריק.
NIKE	string	תיאור מקור שיטת האימות	RESET_MAIL	יכול להיות: CREATE_PHONE = המספר שיצר את המערכת. RESET_MAIL המייל לשחזור. PROFILE הגיע מהפרופיל הקבוע. MASTER_LOGIN הגיע מהתחברות מאסטר של ריסיילר. BY_CUSTOMER נוסף על ידי הלקוח.
NOTE	string	תיאור חופשי שנכתב בעת הוספת השיטה	הטלפון בבית
SEND_TYPE	סוגי שליחות אפשריות	מערך של שיטות שליחת אימות אפשריות	["CALL","SMS"]	יכול להיות: CALL = בשיחה. SMS בהודעת סמס. EMAIL בהודעה למייל. ישנם שיטות שלא יהיה אפשרי לשלוח עבורם בצורה יזומה אימות, והמערך עבורם יהיה ריק.
VALUE	string	היעד של השיטה	+972773137770	כאשר לא בוצע אימות קשיח - היעד לא יוצג במלואו ויראה למשל: shmu•••@•••.co.il כאשר מספר ה• אינם משקפות את האורך האמיתי של הערך.
EXPIRED_DATE	string	זמן תפוגת השיטה	2025-09-28 12:11:38	שיטות שפגו תוקף - לא יוצגו אחרי זה בכלל, ויש להוסיף ולאמת אותם מחדש.
LAST_USED	string	הזמן האחרון שהשיטה אומתה בהצלחה	2025-09-28 12:11:38	שיטות שלא יבצעו אימות הרבה זמן - יתכן ולא יהיה זמינות בפועל או יוסרו.

---

שליחת אימות לטובת אימות קשיח/מעבר - sendMFA

הפעולה היא - sendMFA

שליחת אימות יכולה להיות רלוונטית כאשר רוצים לבצע אימות קשיח בסשן שעבר את המנגנון - או במקרה שהסשן לא עבר try וחייב לבצע אימות.

---

דרישה מקדימה לשימוש בשירות זה: אין.
מצב שבו השירות לא זמין: לאחר ביצוע אימות קשיח (isPassInThisSession: true).

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר
mfaId	מזהה שיטת האימות אליה רוצים לשלוח אימות	int
mfaSendType	סוג האימות הרצוי - מתוך SEND_TYPE	string
lang	שפת שליחת האימות.	string	HE או EN. ברירת מחדל ישלח בעברית.
autoOtpHostname	כתובת ה HOST_NAME שנמצאים בו לטובת הוספה שלו בסמס	string	מאפשר להשתמש עם OTPCredential בצד לקוח. רשות.

פירוט מענה:

כאשר responseStatus הוא OK השיחה/סמס/מייל - נשלחו.

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

{
    responseStatus: "Exception",
    message: "exception send by customer. wait 55s",
    file: "CustomerMFA.class.ym",
    Line: "590:19",
    yAfastVersion: "6.7.30"
}

כאשר בדוגמא מופיע wait 55s - 55 שניות.
כאמור, הזמן יכול לעלות למספרים גבוהים מאד באם מתבצעים נסיונות רבים.

---

ביצוע אימות בפועל לאחר שליחת אימות - validMFA

הפעולה היא - validMFA

---

דרישה מקדימה לשימוש בשירות זה: אין.
מצב שבו השירות לא זמין: לאחר ביצוע אימות קשיח (isPassInThisSession: true).

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הערה
mfaCode	קוד האימות שהתקבל	string
mfaRememberMe	יצירת אסימון ״זכור אותי״ בעת הצלחה	boolean	אסימון ״זכור אותי״ שנוצר ב API ייצור רק אסימון מסוג IP.
mfaRememberNote	תיאור לאסימון ״זכור אותי״ החדש.	string

פירוט מענה:

מאפיין	סוג	הסבר	דוגמא	הערה
responseStatus	string	סטטוס הפעולה	OK
mfa_valid_status	string	האם בוצע אימות.	VALID	יכול להיות UNVALIDאו VALID , או OVERTRY - שאומר שיש צורך לשלוח אימות חדש- כי עברו מספר הנסיונות האפשריים.
mfa_valid_trys	int	כמות הפעמים שבוצע ניסיון אימות קוד	1
mfa_valid_left	int	כמות הפעמים שנשארו לבצע ניסיון אימות לפני שהקוד לא רלוונטי	4
mfa_valid_message	string	הסבר מיוחד מדוע הקוד לא אומת.	validMFA not allow. over trys attempt

---

הוספת שיטת אימות חדשה - addMethod

הפעולה היא - addMethod

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	אופציות
mfaNewType	סוג שיטה	string	מייל - EMAIL או טלפון - PHONE
mtaNewValue	הערך של השיטה החדשה	string	המייל או הטלפון.
mtaNewValidNote	תיאור של השיטה החדשה	string	למטרות נוחות בלבד. לא חובה.
newExpiredDate	זמן תפוגה של השיטה	string	תאריך תפוגה בתבנית YYYY-MM-DD HH:mm:ss.

שימו לב:

• ניתן להוסיף עד 20 שיטות אימות
• ניתן להוסיף מספרי טלפון של המדינות הבאות: ישראל, ארה״ב, קנדה.

פירוט מענה:

כאשר responseStatus הוא OK השיטה נוספה כממתינה לאימות, כאשר בפרמטר methodId מצויין מזהה השיטה לטובת האימות שלה/מחיקה שלה בעתיד.

---

אימות או שליחת אימות חוזר של שיטת אימות חדשה - reValidMethod

הפעולה היא - reValidMethod

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר נוסף
mfaId	מזהה שיטת האימות	string	מתקבל כתגובה אחרי היצירה בפרמטר methodId, או בפרמטר MFA_METHOD_ID בפעולה getMFAMethods בתוך מערך mfaMethods כמו שהוסבר למעלה.
mfaSendType	סוג האימות הרצוי - מתוך SEND_TYPE	string
lang	שפת שליחת האימות.	string	HE או EN. ברירת מחדל ישלח בעברית.
autoOtpHostname	כתובת ה HOST_NAME שנמצאים בו לטובת הוספה שלו בסמס	string	מאפשר להשתמש עם OTPCredential בצד לקוח. רשות.

פירוט מענה:

כאשר responseStatus הוא OK הקוד לאימות נשלח.

---

ביצוע אימות של שיטה חדשה לאחר שליחת אימות - validMethod

הפעולה היא - validMethod

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר נוסף
mfaId	מזהה שיטת האימות	string	מתקבל כתגובה אחרי היצירה בפרמטר methodId, או בפרמטר MFA_METHOD_ID בפעולה getMFAMethods בתוך מערך mfaMethods כמו שהוסבר למעלה.
mfaCode	קוד האימות שהתקבל	string

פירוט מענה:

זהה לתגובת בקשה אימות בפועל - validMFA.

---

מחיקת שיטת אימות - deleteMethod

הפעולה היא - deleteMethod

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

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

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר נוסף
mfaId	מזהה שיטת האימות	string	מתקבל כתגובה אחרי היצירה בפרמטר methodId, או בפרמטר MFA_METHOD_ID בפעולה getMFAMethods בתוך מערך mfaMethods כמו שהוסבר למעלה.

פירוט מענה:

כאשר responseStatus הוא OK השיטה נמחקה.

---

קבלת אסימוני ״זכור אותי״ פעילים - getMFATrustTokens

הפעולה היא - getMFATrustTokens

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

פירוט מענה:

בפרמטר trustTokens יש מערך אסימונים, להלן המבנה:

מאפיין	סוג	הסבר	דוגמא	הערה
id	int	מזהה אסימון	1	משמש לטובת מחיקתו
trust_key_type	string	סוג אסימון	YM_CALL2ALL_WEBSITE	יכול להיות או YM_CALL2ALL_WEBSITE אסימון אימות של אתר הניהול. או CUSTOMER_IP אסימון כתובת IP.
create_by	string	נוצר על ידי	192.168.1.1
create_date	string	זמן יצירה	2025-09-28 21:56:52
update_by	string	עודכן על ידי	192.168.1.1	עדכון אסימון מתבצע כאשר מסמנים ״זכור אותי״ עם אסימון שכבר שמור.
update_date	string	זמן עדכון	null
last_use	string	זמן שימוש בפועל	null	כאשר מתבצע שימוש באסימון - ומעבר של המנוע בגללו - הזמן מתעדכן.
trust_note	string	הערת האסימון מזמן היצירה	המחשב שלי	פרמטר mfaRememberNote בבקשת validMFA.

---

מחיקת אסימון ״זכור אותי״ - deleteTrustToken

הפעולה היא - deleteTrustToken

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר נוסף
trustTokenId	מזהה האסימון	string	מתקבל בid בבקשת getMFATrustTokens.

פירוט מענה:

כאשר responseStatus הוא OK האסימון נמחקה.

---

קבלת כתובות IP לבנות - getMFATrustIps

הפעולה היא - getMFATrustIps

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

פירוט מענה:

בערך trustIps מערך כתובות IP לבנות.

---

שמירת כתובות IP לבנות - setMFATrustIps

הפעולה היא - setMFATrustIps

---

דרישה מקדימה לשימוש בשירות זה: לאחר ביצוע אימות קשיח (isPassInThisSession: true).
מצב שבו השירות לא זמין: אין

שימו לב: ניתן להוסיף עד 50 כתובות.
כתובת IP לבנה תעבור MFA עם סיבה INIT_WHITELIST_IPS כפי שהוסבר למעלה.
כתובת IP לבנה עדיין תצטרך לבצע אימות קשיח בשביל לקבל isPassInThisSession: true לטובת ביצוע פעולות רגישות.
ניתן להוסיף כתובות IPv4 או IPv6.

בכל פניה יש לצרף:

פרמטר	תיאור	סוג	הסבר נוסף
trustIps	רשימת כתובות IP	string/array	כאשר שולחים string ההפרדה תיהיה בין שורה לשורה. בשליחה מערך כל איבר זה כתובת.

פירוט מענה:

מאפיין	סוג	הסבר	דוגמא	הערה
responseStatus	string	סטטוס הפעולה	OK
okCount	int	מספר הכתובות שנוספו בהצלחה	1
save	boolean	האם בוצע שינוי בפועל	true	יהיה false אם הרשימה לא השתנתה.
valid_new_list	array	מערך הכתובות החדש
errors	array	מערך שגיאות	[ "ip: 0.192.66.2222 is not valid" ]