מיקרופיי · מרכז מפתחים מרכז מפתחים · רשימת תבניות וואטסאפ

API לשליפת רשימת תבניות וואטסאפ

עודכן לאחרונה: 19 באוקטובר 2026 · נתמך ב-HTTP GET, POST ו-JSON

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

כתובת הממשק
/extApi/waTemplates.php
שיטות נתמכות
HTTP GET · POST · JSON
אימות
טוקן עם הרשאת שירותי וואטסאפ
תשובה
תמיד JSON, קריאה בלבד

סקירת הממשק

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

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

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

כתובת הממשק ושיטת השליחה

הכתובת לפנייה לממשק היא:

Endpoint 
https://www.micropay.co.il/extApi/waTemplates.php

לכתובת זו מוסיפים את הפרמטרים המתאימים. יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.

אימות וטוקן

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

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

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

פרמטרים

פרמטרחובהתיאור
tokenחובהטוקן הזדהות שיצרת במערכת, עם הרשאת שירותי וואטסאפ.
templateרשותקוד של תבנית אחת. כשהוא נשלח, מוחזרת רק התבנית הזו. קוד שאינו קיים בחשבון מחזיר שגיאה.
statusרשותסינון לפי סטטוס התבנית במטא: APPROVED (מאושרת), PENDING (ממתינה לאישור), REJECTED (נדחתה), PAUSED (הושהתה), DISABLED (הושבתה), FLAGGED (סומנה לבדיקה), PENDING_DELETION (בתהליך מחיקה). ללא הפרמטר מוחזרות תבניות בכל הסטטוסים. אפשר לשלוח את הערך באותיות גדולות או קטנות.
categoryרשותסינון לפי קטגוריה: MARKETING (שיווק), UTILITY (שירות), AUTHENTICATION (קוד אימות). אפשר לשלוח את הערך באותיות גדולות או קטנות.
get / postחובהמציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. (בפורמט JSON אין צורך בפרמטר זה.)

דוגמאות קוד

בסיסי · HTTP GET 
curl "https://www.micropay.co.il/extApi/waTemplates.php?get=1&token=XXXXX"
בסיסי · JSON 
curl -X POST https://www.micropay.co.il/extApi/waTemplates.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX"}'
מלא · JSON 
curl -X POST https://www.micropay.co.il/extApi/waTemplates.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","template":"4821","status":"APPROVED","category":"UTILITY"}'

תשובת השרת

התשובה תמיד ב-JSON, גם בקריאת GET או POST רגילה, מפני שרשימת תבניות אינה ניתנת לייצוג בתשובת טקסט של שורה אחת. המעטפת זהה לשאר הממשקים (ראו מוסכמות ופורמט תשובה), והרשימה נמצאת ב-data.templates. חשבון ללא תבניות, או סינון שלא מצא דבר, מחזיר הצלחה עם רשימה ריקה.

JSON 
{
  "status": 1,
  "action": "listtemplates",
  "message": "OK",
  "data": {
    "count": 1,
    "templates": [
      {
        "code": 4821,
        "displayName": "משלוח יצא",
        "status": "APPROVED",
        "sendable": true,
        "issue": null,
        "category": "UTILITY",
        "language": "he",
        "qualityScore": "GREEN",
        "updated": "2026-10-12 14:03:11",
        "header": {
          "type": "IMAGE",
          "text": "",
          "fileurlTypes": ["jpg", "jpeg", "png"],
          "hasDefaultMedia": true,
          "defaultMediaUrl": "https://www.micropay.co.il/files/WaOutMedia/4821-header.jpg"
        },
        "body": "שלום {{1}}, ההזמנה {{2}} יצאה לדרך.",
        "footer": "צוות החנות",
        "buttons": [
          {"type": "QUICK_REPLY", "text": "תודה", "url": "", "dynamic": false},
          {"type": "URL", "text": "מעקב משלוח", "url": "https://example.com/track/{{1}}", "dynamic": true}
        ],
        "params": {
          "body": [{"index": 1, "example": "דני"}, {"index": 2, "example": "A123"}],
          "header": [],
          "button": [{"index": 1, "example": "A123", "buttonText": "מעקב משלוח"}]
        },
        "simpleParamsAllowed": false,
        "paramsExample": {"body": {"1": "דני", "2": "A123"}, "button": {"1": "A123"}},
        "otp": null
      }
    ],
    "remoteIP": "203.0.113.10"
  }
}

שדות התבנית

