הבדלים בין גרסאות בדף "פרוטוקול משימות"
(2 גרסאות ביניים של אותו משתמש אינן מוצגות) | |||
שורה 1: | שורה 1: | ||
=== שליחת הודעה === | === שליחת הודעה === | ||
− | שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או # | + | שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או groupcode#. <br> |
{|border="1" | {|border="1" | ||
שורה 164: | שורה 164: | ||
בשאר הפרמטרים של Playsms Webservice Api ניתן להשתמש כפי שהם מפורטים ב- http://sms.voipe.co.il/index.php?app=ws <br> | בשאר הפרמטרים של Playsms Webservice Api ניתן להשתמש כפי שהם מפורטים ב- http://sms.voipe.co.il/index.php?app=ws <br> | ||
− | + | ||
+ | '''דוגמא לקריאת API''' <br> | ||
+ | POST /playsms/api.php HTTP/1.1 <br> | ||
+ | Host: sms.voipe.co.il <br> | ||
− | + | {"user":"vipuser","token":"1212121212121212121212121212","op":"pv","to":"052111222","msg":"Test message","from":"VipInvest"} | |
− | |||
− | + | ||
− | + | '''מספר הערות''' <br> | |
− | + | * השדה "from" חייב להכיל ערך מוגדר מראש אשר נקבע בפאנל הניהול שלנו ע"י האדמין- לכן יש להתייעץ לגבי שדה זה עם התמיכה שלנו. <br> | |
− | + | * השדה "from" אמור להיות עד 8 תווים. | |
− | |||
=== שליפת אשראי חשבון === | === שליפת אשראי חשבון === |
גרסה אחרונה מ־18:42, 9 במרץ 2021
שליחת הודעה
שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או groupcode#.
פרמטרים | שם או תיאור |
---|---|
Operation | Pv |
Mandatory | u h to msg |
Optional | הקלד unicode מתבנית footer nofooter |
Returns | מחזיר קודים |
הפרמטר "to" יכול להיות מספר נייד בקידוד בינלאומי
SMS יוצא וסטטוס מסירה
פרמטרים | שם או תיאור |
---|---|
Operation | Ds |
Mandatory | u h |
Optional | queue src dst dt smslog_id c last format |
Returns | מחזיר מידע או קודים |
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון
SMS נכנס
פרמטרים | שם או תיאור |
---|---|
Operation | In |
Mandatory | u h |
Optional | queue src dst dt smslog_id c last format |
Returns | מחזיר מידע או קודים |
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון
User credit
שליפת מידע אודות האשראי של המשתמש
פרמטרים | שם או תיאור |
---|---|
Operation | Cr |
Mandatory | u h |
Optional | Format |
Returns | מחזיר אשראי של המשתמש או קודים |
Get token
שליפת טוקן webservices של המשתמש. יכול לשמש כמנגנון התחברות.
פרמטרים | שם או תיאור |
---|---|
Operation | get_token |
Mandatory | u p |
Optional | Format |
Returns | מחזיר טוקן webservices או קודים |
Set token
קביעת טוקן webservices של המשתמש. יכול לשמש כמנגנון שינוי סיסמא.
פרמטרים | שם או תיאור |
---|---|
Operation | set_token |
Mandatory | u h |
Optional | Format |
Returns | מחזיר טוקן webservices חדש או קודים |
התחברות Webservices
אימות משתמש באמצעות webservices והפניה לindex.php עם האימות, מוצלח, נכשל או לא תקין.
פרמטרים | שם או תיאור |
---|---|
Operation | ws_login |
Mandatory | u login_key |
Optional | None |
Returns | אין החזרות, הפניה ל- index.php |
הפרמטר login_key מוגדר על ידי חשבונות אדמין דרך קריאת webservices בשימוש הפעולה loginkeyset
JSON HTTPS
חייב להיות שימוש ב HTTPS במקום HTTP.
ה-URL הבסיסי חייב להיות:
https://sms.voipe.co.il/playsms/api.php
כל הפרמטרים אמורים להיות מועברים כחלק מאובייקט JSON בגוף POST ולא ב-GET.
את הפרמטרים הבאים יש לשנות:
1. "user" במקום "u".
2. "token" במקום "h".
בשאר הפרמטרים של Playsms Webservice Api ניתן להשתמש כפי שהם מפורטים ב- http://sms.voipe.co.il/index.php?app=ws
דוגמא לקריאת API
POST /playsms/api.php HTTP/1.1
Host: sms.voipe.co.il
{"user":"vipuser","token":"1212121212121212121212121212","op":"pv","to":"052111222","msg":"Test message","from":"VipInvest"}
מספר הערות
- השדה "from" חייב להכיל ערך מוגדר מראש אשר נקבע בפאנל הניהול שלנו ע"י האדמין- לכן יש להתייעץ לגבי שדה זה עם התמיכה שלנו.
- השדה "from" אמור להיות עד 8 תווים.
שליפת אשראי חשבון
פרמטרים | שם או תיאור |
---|---|
Operation | creditview |
Mandatory | u h data_username |
Optional | Format |
Returns | מחזיר קודים ויתרה |