Your AI Connector Docs

ערוצים מותאמים אישית

חברו כל פלטפורמת הודעות או כלי תקשורת לפלטפורמה באמצעות ערוצים מותאמים אישית. זה מאפשר לכם להביא הודעות מפלטפורמות כמו ווידג’טים של צ’אט חי באתר, מערכות דוא"ל, מערכות CRM או כל שירות אחר אל תיבת הדואר הנכנס שלכם — ולהשיב להן באמצעות סוכן ה-AI שלכם.


מהם ערוצים מותאמים אישית?

ערוצים מותאמים אישית מרחיבים את הפלטפורמה מעבר לפלטפורמות ההודעות המובנות שלה (WhatsApp, SMS, Instagram, Messenger). בעזרת ערוצים מותאמים אישית, תוכלו:

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

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

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


איך זה עובד

ערוצים מותאמים אישית פועלים על ידי העברת הודעות הלוך ושוב בין הפלטפורמה החיצונית שלכם לבין הפלטפורמה באמצעות webhooks (הודעות אוטומטיות שנשלחות בין מערכות דרך האינטרנט). להלן התהליך:

Your Platform  ──(sends message to)──>  The App
                                           |
                                       AI Agent responds
                                       Contact saved
                                       Message stored
                                           |
The App  ──(sends reply to)──>  Your Platform
  1. הודעות נכנסות: הפלטפורמה החיצונית שלכם שולחת הודעות לכתובת אינטרנט (URL). חשבו על זה כעל הפלטפורמה שלכם “מפרסמת” הודעה בתיבת הדואר של הפלטפורמה.
  2. עיבוד: הפלטפורמה יוצרת או מעדכנת את איש הקשר, שומרת את ההודעה וגורמת לסוכן ה-AI ליצור תגובה (אם הוא פעיל).
  3. הודעות יוצאות: כאשר הפלטפורמה שולחת תשובה (בין אם מה-AI או כזו שהוקלדה על ידכם), היא שולחת את ההודעה ל-URL בפלטפורמה שלכם, שם המערכת שלכם יכולה להעביר אותה למשתמש הקצה.

הגדרת הודעות נכנסות (מהפלטפורמה שלכם לאפליקציה)

כדי לשלוח הודעות מהפלטפורמה החיצונית שלכם אל האפליקציה, הפלטפורמה שלכם צריכה לשלוח נתונים ל-URL הבא. המפתח שלכם יזהה זאת כבקשת POST סטנדרטית (דרך נפוצה של מערכת אחת לשלוח נתונים לאחרת דרך האינטרנט).

לאן לשלוח הודעות

POST https://api.youraiconnector.com/v1/incoming_custom_channel_message?apiKey=YOUR_API_KEY

החליפו את YOUR_API_KEY במפתח ה-API שלכם (קוד פרטי שמוכיח לפלטפורמה שהפלטפורמה שלכם מורשית לשלוח לה הודעות). מצאו או צרו אותו תחת הגדרות → אינטגרציות → מפתח API.

פורמט ההודעה

שלח את נתוני ההודעה בפורמט הבא (JSON):

{
  "customData": {
    "messageSid": "unique-message-id-123",
    "fromId": "user-456",
    "toId": "your-business-id",
    "body": "Hello, I have a question about your service.",
    "status": "received",
    "channel": "my-live-chat",
    "campaignId": "optional-campaign-id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "mediaUrl": null,
    "mediaContentType": null
  },
  "messageType": "text"
}

מה המשמעות של כל חלק:

  • messageSid - מזהה ייחודי עבור הודעה ספציפית זו (המערכת שלך יוצרת אותו). משמש למניעת עיבוד של אותה הודעה פעמיים.
  • fromId - מי שלח את ההודעה (יכול להיות מזהה משתמש, אימייל או מספר טלפון מהמערכת שלך).
  • toId - מזהה העסק שלך (יכול להיות כל תווית שתבחר).
  • body - טקסט ההודעה עצמו.
  • channel - תווית שתבחר כדי לזהות מאיפה הגיעה ההודעה (למשל, “website-chat”, “email”).

התייחסות מלאה לשדות

