ממשק זה מאפשר לבצע הוספה ומחיקה של אנשי קשר ברשימות תפוצה.
הוספת איש הקשר מתבצעת לפי מספר הטלפון, וניתן להוסיף רשימת מספרים או מספר בודד עם פרטים נוספים.
הפנייה מתבצעת באמצעות API בפרוטוקול HTTPS סטנדרטי המאפשר העברת הפרמטרים בשיטת GET או POST.
הכתובת לפנייה לממשק ניהול אנשי קשר היא:
https://www.micropay.co.il/extApi/poolMembers.php
לכתובת הזו יש להוסיף את הפרמטרים המתאימים על מנת לבצע את האימות
חלק מהפרמטרים הינם חובה, וחלקם רשות
יש לשלוח את כל השמות של הפרמטרים ב- Lower Case
רשימת הפרמטרים הבסיסית לפנייה לממשק
token – טוקן שיצרת במערכת, עם הרשאה לרשימות תפוצה
ניתן לפתוח ולנהל את הטוקנים על ידי כניסה למערכת, לחיצה על האייקון הירוק למעלה משמאל, ובחירה באפשרות "טוקנים לממשקים"
pid – קוד רשימת תפוצה קיימת במערכת שעליה תתבצע הפעולה
act – הפעולה שתרצה לבצע, יש לבחור מהאפשרויות הבאות:
- del – מחיקה של איש קשר מרשימת התפוצה
- add – הוספה של איש קשר לרשימת התפוצה
- check – בדיקה האם איש הקשר קיים ברשימת התפוצה
list – רשימת טלפונים מופרדים בפסיק
מומלץ לשלוח את הטלפונים עם ספרות בלבד, וניתן לשלוח אותם בפורמט מקומי או בינלאומי
ניתן לשלוח עד כ- 10,000 מספרים בשליחה בודדת
קביעת שיטת השליחה: GET או POST
ניתן לשלוח את הפרמטרים בשיטת GET או POST
במידה ואתה מבצע את השליחה בשיטת GET יש להוסיף את הפרמטר: get=1
במידה ואתה שולח בשיטת POST יש להוסיף את הפרמטר post=2
שים לב, הגדרת הפרמטר אינה משנה את שיטת השליחה, אלא רק מגדירה למערכת את סוג השליחה שבחרת
אתה צריך לבצע את השליחה בשיטה המתאימה בקוד עצמו
פרמטר אפשרי נוסף בהוספת אנשי קשר
unblock – במידה ומספר הטלפון חסום ברשימת התפוצה עצמה, המערכת לא תוסיף את המספר לרשימת התפוצה והוא ישאר בסטטוס חסום, על מנת לאפשר הוספה של המספר גם אם הוא בסטטוס חסום יש לשלוח את הערך 1, והמערכת תפתח את החסימה של המספר (שים לב, אפשרות זו לא פותחת חסימה גלובלית בחשבון של המספר)
פרמטרים אפשריים נוספים בהוספת איש קשר בודד
fname – השם הפרטי של איש הקשר, ניתן לשלוח טקסט באורך של עד 20 תווים
lname – שם המשפחה של איש הקשר, ניתן לשלוח טקסט באורך של עד 20 תווים
data, data1, data2, data3, data4 – בכל אחד מהפרמטרים הללו ניתן לשלוח טקסט של עד 100 תווים שיתווסף כמידע נוסף על איש הקשר
bd – תאריך יום הולדת של איש הקשר, יש לשלוח את התאריך בפורמט הבא: YYYY-MM-DD, לדוגמא: 2008-02-25
ip – כתובת IP של המחשב של איש הקשר שממנו בוצע הרישום לרשימת התפוצה
update – במידה ואיש הקשר כבר קיים ניתן לשלוח בפרמטר הזה את הערך 1 על מנת לדרוס את הנתונים הקודמים עם הנתונים החדשים, או 0 על מנת לשמור את הנתונים הקודמים
שים לב:
בפעולה שאינה הוספה או בהוספה של יותר ממספר אחד המערכת לא תתייחס לפרמטרים הנוספים
חובה לבצע url encoding על הפרמטרים שמכילים טקסט על מנת שהבקשה תעבור
דוגמאות שליחה בשיטת GET
להלן דוגמא להוספה בסיסית של איש קשר
https://www.micropay.co.il/extApi/poolMembers.php?get=1&token=xxxxx&pid=xxxxx&act=add&list=0500000000
להלן דוגמא למחיקה של איש קשר
https://www.micropay.co.il/extApi/poolMembers.php?get=1&token=xxxxx&pid=xxxxx&act=del&list=0500000000
רשימת תשובות אפשרויות שמתקבלות בבדיקת סטטוס איש קשר
המערכת תחזיר תשובה כטקסט פשוט, להלן התשובות האפשריות:
ERROR – יוחזר במידה ויש שגיאה באחד הפרמטרים, ולאחריו רווח ותיאור של השגיאה
REG – יוחזר במידה ואיש הקשר רשום ברשימת התפוצה
NOT_REG – יוחזר במידה ואיש הקשר אינו רשום ברשימת התפוצה
BLOCKED – יוחזר במידה ואיש הקשר בסטטוס חסום ברשימת התפוצה
רשימת תשובות אפשרויות שמתקבלות בהוספה/מחיקה של אנשי קשר
המערכת תחזיר תשובה כטקסט פשוט, להלן התשובות האפשריות:
ERROR – יוחזר במידה יש שגיאה באחד הפרמטרים, ולאחריו רווח ותיאור של השגיאה
ACTION_ERROR – יוחזר במידה וחלק מאנשי הקשר לא התווספו/נמחקו מרשימת התפוצה עקב תקלה, ולאחריו רווח ופירוט רשימת המספרים מופרדים בפסיק
ALREADY_REG – יוחזר במידה וחלק מאנשי הקשר כבר רשומים ברשימת התפוצה, ולאחריו רווח ופירוט רשימת המספרים מופרדים בפסיק
NOT_REG – יוחזר במידה ובוצע נסיון למחוק אנשי קשר שאינם רשומים ברשימת התפוצה, ולאחריו רווח ופירוט רשימת המספרים מופרדים בפסיק
BLOCKED – יוחזר במידה וחלק מאנשי הקשר שעליהם בוצעה הפעולה חסומים ברשימת התפוצה, ולאחריו רווח ופירוט רשימת המספרים מופרדים בפסיק
OK – יוחזר במידה והכל תקין
בכל מקרה בו מופיע פירוט עם הערך המוחזר, הפירוט יופיע לאחר רווח אחד מהערך המוחזר, לדוגמא:
ALREADY_REG 0545370070,0545456711
הערות לגבי הערכים המוחזרים:
הערכים הבאים יכולים להופיע ביחד: ACTION_ERROR, ALREADY_REG, NOT_REG, BLOCKED כאשר כל ערך יתחיל בשורה חדשה
מספרים שאינם מופיעים בערכים לעיל, היו תקינים והתווספו/נמחקו מרשימת התפוצה