דלג לתוכן הראשי

הודעות קוליות (Prompts)

services לניהול קבצי ההודעות הקוליות של החשבון: ההודעות המוקראות בתחילת שיחה, בסיומה, בתפריטי ה-IVR ועוד.

get_prompts_list​

החזרת רשימת כל ההודעות הקוליות הקיימות בחשבון.

Endpoint: /api/?service=get_prompts_list

פרמטרים​

פרמטרסוגחובהתיאור
formatstringלאjson / xml.

שדות בתגובה​

name, create_date, size, length.

קוד שגיאה​

קודתיאור
9041אין הודעות קוליות בחשבון

download_prompt​

הורדת קובץ הודעה קולית.

Endpoint: /api/?service=download_prompt

פרמטרים​

פרמטרסוגחובהתיאור
prompt_namestringכןשם ההודעה (כפי שמוחזר מ-get_prompts_list).
formatstringלאjson / xml (רלוונטי רק למצבי שגיאה).

קודי שגיאה​

קודתיאור
9011prompt_name חסר
9012אין הודעה בשם זה

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     -o greeting.wav \
     "https://[MASKYOO_URL]/api/?service=download_prompt&prompt_name=greeting_welcome"

upload_prompt​

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

Endpoint: /api/?service=upload_prompt (דורש multipart/form-data)

פרמטרים​

פרמטרסוגחובהתיאור
prompt_filefileכןקובץ השמע להעלאה.
file_namestringלאשם שמור מבוקש (ברירת מחדל: שם הקובץ המקורי). שם ההודעה יעבור נרמול לאותיות אנגליות קטנות, ספרות, מקפים וקווים תחתונים.
formatstringלאjson / xml.

מגבלות​

  • גודל מקסימלי: 50 MB.
  • נתמכים פורמטי שמע נפוצים (WAV, MP3, AAC, FLAC, OGG, M4A, AMR, OPUS ועוד).
  • שם ההודעה חייב להיות ייחודי בחשבון.

קודי שגיאה​

קודתיאור
9021קובץ לא סופק / ריק
9022הודעה באותו שם כבר קיימת
9023סוג הקובץ אינו נתמך
9024הקובץ גדול מהמותר
9025עיבוד הקובץ נכשל

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=upload_prompt" \
     -F "prompt_file=@/path/to/greeting.mp3" \
     -F "file_name=welcome_greeting" \
     -F "format=json"

תגובה​

{
  "service": "upload_prompt",
  "status": {
    "code": 200,
    "description": "prompt `welcome_greeting` been added to the system",
    "prompt_name": "welcome_greeting"
  }
}

delete_prompt​

מחיקת הודעה קולית מהחשבון.

Endpoint: /api/?service=delete_prompt

פרמטרים​

פרמטרסוגחובהתיאור
prompt_namestringכןשם ההודעה למחיקה.
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
9031prompt_name חסר
9032ההודעה לא קיימת
9033המחיקה נכשלה

recording_studio​

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

Endpoint: /api/?service=recording_studio

פרמטרים​

פרמטרסוגחובהתיאור
destinationstringכןמספר הטלפון אליו תצא השיחה להקלטה.
formatstringלאjson / xml.

קוד שגיאה​

קודתיאור
9026destination ריק / לא תקין

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=recording_studio" \
     -d "destination=972544224422" \
     -d "format=json"

השפעות על המערכת​

ניהול הודעות קוליות דרך ה‑API מחובר ישירות לעולם ה‑IVR:

  • זמינות מיידית — קובץ שהועלה דרך upload_prompt זמין מיד ב‑IVR Studio ובהגדרות מסקיו תחת greeting_in/greeting_out/ringback_tone
  • מחיקת קובץ פעיל — מחיקה של prompt שמשמש רכיב IVR פעיל תגרום לכשל בשיחה בזמן ריצה
  • נרמול שם — שם ההודעה מנורמל לאותיות אנגליות קטנות, ספרות, מקפים וקווים תחתונים; חובה שם ייחודי בחשבון
  • גודל ופורמט — עד 50 MB; פורמטים נתמכים: WAV, MP3, AAC, FLAC, OGG, M4A, AMR, OPUS; המערכת ממירה אוטומטית לפורמט פנימי
  • אולפן הקלטה — recording_studio מחייג אל המספר שסופק ויוצר שיחה חיה; ההקלטה נשמרת אוטומטית בחשבון כ‑prompt

ראו גם​