VoIPe SMS API
מתוך wiki.voipe.co.il
הסבר על פרוטוקול VoIPe SMS Webservices
גישה
Webservices URL: http://sms.voipe.co.il/index.php?app=ws
פרמטרים
בטבלה הבאה מפורטים הפרמטרים של ה webservices.
| שם | תיאור |
|---|---|
| h | טוקן ה webservices, מוגדר על ידי המשתמש בתפריט "העדפות" |
| u | שם משתמש |
| p | סיסמא, מסופקת עבור op=get_token |
| op | פעולה או סוג של פעולה |
| format | בחירת פורמט פלא |
| from | מזהה שולח הSMS עבור op=pv |
| to | מספרי היעד, אפשר להשתמש בפסיקים |
| footer | כותרת תחתונה של הSMS עבור op=pv |
| nofooter | הסרת הכותרת התחתונה בSMS |
| msg | הודעה (+ או %20 עבור רווחים, urlencode עבור תווים שאינם ascii) |
| schedule | תזמון מסירת ההודעה, בתבנית YYYY-MM-DD hh:mm:ss |
| type | סוג ההודעה (flash או text) |
| unicode | ציון האם ההודעה unicode או לא (0=unicode=1, not unicode) |
| queue | קוד תור |
| src | מזהה או מספר השולח |
| dst | מספר היעד (מספר יחיד) |
| dt | תאריך ושעת שליחת הSMS |
| smslog_id | SMS Log ID |
| last | מזהה SMS LOG האחרון (המספר הזה לא כלול בתוצאה) |
| c | מספר סטטוס המסירה שיוחזר |
| kwd | מילת מפתח |
| login_key | מפתח התחברות מוגדר על ידי האדמין דרך קריאת op=loginkeyse -webservices |
| query | שרת שאילתות עבור מידע שימושי |
קודי החזרה
בטבלה הבאה מפורטים קודי שגיאות שמוחזרים אחרי קריאה לפעולת webservices שלא צלחה.
פעולה שבוצעה בהצלחה תחזיר OK בהודעת התגובה.
שימו לב, ברירת המחדל של הודעה התגובה היא הודעה מקודדת של JSON.
| קוד שגיאה | תיאור |
|---|---|
| ERR 100 | אימות נכשל |
| ERR 101 | סוג הפעולה לא תקין או לא ידוע |
| ERR 102 | שדה אחד או יותר ריק |
| ERR 103 | אין מספיק אשראי לפעולה זו |
| ERR 104 | טוקן webservice לא זמין |
| ERR 105 | טוקן webservice לא מופעל עבור המשתמש |
| ERR 106 | טוקן webservice לא מאופשר עבור כתובת הIP |
| ERR 200 | שליחת ההודעה נכשלה |
| ERR 201 | מספר היעד או ההודעה ריקים |
| ERR 400 | אין סטטוס מסירה זמין |
| ERR 401 | לא הוחזר ססטוס מסירה והSMS עדיין בתור |
| ERR 402 | לא הוחזר ססטוס מסירה והSMS יצא מהתור |
| ERR 501 | לא הוחזר מידע או התוצאה ריקה |
| ERR 600 | שלב אימות האדמין נכשל |
| ERR 601 | הזרקת ההודעה נכשלה |
| ERR 602 | מזהה השולח או ההודעה ריקים |
| ERR 603 | הוספת חשבון נכשלה עקב מידע חסר |
| ERR 604 | הוספת חשבון נכשלה |
| ERR 605 | מחיקת חשבון נכשלה עקב שם משתמש לא ידוע |
| ERR 606 | מחיקת חשבון נכשלה |
| ERR 607 | הוספת הורה נכשלה עקב שם משתמש לא ידוע |
| ERR 608 | קביעה הורה נכשלה |
| ERR 609 | שליפת הורה נכשלה עקב שם משתמש לא ידוע |
| ERR 610 | שליפת הורה נכשלה |
| ERR 611 | חסימת חשבון נכשלה עקב שם משתמש לא ידוע |
| ERR 612 | חסימת חשבון נכשלה |
| ERR 613 | ביטול חסימת חשבון נכשלה עקב שם משתמש לא ידוע |
| ERR 614 | ביטול חסימת חשבון נכשלה |
| ERR 615 | עריכת העדפות חשבון נכשלה עקב שם מידע חסר |
| ERR 616 | עריכת העדפות חשבון נכשלה |
| ERR 617 | עריכת תצורת חשבון נכשלה עקב שם מידע חסר |
| ERR 618 | עריכת תצורת חשבון נכשלה |
| ERR 619 | הצגת אשראי נכשלה עקב מידע חסר |
| ERR 620 | הצגת אשראי נכשלה |
| ERR 621 | הוספת אשראי נכשלה עקב מידע חסר |
| ERR 622 | הוספת אשראי נכשלה |
| ERR 623 | ניכוי אשראי נכשל עקב מידע חסר |
| ERR 624 | ניכוי אשראי נכשל |
| ERR 625 | הגדרת קוד התחברות נכשלה עקב מידע חסר |
| ERR 626 | הגדרת קוד התחברות נכשלה |
בעתיד יכולים להיות קודי שגיאות נוספים, הקודים הנוספים יופיעו בתבנית הבאה:
| קוד שגיאה | תיאור |
|---|---|
| ERR 1xx | שגיאות אימות או פרמטרים |
| ERR 2xx | שגיאות pv ספציפיות |
| ERR 4xx | שגיאות סטטוס מסירה |
| ERR 5xx | אחרים |
| ERR 6xx | משימות מנהליות |
