API
תיבת API היא תיבת מפתחים לדחיפת הודעות אל Teloring מכל מערכת מותאמת — האפליקציה שלכם, פלטפורמה ותיקה, או ערוץ ש‑Teloring אינה תומכת בו באופן מובנה. אתם יוצרים את התיבה, מקבלים נקודת קצה ושולחים אליה הודעות ב‑POST. כל הודעה הופכת לשיחה בדיוק כמו בכל ערוץ אחר, כך שהאינטגרציה המותאמת שלכם נוחתת באותה תיבה משותפת שהנציגים כבר משתמשים בה.
דרישות מקדימות
| מה נדרש | למה |
|---|---|
| הרשאת תיבה | יצירת תיבה דורשת טבעת הערוצים ← יצירה. ראו תפקידים והרשאות. |
| טוקן API אישי | הבקשות מאומתות באמצעות הטוקן האישי של נציג (נוצר בפרופיל שלכם). |
| מערכת שיכולה לשלוח בקשות HTTP | כדי לשלוח הודעות ב‑POST לנקודת הקצה. |
יצירת תיבת API
פתחו את טבעת הערוצים, לחצו על סמל API ובחרו הוספה.
| שדה | מה להזין |
|---|---|
| שם הערוץ | שם כמו תיבת ה‑API שלי. |
| סוג הערוץ | לקריאה בלבד (API). |
| כתובת Webhook (להודעות יוצאות) | אופציונלי. אם תספקו אותה, Teloring תשלח ב‑POST הודעות יוצאות (תשובות של נציגים) לכתובת הזו, כדי שהמערכת שלכם תוכל למסור אותן. השאירו ריק אם אתם רק דוחפים הודעות פנימה. |
לחצו יצירת ערוץ. מסך ההצלחה (ועמוד העריכה של התיבה) מציג את הפרטים שאתם צריכים לאינטגרציה.
שליחת הודעות פנימה
לאחר היצירה אתם מקבלים:
- מזהה הערוץ שלכם — המזהה המספרי של התיבה.
- נקודת קצה — הכתובת שאליה שולחים הודעות ב‑POST, בתבנית
.../accounts/{account}/channels/{channel}/incoming. - דוגמת cURL ודוגמת Python — קוד מוכן לשימוש שאפשר להעתיק.
אמתו כל בקשה עם הטוקן האישי שלכם בכותרת X-API-Key. גוף ההודעה מקבל:
| שדה | משמעות |
|---|---|
message | טקסט ההודעה (חובה). |
contact_id | איש קשר קיים שאליו לצרף (אופציונלי). |
contact_name, contact_phone, contact_email, contact_picture | פרטים המשמשים להתאמה או ליצירה של איש הקשר כאשר לא סופק contact_id. |
file_url | קובץ מצורף אופציונלי. |
contact_attributes | שדות מותאמים להגדרה על איש הקשר. |
Teloring מאתרת או יוצרת את איש הקשר, מאתרת או יוצרת שיחה פתוחה, שומרת את ההודעה ומחזירה את ה‑contact_id, ה‑conversation_id וה‑message_id שנוצרו.
עמודי ההגדרה והעריכה כוללים את פורמט הבקשה המדויק עבור התיבה שלכם. העתיקו את דוגמת ה‑cURL או ה‑Python כדי להתחיל במהירות.
עמוד העריכה של ה‑API
עמוד העריכה מאפשר לשנות את שם התיבה, להגדיר או לשנות את כתובת ה‑Webhook היוצאת ולעיין בקוד הדוגמה. אזור מסוכן מוחק את התיבה (השיחות הקיימות נשמרות).
הודעות יוצאות (אופציונלי)
אם הגדרתם כתובת Webhook, תשובות של נציגים בתיבה הזו נשלחות אליה ב‑POST, כדי שהמערכת שלכם תמסור אותן ללקוח. כך תיבת ה‑API הופכת לדו‑כיוונית מלאה עבור ערוץ מותאם.