שדהמשמעות
codeקוד התבנית. זה הערך שיש לשלוח בפרמטר template בממשק שליחת תבניות וואטסאפ, והוא מופיע גם במערכת בעמודה "קוד תבנית".
displayNameהשם של התבנית במערכת מיקרופיי. ניתן לשנות אותו בעמוד ניהול התבניות. אם לא הוגדר שם במערכת, מוחזר השם שהוגדר לתבנית במטא.
statusסטטוס התבנית במטא, אחד הערכים שמפורטים בפרמטר status למעלה.
sendabletrue כשאפשר לשלוח את התבנית עכשיו: היא מאושרת ונתוניה במערכת תקינים.
issuenull כשאין בעיה. הערך needs_resync אומר שנתוני התבנית במערכת חסרים או לא מעודכנים. במצב כזה המשתמש הראשי בחשבון צריך ללחוץ על "סנכרון מול מטא" בעמוד הגדרות חשבון וואטסאפ, וממשק השליחה יסרב לשלוח את התבנית עד אז.
categoryקטגוריית התבנית: MARKETING, UTILITY או AUTHENTICATION.
languageקוד השפה של התבנית, למשל he לעברית או en לאנגלית. ממשק השליחה משתמש בו אוטומטית ואין צורך לשלוח אותו.
qualityScoreדירוג האיכות של התבנית במטא לפי משובים שליליים מנמענים: GREEN, YELLOW, RED, או UNKNOWN כשאין עדיין דירוג.
updatedמועד העדכון האחרון של התבנית, בפורמט YYYY-MM-DD HH:MM:SS לפי שעון ישראל. כשמטא לא דיווחה על מועד עדכון, מוחזר המועד שבו התבנית נוספה למערכת.
headerכותרת התבנית. ראו כותרת עם קובץ.
bodyטקסט גוף ההודעה, עם מקומות הפרמטרים {{1}}, {{2}} וכן הלאה.
footerטקסט התחתית, או מחרוזת ריקה כשאין.
buttonsהכפתורים בתבנית, לפי הסדר. לכל כפתור: type (למשל QUICK_REPLY, URL, PHONE_NUMBER), text, url לכפתור קישור, ו-dynamic שהוא true כשסוף הקישור משתנה בכל שליחה ודורש פרמטר.
paramsהפרמטרים שחובה לשלוח, בחלוקה לגוף (body), כותרת (header) וכפתורים (button). ראו הפרמטרים לשליחה.
simpleParamsAllowedtrue כשאפשר לשלוח את הפרמטרים כרשימה פשוטה מופרדת בפסיקים. false כשחובה להשתמש בצורת ה-JSON.
paramsExampleערך מוכן לפרמטר params בממשק השליחה, בנוי מהדוגמאות שהוגשו למטא באישור התבנית. כשהדוגמה של כפתור אינה ערך שאפשר לשלוח, מוחזר במקומה ABC123. null כשלתבנית אין פרמטרים.
otpרק בתבנית קוד אימות (AUTHENTICATION), אחרת null. ראו תבנית קוד אימות.

הפרמטרים לשליחה

כל פריט ב-params הוא פרמטר שחובה לשלוח, עם index ו-example:

איך משתמשים בתשובה כדי לשלוח

1 בחר תבנית עם "sendable": true, ושלח את ה-code שלה בפרמטר template.
2 העתק את paramsExample, החלף את ערכי הדוגמה בערכים האמיתיים, ושלח אותו בפרמטר params.
3 אם simpleParamsAllowed הוא true, אפשר במקום זאת לשלוח רשימה פשוטה של ערכי הגוף לפי הסדר. למשל, לתבנית עם שני פרמטרים בגוף ההודעה וללא כפתור דינמי: params=Dana,1234. בתבנית שבדוגמה למעלה זה לא אפשרי, כי יש לה כפתור דינמי.
4 אם לכותרת יש קובץ, אפשר להשאיר את קובץ ברירת המחדל או להחליף אותו לשליחה הזו בפרמטר fileurl.
פרמטר בכותרת או בכפתור מחייב את צורת ה-JSON. רשימה פשוטה ממלאת רק את גוף ההודעה. לכן כש-simpleParamsAllowed הוא false, רשימה פשוטה תחזיר שגיאה על פרמטר חסר.

header.type הוא אחד מהערכים: NONE (אין כותרת), TEXT (טקסט, שמופיע ב-header.text), IMAGE (תמונה), VIDEO (סרטון) או DOCUMENT (מסמך).

שדהמשמעות
fileurlTypesסוגי הקבצים שאפשר לשלוח בפרמטר fileurl לתבנית הזו. רשימה ריקה כשהכותרת היא טקסט או שאין כותרת, ואז אסור לשלוח fileurl.
hasDefaultMediatrue כשלתבנית שמור קובץ ברירת מחדל, שיישלח כשלא מעבירים fileurl.
defaultMediaUrlהכתובת של קובץ ברירת המחדל, לתצוגה מקדימה. מחרוזת ריקה כשאין קובץ.

תבנית קוד אימות

בתבנית בקטגוריית AUTHENTICATION הפרמטר {{1}} בגוף ההודעה הוא תמיד קוד האימות, והוא מופיע ב-params.body גם כשלא הוגדר בטקסט. את הקוד שולחים פעם אחת, והמערכת מצמידה אותו גם לכפתור העתקת הקוד. השדה otp כולל:

