תיעוד מלא לממשק ה-JSON שליחת SMS, מייל, וניהול אנשי קשר באמצעות API פשוט.
POST https://heb.mesereser.com/Services/JsonServices.aspx?f=FunctionName
כל הבקשות יש לשלוח ל:
https://heb.mesereser.com/Services/JsonServices.aspx?f=FunctionName
כאשר FunctionName הוא שם אחת הפונקציות המפורטות למטה.
🔑 ApiKey Header: כל בקשה חייבת להכיל header בשם ApiKey עם ערך מפתח ה-API (נלקח ממסך הגדרות המשתמש בממשק).
התגובה של כל הפונקציות מכילה את השדות ErrorCode ו-Result. כאשר ErrorCode שווה ל-"0" – הקריאה הצליחה; השדה Result יכיל תיאור שגיאה אם הייתה (כאשר ErrorCode אינו אפס). קוד ה-HTTP הוא 200 לכל בקשה שהתקבלה, גם כאשר הפעולה נכשלה, ולכן יש לקרוא את ErrorCode כדי לדעת אם הקריאה הצליחה.
שינוי סטטוס של איש קשר לפי כתובת מייל או מספר טלפון.
EMail או PhoneNo נדרש (לא שניהם). Status יכול להיות אחד מהערכים: Unsubscribed, Active, Bounced{
"EMail": "",
"PhoneNo": "",
"Status": ""
}
{
"ErrorCode": 0,
"Result": "Call successful"
}
יצירת איש קשר חדש ברשימת תפוצה.
{
"Address": "",
"City": "",
"ContactListName": "",
"CustomField1": "",
"CustomField2": "",
"CustomField3": "",
"CustomField4": "",
"CustomField5": "",
"EMail": "",
"FirstName": "",
"LastName": "",
"PhoneNo": "",
"Zipcode": ""
}
{
"ErrorCode": 0,
"Result": "Call successful"
}
שליחת SMS בודד לנמען.
{
"FromName": "",
"MessageBody": "",
"ToPhone": ""
}
{
"ErrorCode": 0,
"Result": "",
"MessageID": 0
}
שליחת מייל בודד לנמען.
{
"Body": "",
"FromName": "",
"LinkClickCountType": "",
"ReplyToEMail": "",
"Subject": "",
"ToEMail": ""
}
{
"ErrorCode": 0,
"Result": "",
"MessageID": 0
}
קריאת הסטטוס הנוכחי של כתובת מייל בחשבון.
email parameter is empty. נתמכת כתובת מייל בלבד; פרמטר phone אינו נקרא.GET /Services/JsonServices.aspx
?f=GetContactStatus
&email=person@example.com
Header: ApiKey: <המפתח שלכם>
{
"ErrorCode": 0,
"Result": "Call successful",
"Status": "פעיל",
"StatusID": 10
}
StatusID ולא את Status, שהוא טקסט לתצוגה בעברית. הערכים שנמדדו: 0 הכתובת לא נמצאה בחשבון, 10 פעיל, 30 פעיל אחרי הפעלה מחדש, 40 דואר חוזר, 50 הוסר. שימו לב ששני ערכים מציינים פעיל: איש קשר שנוצר דרך ה-API מקבל 10, ואיש קשר שהוחזר לסטטוס Active אחרי הסרה או דואר חוזר מקבל 30. מי שבודק 10 בלבד יפסיד נמענים שחזרו.