מערכת פידבוט מאפשרת שליחה דרך API באמצעות Webhooks פשוטים.
חברתנו מציגה פתרון API מלא, המאפשר לכם לחבר את מערכת ה-CRM שלכם (לדוגמה), ולייצר טריגרים פשוטים שיגיעו ללקוחיתכם באופן ישיר ואישי בואטספ.
אופן ההתממשקות הוא קל ופשוט.
נתחיל. ראשית, יש לשלוח בקשת POST לכתבות הבאה:
https://addnewmessages-bmb77ejh3a-uc.a.run.app
ה- Headers צריכים להכיל את הערכים הבאים:
הtoken הוא מזהה ייחודי שיספוק למשתמש לאחר רכישת רישיון הפרימיום ויצורף לכל בקשת API
1) Header Key: 'auth' , Header Value:{token}
לאחר מכן, יש להעתיק את המבנה מטה ל-Body.
בדוגמה הבאה, הבקשה תבצע שליחה למספר הבא: 972586666644 עם המלל " Hello world".
יש לשים לב, שהמספר חייב לכלול את קידומת המדינה (בישראל הקידמות היא 972).
{ "messages":[
{ "message":"Hello world", "phone":"972586666644", "invalidationTime":"1685662968767",
"imagePath":"https://cdn.pixabay.com/photo/2015/04/23/22/00/tree-736885_1280.jpg", }
] }
{
"errorCode":null,
"success":true,
"ids:" : [
"wwFSlUQCEB6WQ8egk42n",
"jks4Fjo2409i8dj13nff",
]
}
כדי לצפות בסטטוס של הודעה לפי מזהה ניתן לשלוח את בקשת הAPI הבאה:
https://getmessagestatus-bmb77ejh3a-uc.a.run.app?id={messageId}
דוגמא לתגבוה מהשרת
{
"errorCode": null,
"success": true,
"status": 1,
"reason": null
}
בתגובה הזאת ניתן לצפות בסטטוס ההודעה:
מקרא סטטוסים:
1- : הודעה נכשלה
0 : הודעה בהמתנה (ממתינה לשליחה)
1 : נשלח בהצלחה
במידה וההודעה נכשלה ניתן לצפות בסיבה בשדה "reason"
הערות ומושגים:
- auth הוא המזהה הייחודי שמתקבל ביחד עם התקנת התוכנה.
- messages הוא מערך של אובייקטים שמכיל את ההודעות אותן נרצה שהתוכנה תמשוך. מבנה כל אובייקט במערך יכיל:
- message – טקסט ההודעה.
- phone – מספר הטלפון שאליו תשלח ההודעה.
- invalidationTime (אופציונלי) – אפשרות להגדיר תוקף לשליחת ההודעה, במידה והתוקף עבר ההודעה לא תשלח. (אמור להיות אובייקט מסוג TimeStamp).
- imagePath (אופציונלי) – אפשרות לצרף תמונה להודעה, הערך שצריך לשלוח הינו קישור לתמונה.
- בתוכנה יש לבחור את האופציה "מצב שרת" , ההודעות הקיימות בשרת ימשכו לתוכנה ובאופן אוטומטי תתחיל שליחת ההודעות.
הודעות שגיאה אפשריות וטיפול בהן:
MISSING_PARAMS (2)
USER_NOT_AUTHORIZED (99)