Documentation
Table of Contents
> עצם סוג מדיה
העצמים הבאים קשורים ישירות ל־API mediatype.
סוג המדיה
לאובייקט סוג המדיה יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| mediatypeid | string | (לקריאה בלבד) מזהה סוג המדיה. |
| שם (חובה) |
מחרוזת | שם של סוג המדיה. |
| סוג (נדרש) |
מספר שלם | תחבורה המשמשת את סוג המדיה. ערכים אפשריים: 0 - אימייל; 1 - סקריפט; 2 - SMS; 4 - Webhook. |
| exec_path | string | עבור סוגי מדיה של סקריפט exec_path מכיל את שם הסקריפט המבוצע.נדרש עבור סוגי מדיה של סקריפט. |
| gsm_modem | string | שם ההתקן הסדרתי של מודם GSM. נדרש עבור סוגי מדיה של SMS. |
| passwd | string | סיסמת אימות. משמשת עבור סוגי מדיה בדוא"ל. |
| smtp_email | string | כתובת דוא"ל שממנה יישלחו הודעות. נדרש עבור סוגי מדיה בדוא"ל. |
| smtp_helo | string | SMTP HELO. נדרש עבור סוגי מדיה בדוא"ל. |
| smtp_server | string | שרת SMTP. נדרש עבור סוגי מדיה דוא"ל. |
| smtp_port | integer | יציאת שרת SMTP לחיבור. |
| smtp_security | integer | רמת אבטחת חיבור SMTP לשימוש. ערכים אפשריים: 0 - אין; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL לאמת מארח עבור SMTP. ערכים אפשריים: 0 - לא; 1 - כן. |
| smtp_verify_peer | integer | SSL אימות עמית עבור SMTP. ערכים אפשריים: 0 - לא; 1 - כן. |
| smtp_authentication | integer | שיטת אימות SMTP לשימוש. ערכים אפשריים: 0 - אין; 1 - סיסמה רגילה. |
| status | integer | האם סוג המדיה מופעל. ערכים אפשריים: 0 - (ברירת מחדל) מופעל; 1 - מושבת. |
| username | string | שם משתמש. משמש עבור סוגי מדיה בדוא"ל. |
| exec_params | string | פרמטרים של סקריפט. כל פרמטר מסתיים בהזנת שורה חדשה. |
| maxsessions | integer | המספר המרבי של התראות שניתן לעבד במקביל. ערכים אפשריים עבור SMS: 1 - (ברירת מחדל) ערכים אפשריים עבור סוגי מדיה אחרים : 0-100 |
| maxattempts | integer | המספר המרבי של ניסיונות לשלוח התראה. ערכים אפשריים: 1-100 ערך ברירת מחדל: 3 |
| attempt_interval | string | המרווח בין ניסיונות ניסיון חוזר. מקבל שניות ויחידת זמן עם סיומת. ערכים אפשריים: 0-1h ערך ברירת מחדל: 10s |
| content_type | integer | פורמט הודעה. ערכים אפשריים: 0 - טקסט רגיל; 1 - (ברירת מחדל) html. |
| script | string | סוג מדיה webhook script javascript body. |
| timeout | string | תפוגה של סקריפט webhook מסוג מדיה. מקבל שניות ויחידת זמן עם סיומת. ערכים אפשריים: 1-60 שניות ערך ברירת מחדל: 30 שניות |
| process_tags | integer | מגדיר האם תגובת הסקריפט של webhook תתפרש כתגים ויש להוסיף תגים אלו לאירוע המשויך. ערכים אפשריים: 0 - (ברירת מחדל) התעלם מסקריפט webhook תגובה. 1 - עבד את תגובת הסקריפט של webhook כתגים. |
| show_event_menu | integer | הצג את רשומת סוג המדיה במאפיין problem.get ו-event.get urls.ערכים אפשריים: 0 - (ברירת מחדל) Do לא להוסיף את רשומת כתובות אתרים.1 - הוסף סוג מדיה למאפיין כתובות אתרים. |
| event_menu_url | string | הגדר את מאפיין url של הזנת סוג מדיה במאפיין urls של problem.get ו-event.get. |
| event_menu_name | string | הגדר את מאפיין name של הזנת סוג מדיה במאפיין urls של problem.get ו-event.get. |
| parameters | מערך | מערך של פרמטרי קלט webhook. |
| description | string | תיאור סוג מדיה. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
פרמטרים של Webhook
לפרמטרים שהועברו לסקריפט webhook כאשר הוא נקרא, יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| שם (חובה) |
מחרוזת | שם הפרמטר. |
| value | string | ערך פרמטר, תומך בפקודות מאקרו. פקודות מאקרו נתמכות מתוארות בדף פקודות מאקרו נתמכות. |
Script parameters
Parameters passed to a script when it is being called have the following properties.
| Property | Type | Description |
|---|---|---|
| sortorder (required) |
integer | The order in which the parameters will be passed to the script as command-line arguments. Starting with 0 as the first one. |
| value | string | Parameter value, supports macros. Supported macros are described on the Supported macros page. |
תבנית הודעה
אובייקט תבנית ההודעה מגדיר תבנית שתשמש כ הודעת ברירת מחדל עבור פעולות פעולה לשליחת התראה. יש לו את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| מקור אירוע (נדרש) |
מספר שלם | מקור אירוע. ערכים אפשריים: 0 - טריגרים; 1 - גילוי; 2 - רישום אוטומטי;<br >3 - פנימי; 4 - שירותים. |
| שחזור (נדרש) |
מספר שלם | מצב פעולה. ערכים אפשריים: 0 - פעולות; 1 - פעולות שחזור; 2 - פעולות עדכון. |
| subject | string | נושא ההודעה. |
| message | string | טקסט הודעה. |