שדהמשמעות
codeParamהיכן שולחים את הקוד: body.1, כלומר הפרמטר הראשון בגוף ההודעה.
expirationMinutesתוקף הקוד בדקות, כפי שמוצג לנמען בתחתית ההודעה. 0 כשלא הוגדר.
securityRecommendationtrue כשמטא מוסיפה להודעה את המשפט "אין לשתף את הקוד".
buttonTextטקסט כפתור העתקת הקוד, כשמטא מחזירה אותו בנפרד. לרוב הכפתור מופיע גם ברשימת buttons, עם dynamic שווה false: אין לשלוח לו פרמטר, והמערכת מצרפת אליו אוטומטית את אותו קוד שנשלח בגוף ההודעה.

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

שגיאות נפוצות

תיאור השגיאההסיבה
token parameter is required / token parameter is not validהטוקן חסר או אינו קיים.
user permission denied, please check token permissions (whatsapp)לטוקן אין הרשאת שירותי וואטסאפ.
your IP is blockedלטוקן הוגדרה רשימת כתובות IP מורשות, והקריאה הגיעה מכתובת אחרת.
the account is not activeהחשבון במיקרופיי סגור או מוקפא. יש לפנות לתמיכה.
subuser whatsapp permission deniedלתת המנהל של הטוקן אין הרשאה לשלוח הודעות וואטסאפ.
whatsapp is not configured for this accountלא חובר חשבון וואטסאפ עסקי לחשבון במיקרופיי.
template parameter is invalid (template code)הפרמטר template אינו מספר תקין.
template not found (code N)אין בחשבון תבנית עם הקוד הזה.
no template matches code N with the given status/category filterנשלח template יחד עם status או category, והתבנית אינה עומדת בסינון, או שאינה קיימת בחשבון.
status parameter is invalid (allowed: ...)ערך status שאינו ברשימה. בסוגריים מופיעים הערכים המותרים.
category parameter is invalid (allowed: ...)ערך category שאינו ברשימה.
you must send one of the following: get=1 or post=2בשליחה רגילה לא נשלח get=1 או post=2.
invalid JSON bodyגוף הבקשה בפורמט JSON אינו JSON תקין. בשגיאה הזו התשובה אינה כוללת את השדה action.
get subuser data errorתת המנהל של הטוקן אינו פעיל או שנמחק.
no ipלא ניתן היה לזהות את כתובת ה-IP של הקריאה. יש לפנות לתמיכה.
system error, please contact supportתקלה זמנית במערכת. אפשר לנסות שוב בעוד כמה דקות, ואם התקלה נמשכת יש לפנות לתמיכה.

בשגיאה status הוא 0, message הוא ERROR, והתיאור נמצא ב-data.description:

JSON 
{"status":0,"action":"listtemplates","message":"ERROR","data":{"remoteIP":"203.0.113.10","description":"template not found (code 4821)"}}

שאלות נפוצות

איך יודעים אילו פרמטרים לשלוח לכל תבנית וואטסאפ?

קוראים לכתובת /extApi/waTemplates.php עם טוקן בעל הרשאת שירותי וואטסאפ. לכל תבנית בתשובה יש שדה params שמפרט את הפרמטרים הנדרשים בגוף ההודעה, בכותרת ובכפתורים, ושדה paramsExample שהוא ערך מוכן לפרמטר params בממשק שליחת התבניות. מחליפים את ערכי הדוגמה בערכים האמיתיים ושולחים.

האם הממשק מאפשר ליצור או לשנות תבניות?

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

למה תבנית מופיעה ברשימה עם sendable שווה false?

אפשר לשלוח רק תבנית בסטטוס APPROVED, כלומר תבנית שמטא אישרה. תבנית בהמתנה, שנדחתה או שהושהתה מופיעה ברשימה עם sendable שווה false. גם תבנית מאושרת מקבלת sendable שווה false כשמופיע issue עם הערך needs_resync, כלומר נתוני התבנית במערכת אינם מעודכנים. כדי לעדכן אותם, המשתמש הראשי בחשבון לוחץ על "סנכרון מול מטא" בעמוד הגדרות חשבון וואטסאפ.

באיזה פורמט מוחזרת התשובה?

תמיד ב-JSON, גם בקריאת GET או POST רגילה, מפני שרשימת תבניות אינה ניתנת לייצוג בתשובת טקסט של שורה אחת. מבנה המעטפת זהה לשאר הממשקים: status, action, message ו-data, והרשימה עצמה נמצאת ב-data.templates.

ממשקים קשורים

שליחת תבניות וואטסאפוואטסאפ בטקסט חופשיOTP וקוד אימותסטטוס הודעות וואטסאפמוסכמות ופורמט תשובהאימות וטוקנים
רוצה לשלוח תבניות וואטסאפ ישירות מהמערכת שלך?
פתח חשבון, חבר מספר וואטסאפ עסקי והרץ את הדוגמה הראשונה
פתח חשבון חינם