מבוא
ברוכים הבאים לקהילת המפתחים של ChatBot IL.
נקודות הקצה של ה־API של ChatBot IL מאפשרות לשלב את הפלטפורמה שלנו במערכות וביישומים חיצוניים, ולבצע אוטומציה של תהליכי ניהול, תקשורת ותפעול. מעבר לגישה לרשימות מנויים, עריכת פרופילים, עדכון ומחיקה של אנשי קשר, הממשק כולל גם יכולות נוספות לניהול משתמשים, חבילות, מודולים, תוספים, תוויות, קטלוגים ופעולות נוספות הקשורות לחשבון ולתקשורת ב־WhatsApp.
אימות וגישה ל־API
apiToken + שיטות קריאה
הגישה ל־API מתבצעת באמצעות apiToken, וברבות מנקודות הקצה ניתן לעבוד הן ב־GET והן ב־POST, בהתאם לצורך. בפעולות רבות הקשורות ל־WhatsApp יש לספק גם את מזהה מספר הטלפון של החשבון (phone_number_id), ובחלק מהקריאות יש להעביר גם את מספר הטלפון של איש הקשר עצמו.
ממשקי אנשי קשר (Contacts)
ניהול מתקדם ותפעול שוטף
ממשקי ה־API של אנשי הקשר ב־ChatBot IL אינם מוגבלים לצפייה או עריכה בסיסית בלבד. ניתן ליצור איש קשר חדש, לעדכן פרטים קיימים, למחוק איש קשר, לאפס עבורו את User Input Flow, לשייך את השיחה שלו לחבר צוות, לעדכן עבורו שדות מותאמים אישית בפורמט JSON, לשלוף רשימת שדות מותאמים אישית, להוסיף ולהסיר תוויות, לשייך ולהסיר רצפים, ואף להוסיף הערות לכרטיס איש הקשר. כך ניתן להשתמש באינטגרציה לא רק לסנכרון נתונים, אלא גם לניהול תפעולי שוטף מתוך מערכות חיצוניות.
WhatsApp ופעולות תקשורת
הודעות, תבניות, היסטוריה ו־Bot Flow
בנוסף לניהול אנשי קשר, ה־API מאפשר גם לשלוח הודעות WhatsApp, לשלוח הודעות תבנית, לשלוף היסטוריית שיחה של איש קשר מסוים, לקבל רשימות Postback, ולהפעיל Bot Flow ישירות למספר טלפון מוגדר. יכולות אלו הופכות את האינטגרציה לשימושית במיוחד עבור מערכות שירות, אוטומציה, אימות משתמשים, תהליכי מכירה וניהול תקשורת רב־ערוצית.
רשימות אנשי קשר – פרמטרים לדפדוף ומיון
limit / offset / orderBy
רשימת אנשי הקשר תומכת בפרמטרים limit ו־offset לצורך דפדוף בתוצאות, וכן בפרמטר orderBy שמאפשר למיין את הרשימה לפי ההודעה האחרונה של איש הקשר, כך שהשיחות העדכניות ביותר יופיעו ראשונות. זה שימושי במיוחד בחיבורים למערכות CRM, מסכי שירות וממשקי ניטור פנימיים.
פורמטים ושמות פרמטרים – חשוב לשים לב
פורמט מספר הטלפון
בעת יצירת איש קשר חדש, יש להזין את מספר הטלפון עם קידומת מדינה וללא הסימן +. גם בפעולות כמו מחיקת איש קשר או הפעלת Bot Flow, מספר הטלפון חייב להיות בפורמט מספרי בלבד ולהתחיל בקידומת המדינה. חשוב לשים לב שבחלק מנקודות הקצה שמות הפרמטרים מופיעים בפורמט phone_number_id ו־phone_number, בעוד שבאחרות מופיעים phoneNumberID ו־phoneNumber, ולכן יש לעבוד בדיוק לפי הפרמטרים של נקודת הקצה הרלוונטית.
סיכום
מה זה מאפשר למפתחים
באמצעות אינטגרציית API זו, מפתחים יכולים לבנות חיבורים אמינים בין ChatBot IL לבין מערכות פנימיות, כלי ניהול לקוחות, מערכות אימות, תהליכי אוטומציה ושירותים עסקיים נוספים – ובכך לייעל את ניהול אנשי הקשר, לשפר את חוויית המשתמש ולהרחיב משמעותית את יכולות ההפעלה של הפלטפורמה.
מדריך: שליחת OTP באמצעות API
שלב 1: קבלת גישה ל־API ולמפתחות
היכנסו ללוח הבקרה האישי של ChatBot IL ועברו לתפריט API developer.
העתיקו את מפתח ה־API שלכם (API Key) שמוצג באזור זה.
באותו מסך תוכלו לראות גם את נקודות הקצה הזמינות של ה־API (API Endpoints), למשל לשליחת הודעות באמצעות Send API.
שלב 2: בחירת סוג ההודעה
לשליחת קודי OTP מומלץ להשתמש ב־Template Message (הודעת תבנית).
בניגוד להודעת טקסט רגילה, תבנית מאפשרת לשלוח הודעה למשתמש גם אם הוא לא יצר אינטראקציה עם הבוט שלכם ב־24 השעות האחרונות.
שלב 3: יצירת תבנית הודעה
עברו אל Bot Manager -> Template Message.
לחצו על Create כדי ליצור תבנית חדשה.
הגדירו שם לתבנית, לדוגמה: new_OTP.
בחרו בקטגוריה OTP.
בתוכן ההודעה כתבו את נוסח ההודעה והוסיפו משתנה עבור הקוד עצמו, לדוגמה: קוד האימות שלך: {{1}}. תודה.
באמצעות המשתנה ניתן לשלוח קוד שונה לכל משתמש.
לאחר השמירה, לחצו על Check Status.
התבנית חייבת להיות במצב Approved לפני שניתן יהיה להשתמש בה בפועל.
שלב 4: הכנת סקריפט PHP
חזרו לסעיף API developer, בחרו את חשבון ה־WhatsApp הרצוי והעתיקו את כתובת ה־URL של נקודת הקצה שסופקה לכם (API Endpoint URL).
צרו בשרת שלכם קובץ PHP, לדוגמה: send_otp.php.
השתמשו בספריית cURL כדי לבנות בקשת POST לצורך שליחת הודעת ה־OTP.
שלב 5: הגדרת הפרמטרים בקוד
בסקריפט ה־PHP יש להגדיר את המשתנים הבאים:
API Token הטוקן הייחודי שלכם.
Phone Number ID – המזהה של מספר הטלפון המחובר לחשבון שלכם.
Template Variable – ערך קוד ה־OTP שיושתל בתבנית.
Phone Number – מספר הנמען.
חשוב: יש לציין את מספר הטלפון עם קידומת המדינה, ללא הסימן + וללא רווחים או תווים נוספים – ספרות בלבד.
שלב 6: הפעלה ובדיקה
הפעילו את סקריפט ה־PHP שיצרתם דרך הדפדפן או דרך שורת הפקודה.
במקרה של הצלחה, השרת יחזיר תשובה המאשרת שהשליחה בוצעה בהצלחה, וההודעה תישלח למספר ה־WhatsApp שהוגדר.
