Endpoint
POST
api/whatsappcampaign/SendOperationalMessage
תיעוד
לתיעוד ה-API המלא, ראו:
https://webapi.mymarketing.co.il/api/docs/User/Api/POST-api-whatsappcampaign-SendOperationalMessage
מטרה
ה-endpoint הזה שולח הודעת WhatsApp תפעולית בעזרת תבנית WhatsApp מאושרת.
סטטוסים בהודעות תפעוליות: אפשר לשלוח הודעות WhatsApp תפעוליות לנמענים בכל הסטטוסים, חוץ מ"שגוי" (bounced). אותו היגיון של הודעות תפעוליות חל על מייל, SMS ו-WhatsApp.
השליטה בקישור ההסרה והאפשרות לשלוח לנמענים לא פעילים מוגדרות בנפרד בממשק.
מידע נדרש
לפני שליחת הודעה, ודאו שיש לכם:
1. מזהה פרופיל WhatsApp
לכל חשבון יכולים להיות מזהה פרופיל WhatsApp אחד או יותר. כשיש בחשבון כמה מספרי WhatsApp או שולחים, השתמשו ב-whatsapp_profile_id של מספר השולח שממנו רוצים לשלוח את ההודעה התפעולית.
אם אתם לא יודעים מה מזהה הפרופיל הנכון, פנו לתמיכה של אקטיב טרייל.
דוגמה:
"whatsapp_profile_id": 972. שם התבנית
התבנית חייבת להיות קיימת בחשבון שלכם.
דוגמה:
"name": "template_name"3. מזהה התבנית
את מזהה התבנית מקבלים מ:
GET
api/whatsappcampaign/templates
ה-endpoint הזה מחזיר את כל תבניות ה-WhatsApp שזמינות בחשבון.
דוגמה:
"id": "HX3dc13e7a4bbedb8fae06d2b240de20c9"4. משתנים דינמיים
אם בתבנית יש משתנים, מעבירים את הערכים באובייקט variables. אפשר להעביר במשתנים ערכי טקסט מותאמים ישירות בזמן השליחה, ולא רק ערכים משדות הנמען.
דוגמה:
"variables": {
"1": "12345"
}כך ימולא משתנה מספר 1 בתבנית ה-WhatsApp.
גוף בקשה לדוגמה
{
"scheduling": {
"is_sent": true
},
"segment": {
"mobiles": [
"+9725XXXXXXXX"
]
},
"details": {
"whatsapp_profile_id": 97
},
"design": {
"name": "template_name"
},
"template": {
"id": "HX3dc13e7a4bbedb8fae06d2b240de20c9",
"variables": {
"1": "12345"
}
}
}תיאור השדות
|
שדה |
תיאור |
|---|---|
|
|
הגדירו |
|
|
מספרי הנייד של הנמענים בפורמט בינלאומי |
|
|
מזהה פרופיל ה-WhatsApp שהוקצה לחשבון |
|
|
שם התבנית שהוגדרה בחשבון |
|
|
מזהה התבנית שמתקבל מ- |
|
|
ערכים דינמיים למשתנים שבתבנית |
תהליך עבודה טיפוסי
-
קבלו את התבניות הזמינות בעזרת:
GET api/whatsappcampaign/templates -
העתיקו את:
-
מזהה התבנית
-
שם התבנית
-
-
קבלו את מזהה פרופיל ה-WhatsApp של החשבון.
-
בנו את גוף הבקשה.
-
שלחו את הבקשה אל:
POST api/whatsappcampaign/SendOperationalMessage -
בדקו את התגובה של ה-API.