שדה נדרש? מה הוא עושה
customData.messageSid או customData.id כן מזהה ייחודי להודעה זו (מונע כפילויות)
customData.fromId כן מזהה מי שלח את ההודעה (למשל, מזהה משתמש, דוא"ל או מספר טלפון מהמערכת שלכם)
customData.toId כן מזהה את הצד המקבל (העסק שלכם). יכול להיות כל טקסט שתבחרו.
customData.body כן טקסט ההודעה עצמו. לא יכול להיות ריק.
customData.status לא סטטוס הודעה. השאירו ריק כדי להשתמש בברירת המחדל ("received").
customData.channel לא תווית למקור (למשל, "live-chat", "email", "my-crm"). עוזר לכם לזהות מאיפה הגיעו הודעות בתיבת הדואר הנכנס.
customData.campaignId לא מזהה קמפיין/סוכן. השתמשו בזה כדי לנתב את ההודעה להגדרת AI ספציפית.
customData.firstName לא שם פרטי של איש הקשר. נכלל בעת יצירת רשומת איש קשר חדשה.
customData.lastName לא שם משפחה של איש הקשר. נכלל בעת יצירת רשומת איש קשר חדשה.
customData.email לא כתובת דוא"ל של איש הקשר. נכלל בעת יצירת רשומת איש קשר חדשה.
customData.mediaUrl לא קישור לקובץ מצורף (תמונה, וידאו, אודיו או מסמך). יכול להיות גם קובץ מקודד ב-base64 (ראו להלן).
customData.mediaContentType לא סוג הקובץ (למשל, "image/jpeg", "video/mp4", "audio/ogg", "application/pdf"). נדרש אם אתם כוללים את mediaUrl.
messageType לא סוג הודעה. השאירו ריק עבור טקסט רגיל. הגדירו ל-"reaction" עבור תגובות אימוג’י.

תגובות אימוג’י

אם הפלטפורמה שלך תומכת בתגובות אימוג’י (למשל, סימון לייק על הודעה), שלח אותן כתגובה ולא כהודעת טקסט: הגדר את messageType ל-"reaction" והכנס רק את האימוג’י בתוך customData.body.

{
  "messageType": "reaction",
  "customData": {
    "messageSid": "reaction-123",
    "fromId": "user-42",
    "toId": "my-business",
    "body": "👍"
  }
}

העוזר יתייחס לכך כפי שהיית מצפה:

  • תגובה לשאלה שהעוזר שאל (למשל “האם יום חמישי מתאים?”) תטופל כתשובה, והעוזר ישיב בהתאם.
  • תגובה להודעת סיום (למשל “נדבר בקרוב!”) תסיים את השיחה בשקט. לא תישלח תשובה.

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

מה מקבלים בחזרה

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

{
  "success": true,
  "messageId": "1234567890"
}

אם משהו משתבש, תקבל הודעת שגיאה המסבירה את הבעיה:

{
  "error": "Message body cannot be empty"
}

קודי סטטוס

קוד מה זה אומר
200 הצלחה - ההודעה התקבלה ומעובדת
400 משהו לא תקין בבקשה שלך - בדוק אם חסרים שדות חובה או אם גוף ההודעה ריק
401 מפתח API לא תקין - בדוק שוב את המפתח תחת Settings → Integrations → API Key
405 שיטת בקשה שגויה - ודא שאתה משתמש ב-POST ולא ב-GET
500 משהו השתבש בצד של הפלטפורמה - נסה שוב בעוד מספר רגעים

אם תגדיר את customData.status, הערך היחיד שיתקבל הוא "received" — השאר אותו ריק לחלוטין כדי להשתמש בברירת המחדל במקום לשלוח משהו אחר, אחרת תקבל 400.


שליחת קבצים מצורפים (תמונות, סרטונים, קבצים)

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

אפשרות 1: קישור לקובץ

אם הקובץ כבר מאוחסן באינטרנט, ספק את ה-URL (כתובת אתר) שבו הפלטפורמה יכולה להוריד אותו:

{
  "customData": {
    "messageSid": "msg-789",
    "fromId": "user-456",
    "toId": "business-1",
    "body": "Here is a photo of the issue.",
    "channel": "support-portal",
    "mediaUrl": "https://example.com/uploads/photo.jpg",
    "mediaContentType": "image/jpeg"
  },
  "messageType": "text"
}

אפשרות 2: הטמעת הקובץ ישירות (Base64)

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

{
  "customData": {
    "messageSid": "msg-790",
    "fromId": "user-456",
    "toId": "business-1",
    "body": "Screenshot attached.",
    "channel": "support-portal",
    "mediaUrl": "data:image/png;base64,iVBORw0KGgo...",
    "mediaContentType": "image/png"
  },
  "messageType": "text"
}

הערה: הטמעת קבצים ישירות הופכת את נתוני ההודעה לגדולים הרבה יותר. עבור קבצים גדולים, עדיף לארח את הקובץ באופן מקוון ולשלוח קישור (אפשרות 1) במקום זאת.


הגדרת הודעות יוצאות (מהפלטפורמה לפלטפורמה שלך)

כאשר הפלטפורמה שולחת תשובה בערוץ מותאם אישית (בין אם מה-AI או כזו שהוקלדה על ידכם), היא שולחת את התשובה הזו באופן אוטומטי ל-URL בפלטפורמה שלכם כדי שהמערכת שלכם תוכל להעביר אותה למשתמש הקצה.

הגדירו תחילה את ה-URL של ה-webhook. עליכם לשמור את ה-URL של ה-webhook של הערוץ המותאם אישית לפני שניתן יהיה להעביר תשובות כלשהן. אם לא נשמר URL, תשובות עדיין ייווצרו ויישמרו, אך הן לעולם לא יישלחו — והן לא יציגו סטטוס “נכשל”, כך ששום דבר בתיבת הדואר הנכנס שלכם לא יסמן את הבעיה. תמיד הגדירו את ה-URL של ה-webhook לפני העלייה לאוויר.

אמור לאפליקציה לאן לשלוח תשובות

  1. בסרגל הצד השמאלי, לחץ על Settings ליד החלק התחתון.
  2. בסרגל הצד של ההגדרות, תחת Channels, לחץ על Channels.
  3. מצא את הכרטיס Custom channel בתחתית העמוד (אחרי Android SMS Gateway, iMessage, ווידג’ט הצ’אט של האתר, Twilio Account, ו-Regulatory compliance).
  4. הזן את ה-Webhook URL — הכתובת בפלטפורמה שלך שאליה ה-AI אמור לשלוח הודעות יוצאות (המפתח שלך מגדיר זאת כדי לקבל ולעבד תשובות). עליו להיות כתובת HTTPS ציבורית — כתובות http:// ומארחים שאינם ציבוריים יידחו.
  5. לחץ על Save.

מה הפלטפורמה שולחת לפלטפורמה שלך

כאשר הפלטפורמה שולחת תשובה, הפלטפורמה שלך תקבל את הנתונים הבאים:

{
  "contactId": "abc123",
  "messageId": "msg-456",
  "userId": "your-user-id",
  "body": "Thank you for your message! Here is the information you requested...",
  "toId": "user-456",
  "channel": "my-live-chat"
}

מה המשמעות של כל שדה

שדה מה הוא מכיל
contactId המזהה הפנימי של הפלטפורמה עבור איש קשר זה
messageId המזהה הייחודי של הודעה זו באפליקציה
userId מזהה המשתמש שלך
body טקסט התשובה
toId המזהה של איש הקשר בפלטפורמה שלך (זה תואם ל-fromId ששלחת בהודעה הנכנסת)
channel תווית הערוץ המותאם אישית שהקצית

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

כיצד הפלטפורמה עוקבת אחר מסירה

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

  • נשלח (Sent) - הפלטפורמה שלך קיבלה את ההודעה בהצלחה.
  • נכשל (Failed) - הפלטפורמה שלך החזירה שגיאה או שלא ניתן היה להגיע אליה. הפלטפורמה שומרת את פרטי השגיאה עם ההודעה כדי שתוכל לפתור את הבעיה.

שליחת הודעות מהמערכת שלך לאפליקציה

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

דרישת תוכנית. שליחה וסנכרון של הודעות דרך ה-API דורשים תוכנית הכוללת גישה ל-API ולפחות ערוץ הודעות אחד. אם קיבלת שגיאת 403 “permission denied / feature not enabled”, התוכנית הנוכחית שלך אינה כוללת זאת — שדרג את התוכנית שלך או צור קשר עם התמיכה.

לאן לשלוח

POST https://api.youraiconnector.com/v1/send_custom_channel_message?apiKey=YOUR_API_KEY

פורמט ההודעה

{
  "customData": {
    "fromId": "user-456",
    "customChannel": "my-live-chat",
    "body": "Hello! How can I help you today?",
    "campaignId": "optional-campaign-id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com"
  }
}

שדות חובה

שדה מה הוא עושה
customData.fromId מזהה איש הקשר בפלטפורמה שלך
customData.customChannel שם הערוץ המותאם אישית שלך (למשל, “my-live-chat”)
customData.body טקסט ההודעה לשליחה

השדות האופציונליים (campaignId, firstName, lastName, email) פועלים באותו אופן כמו בהודעות נכנסות — הם עוזרים לפלטפורמה ליצור או לעדכן את רשומת איש הקשר.

מה מקבלים בחזרה

{
  "success": true,
  "messageId": "generated-message-id",
  "contactId": "contact-id",
  "message": "Message sent successfully"
}

תיעוד הודעות שנשלחו ממערכת אחרת

לפעמים כבר שלחתם הודעה לאיש קשר מכלי אחר (למשל, תהליך עבודה בפלטפורמה אחרת), ואתם פשוט רוצים שהפלטפורמה תדע על כך כדי של-AI יהיה את ההקשר המלא. זה שונה משליחה: הפלטפורמה מתעדת את ההודעה אך לא מעבירה אותה שוב לאיש הקשר.

לאן לשלוח

POST https://api.youraiconnector.com/v1/sync_custom_channel_message?apiKey=YOUR_API_KEY

כלול את customData.fromId (מזהה איש הקשר בפלטפורמה שלך) ואת customData.body (טקסט ההודעה שכבר נשלחה).

איך זה מתנהג

  • ההודעה מתועדת, לא נשלחת מחדש. הפלטפורמה שומרת אותה בשיחה לצורך הקשר בלבד.
  • ה-AI מושהה עבור איש קשר זה כברירת מחדל. זה מונע מהבוט להשיב על גבי הודעה שאדם כבר טיפל בה. כדי להשאיר את הבוט פעיל, העבירו את customData.pauseAi: false.
  • ניתן ליצור אנשי קשר חדשים באופן אוטומטי. כללו את customData.customChannel ואיש הקשר ייווצר אם הוא עדיין לא קיים.
  • כפילויות מתעלמים מהן. אם תשתמשו שוב באותו messageSid, הפלטפורמה תזהה שההודעה כבר תועדה ולא תבצע שינויים.

דרישת תוכנית. בדומה לשליחה, הקלטת הודעות דרך ה-API דורשת תוכנית הכוללת גישה ל-API ולפחות ערוץ הודעות אחד. שגיאת 403 “permission denied / feature not enabled” (הרשאה נדחתה / תכונה לא מופעלת) פירושה שהתוכנית הנוכחית שלך אינה כוללת זאת.


דוגמאות מהעולם האמיתי

צ’אט חי באתר

חברו ווידג’ט צ’אט חי באתר שלכם לפלטפורמה כדי שסוכן ה-AI שלכם יוכל לענות על שאלות המבקרים:

  1. מבקר מקליד הודעה בווידג’ט הצ’אט באתר שלך.
  2. ווידג’ט הצ’אט שלך שולח את ההודעה לפלטפורמה.
  3. סוכן ה-AI מייצר תגובה.
  4. התגובה נשלחת בחזרה לווידג’ט הצ’אט שלך, שמציג אותה למבקר.

מדוע זה שימושי: מבקרי האתר שלך מקבלים תשובות מיידיות מבוססות AI לשאלותיהם מבלי שתצטרך להיות מחובר.

דואר אלקטרוני

נתב שיחות אימייל דרך הפלטפורמה כדי שסוכן ה-AI שלך יוכל להשיב לאימיילים:

  1. הגדר מערכת שמעבירה אימיילים נכנסים לפלטפורמה (באמצעות כתובת השולח כ-fromId, נושא וגוף האימייל כ-body, ו-"email" כ-channel).
  2. סוכן ה-AI קורא את האימייל ומייצר תשובה.
  3. התשובה נשלחת בחזרה למערכת האימייל שלך, ששולחת אותה כתגובת אימייל רגילה.

מדוע זה שימושי: שאלות נפוצות באימייל (תמחור, שעות פעילות, זמינות) מקבלות מענה מיידי מסוכן ה-AI שלך.

אם מערכת האימייל שלך תומכת ב-IMAP/SMTP או OAuth, ה-ערוץ אימייל המובנה עשוי להיות פשוט יותר מאינטגרציה מותאמת אישית.

אינטגרציית CRM

חבר את מערכת ה-CRM (ניהול קשרי לקוחות) הקיימת שלך לפלטפורמה:

  1. כאשר ליד שולח הודעה דרך ה-CRM שלך, העבר אותה לפלטפורמה.
  2. סוכן ה-AI מגיב ועוקב אחר השיחה.
  3. תגובת ה-AI נשלחת בחזרה ל-CRM שלך למשלוח.
  4. היסטוריית השיחה המלאה זמינה גם בפלטפורמה וגם ב-CRM שלך.

מדוע זה שימושי: צוות המכירות שלך מקבל תגובות בסיוע AI ללידים מבלי לעזוב את ה-CRM שלהם.

מערכת כרטיסי תמיכה

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

  1. מערכת התמיכה (Ticketing) שלך מעבירה כרטיסי תמיכה חדשים לפלטפורמה.
  2. סוכן ה-AI שולח תגובה ראשונית (למשל, אישור קבלת הכרטיס ושאלת שאלות הבהרה).
  3. התגובה מצורפת לכרטיס במערכת התמיכה שלך.
  4. צוות התמיכה שלך יכול לסקור את מה שה-AI אמר ולהשתלט על השיחה בעת הצורך.

מדוע זה שימושי: לקוחות מקבלים אישור מיידי ועזרה ראשונית, גם מחוץ לשעות הפעילות.


פתרון בעיות

הודעות לא מתקבלות בפלטפורמה

  • ודא שמפתח ה-API שלך נכון ופעיל (בדוק ב-הגדרות ← אינטגרציות ← מפתח API).
  • ודא שאתה שולח בקשת POST (לא GET). המפתח שלך ידע את ההבדל.
  • בדוק שהשדה customData.body אינו ריק או מכיל רווחים בלבד.
  • ודא שהשדה customData.fromId כלול.
  • קרא את הודעת התגובה לקבלת פרטי שגיאה ספציפיים.

תגובות לא מגיעות לפלטפורמה שלך

  • ודא שהזנת את כתובת ה-URL של הפלטפורמה שלך בכרטיס ערוץ מותאם אישית בדף הערוצים. אם לא נשמרה כתובת URL, תשובות ייווצרו ויישמרו אך לעולם לא יישלחו — והן לא יסומנו כ-“נכשלו”, לכן בדוק זאת תחילה.
  • ודא שה-URL נגיש לציבור (לא מאחורי התחברות או חומת אש) ומחזיר תגובת הצלחה.
  • רק תשובות (הודעות יוצאות) נשלחות ל-URL שלך — הודעות נכנסות אינן מפעילות זאת.
  • בדוק פרטי שגיאה על ההודעה בתיבת הדואר הנכנס שלך.

איש קשר לא נוצר

  • ודא שהערך fromId עקבי עבור אותו משתמש בכל ההודעות שלו. הפלטפורמה משתמשת בערך זה כדי לזהות אנשי קשר — אם הוא משתנה בין הודעות, הפלטפורמה תיצור איש קשר חדש בכל פעם.
  • כלול את firstName, lastName ו-email בהודעה הראשונה מאיש קשר חדש כדי ליצור רשומת איש קשר מלאה.

קבצים מצורפים לא עובדים

  • עבור קישורי קבצים (URLs), ודא שהקובץ נגיש לציבור (אין צורך בהתחברות כדי לגשת אליו).
  • כלול תמיד את mediaContentType כאשר אתה כולל את mediaUrl.
  • עבור קבצים מוטמעים (base64), ודא שהפורמט הוא data:MIME_TYPE;base64,ENCODED_DATA.
  • ודא שסוג הקובץ שציינת תואם לתוכן הקובץ בפועל.

שיטות עבודה מומלצות

  • השתמש בערכי fromId עקביים. לכל משתמש בפלטפורמה שלך תמיד צריך להיות אותו fromId. זה מבטיח שהפלטפורמה תקבץ את כל ההודעות שלו לשיחה אחת במקום ליצור אנשי קשר כפולים.
  • בחר שם channel ברור. בחר משהו תיאורי כמו "website-chat", "email" או "zendesk" כדי שתוכל לדעת בקלות מהיכן הגיעו ההודעות בעת צפייה בתיבת הדואר הנכנס.
  • כלול פרטי קשר (firstName, lastName, email) בהודעה הראשונה מאיש קשר חדש. זה יוצר רשומת איש קשר מלאה ושימושית באופן מיידי.
  • בנה לוגיקת ניסיון חוזר (Retry). דאג שהפלטפורמה שלך תנסה לשלוח הודעות שוב אם הפלטפורמה לא מגיבה בניסיון הראשון (תקלות רשת קורות).
  • השתמש בערכי messageSid ייחודיים לכל הודעה. זה מונע מאותה הודעה לעבור עיבוד פעמיים אם המערכת שלך שולחת אותה יותר מפעם אחת.
  • השתמש ב-campaignId כדי לנתב הודעות לסוכני AI שונים כאשר יש לך מספר מקרי שימוש (למשל, פניות מכירה לעומת שאלות תמיכה).
  • בדוק לפני העלייה לאוויר. שלח הודעות בדיקה בשני הכיוונים וודא שאנשי קשר, שיחות ותגובות AI עובדים כראוי לפני ההשקה למשתמשים אמיתיים.