 JSON- SendMsgAPI-ממשק ה4.0
gconvertrest.sendmsg.co.il
שלב 1 - טוקן
יש לפנות לכתובת הבאה : gconvertrest.sendmsg.co.il/api/sendMsg/token ב POST ולהעביר את הפרטים הבאים siteID:integer password: string
לאחר קבלת הטוקן, יש לפנות לכל request כאשר הטוקן מוצמד לHeaders כאשר הKey הוא Authorization
יש לבצע בדיקה בכתובת הבאה : gconvertrest.sendmsg.co.il/api/sendMsg/test
שימוש בפונקציות השונות :
1. הכנסה של מנויים בלבד: AddUsersOnly.
2 . הכנסת מנויים ושליחת הודעה אליהם: AddUsersAndSend.
3. הכנסת מנויים והוספה שלהם לקבוצות דיוור: AddUsersToLists.
4. הכנסת מנויים, הוספה שלהם לקבוצה, ושליחת הודעה AddUsersToListAndSend.
5. יצירת הודעה בלבד, אותה ניתן יהיה לשלוח מאוחר יותר: CreateMessageOnly.
6. קבלת סטטיסטיקה כללית לגבי הודעה שנשלחה: GetMsgBasicStatistics.
7. קבלת סטטיסטיקה מורחבת הכוללת רישום של כל נמען ופעולותיו עם ההודעה: GetMsgFullStatistics.
8. קבלת פרטי משתמש לפי ה-ID שלו: GetUserDetails .
9. קבלת רשימת כל ההודעות אשר נשלחו למנוי מסויים לפי ה-ID שלו: GetUserMessages .
10. קבלת רשימת כל המנויים במערכת (כל המנויים/ שנמחקו/ שהסירו עצמם/ כתובות שגויות) : GetSystemUsers .
11. קבלת רשימת כל המנויים בקבוצה מסוימת : GetMailingListUsers .
12. קבלת רשימה של כל הקבוצות: GetMailingListNames .
13. קבלת רשימה של כל ההודעות שנשלחו מהמערכת: GetSentMessages .
14. קבלת רשימת התבניות האישיות הקיימות במערכת: GetTemplates .
15. קבלת תבנית אישית, כולל התוכן שלה, והרשימת התגיות הקיימות בה: GetTemplate .
16. מחיקת תבנית אישית: DelTemplate .
17. החזרת תבנית שנמחקה: UnDelTemplate .
18. מחיקת הודעה, כולל התוכן וכל הפרטים אודותיה: DelMessage .
19. החזרת הודעה שנמחקה: UnDelMessage .
20. עצירת שליחת הודעה במהלך שליחה: PauseMessage .
21. החזרת הודעה שנשלחה לפעולה: UnPauseMessage
לבדיקת הפונקציות השונות, לדוגמא איזה ערכים לשלוח לקבלת תוצאה תקינה
יש לפנות לכתובת : /gconvertrest.sendmsg.co.il/api/doc יחד עם שם הפונקציה הדרושה וכך לקבל עליה את הפרטים
ניתן להשתמש ב-postman או ARC
לדוגמא : http://gconvertrest.sendmsg.co.il/api/doc/AddUsersOnly
וכך נקבל את האובייקט ואת הtype
לכל שאלה או בירור יש לפנות לתמיכה שלח מסר : 077-4600911
|