הבדלים בין גרסאות בדף "VoIPe SMS API"

מתוך wiki.voipe.co.il
 
(6 גרסאות ביניים של אותו משתמש אינן מוצגות)
שורה 1: שורה 1:
−
הסבר על פרוטוקול VoIPe SMS Webservices
+
== גישה ==
 +
Webservices URL: https://sms.voipe.co.il/playsms/index.php?app=ws
  
−
=== גישה ===
+
== פרמטרים ==
−
Webservices URL: http://sms.voipe.co.il/index.php?app=ws
+
בטבלה הבאה מפורטים הפרמטרים של ה webservices.
−
 
 
−
=== פרמטרים ===
 
−
בטבלה הבאה מפורטים הפרמטרים של ה webservices למשימות אינדיווידואליות.
 
  
 
{|border="1"  
 
{|border="1"  
שורה 12: שורה 10:
 
!תיאור
 
!תיאור
 
|-
 
|-
−
|h
+
|h  
−
|webservices token, configured by user from Preferences menu
+
|טוקן ה webservices, מוגדר על ידי המשתמש בתפריט "העדפות"
 
|-
 
|-
 
|u
 
|u
 
|שם משתמש
 
|שם משתמש
 
|-
 
|-
−
|p
+
|p  
−
|password, supplied for op=get_token
+
|סיסמא, מסופקת עבור op=get_token
 
|-
 
|-
 
|op
 
|op
−
|operation or type of action
+
|פעולה או סוג של פעולה
−
|-
+
|-  
 
|format
 
|format
−
|output format selection
+
|בחירת פורמט פלא
 
|-
 
|-
 
|from
 
|from
−
|SMS sender ID (for op=pv)
+
|מזהה שולח הSMS עבור op=pv
−
|-
+
|-  
 
|to
 
|to
−
|destination numbers may use commas
+
|מספרי היעד, אפשר להשתמש בפסיקים
 
|-
 
|-
 
|footer
 
|footer
−
|SMS footer (for op=pv)
+
|כותרת תחתונה של הSMS עבור op=pv
 
|-
 
|-
 
|nofooter
 
|nofooter
−
|remove SMS footer
+
|הסרת הכותרת התחתונה בSMS
 
|-
 
|-
 
|msg
 
|msg
−
|message (+ or %20 for spaces, urlencode for non ascii chars)
+
|הודעה (+ או %20 עבור רווחים, urlencode עבור תווים שאינם ascii)
 
|-
 
|-
 
|schedule
 
|schedule
−
|schedule message delivery, format: YYYY-MM-DD hh:mm:ss
+
|תזמון מסירת ההודעה, בתבנית YYYY-MM-DD hh:mm:ss  
−
|-
+
|-  
 
|type
 
|type
−
|message type (flash or text)
+
|סוג ההודעה (flash או text)
−
|-
+
|-  
 
|unicode
 
|unicode
−
|whether message unicode or not (1=unicode, 0=not unicode)
+
|ציון האם ההודעה unicode או לא (0=unicode=1, not unicode)
−
|-
+
|-  
 
|queue
 
|queue
−
|queue code
+
|קוד תור
 
|-
 
|-
 
|src
 
|src
−
|sender number or ID
+
|מזהה או מספר השולח
−
|-
+
|-  
 
|dst
 
|dst
−
|destination number (single number)
+
|מספר היעד (מספר יחיד)
 
|-
 
|-
 
|dt
 
|dt
−
|send SMS date/time
+
|תאריך ושעת שליחת הSMS
−
|-
+
|-  
 
|smslog_id
 
|smslog_id
 
|SMS Log ID
 
|SMS Log ID
 
|-
 
|-
 
|last
 
|last
−
|last SMS log ID (this number not included on result)
+
|מזהה SMS LOG האחרון (המספר הזה לא כלול בתוצאה)
 
|-
 
|-
 
|c
 
|c
−
|number of delivery status that will be retrieved
+
|מספר סטטוס המסירה שיוחזר
−
|-
+
|-  
 
|kwd
 
|kwd
−
|Keyword
+
|מילת מפתח
 
|-
 
|-
 
|login_key
 
|login_key
−
|login key sets by admin through webservices call op=loginkeyset
+
|מפתח התחברות מוגדר על ידי האדמין דרך קריאת op=loginkeyse -webservices
 
|-
 
|-
 
|query
 
|query
−
|query server for useful information
+
|שרת שאילתות עבור מידע שימושי
 
|}
 
|}
  
−
=== קודי החזרה ===
+
== קודי החזרה ==
−
Below table listed return coded after unsuccessful call to a webservices operation. Successful operation will returns an OK data in the response message.
+
בטבלה הבאה מפורטים קודי שגיאות שמוחזרים אחרי קריאה לפעולת webservices שלא צלחה. <br>
−
Please note that by default the response message is a JSON encoded message.
+
פעולה שבוצעה בהצלחה תחזיר OK בהודעת התגובה. <br>
−
 
+
שימו לב, ברירת המחדל של הודעה התגובה היא הודעה מקודדת של JSON. <br>
 
{|border="1"  
 
{|border="1"  
 
|-
 
|-
שורה 95: שורה 93:
 
|-
 
|-
 
|ERR 101
 
|ERR 101
−
|type of action is invalid or unknown
+
|סוג הפעולה לא תקין או לא ידוע
 
|-
 
|-
 
|ERR 102
 
|ERR 102
−
|one or more field empty
+
|שדה אחד או יותר ריק
 
|-
 
|-
 
|ERR 103
 
|ERR 103
−
|not enough credit for this operation
+
|אין מספיק אשראי לפעולה זו
 
|-
 
|-
 
|ERR 104
 
|ERR 104
−
|webservice token is not available
+
|טוקן webservice לא זמין
 
|-
 
|-
 
|ERR 105
 
|ERR 105
−
|webservice token not enable for this user
+
|טוקן webservice לא מופעל עבור המשתמש
 
|-
 
|-
 
|ERR 106
 
|ERR 106
−
|webservice token not allowed from this IP address
+
|טוקן webservice לא מאופשר עבור כתובת הIP
 
|-
 
|-
 
|ERR 200
 
|ERR 200
−
|send message failed
+
|שליחת ההודעה נכשלה
 
|-
 
|-
 
|ERR 201
 
|ERR 201
−
|destination number or message is empty
+
|מספר היעד או ההודעה ריקים
 
|-
 
|-
 
|ERR 400
 
|ERR 400
−
|no delivery status available
+
|אין סטטוס מסירה זמין
 
|-
 
|-
 
|ERR 401
 
|ERR 401
−
|no delivery status retrieved and SMS still in queue
+
|לא הוחזר ססטוס מסירה והSMS עדיין בתור
 
|-
 
|-
 
|ERR 402
 
|ERR 402
−
|no delivery status retrieved and SMS has been processed from queue
+
|לא הוחזר ססטוס מסירה והSMS יצא מהתור
 
|-
 
|-
 
|ERR 501
 
|ERR 501
−
|no data returned or result is empty
+
|לא הוחזר מידע או התוצאה ריקה
 
|-
 
|-
 
|ERR 600
 
|ERR 600
−
|admin level authentication failed
+
|שלב אימות האדמין נכשל
 
|-
 
|-
 
|ERR 601
 
|ERR 601
−
|inject message failed
+
|הזרקת ההודעה נכשלה
 
|-
 
|-
 
|ERR 602
 
|ERR 602
−
|sender id or message is empty
+
|מזהה השולח או ההודעה ריקים
 
|-
 
|-
 
|ERR 603
 
|ERR 603
−
|account addition failed due to missing data
+
|הוספת חשבון נכשלה עקב מידע חסר
 
|-
 
|-
 
|ERR 604
 
|ERR 604
−
|fail to add account
+
|הוספת חשבון נכשלה
 
|-
 
|-
 
|ERR 605
 
|ERR 605
−
|account removal failed due to unknown username
+
|מחיקת חשבון נכשלה עקב שם משתמש לא ידוע
 
|-
 
|-
 
|ERR 606
 
|ERR 606
−
|fail to remove account
+
|מחיקת חשבון נכשלה
 
|-
 
|-
 
|ERR 607
 
|ERR 607
−
|set parent failed due to unknown username
+
|הוספת הורה נכשלה עקב שם משתמש לא ידוע
 
|-
 
|-
 
|ERR 608
 
|ERR 608
−
|fail to set parent
+
|קביעה הורה נכשלה
 
|-
 
|-
 
|ERR 609
 
|ERR 609
−
|get parent failed due to unknown username
+
|שליפת הורה נכשלה עקב שם משתמש לא ידוע
 
|-
 
|-
 
|ERR 610
 
|ERR 610
−
|fail to get parent
+
|שליפת הורה נכשלה
 
|-
 
|-
 
|ERR 611
 
|ERR 611
−
|account ban failed due to unknown username
+
|חסימת חשבון נכשלה עקב שם משתמש לא ידוע
 
|-
 
|-
 
|ERR 612
 
|ERR 612
−
|fail to ban account
+
|חסימת חשבון נכשלה
 
|-
 
|-
 
|ERR 613
 
|ERR 613
−
|account unban failed due to unknown username
+
|ביטול חסימת חשבון נכשלה עקב שם משתמש לא ידוע
 
|-
 
|-
 
|ERR 614
 
|ERR 614
−
|fail to unban account
+
|ביטול חסימת חשבון נכשלה
 
|-
 
|-
 
|ERR 615
 
|ERR 615
−
|editing account preferences failed due to missing data
+
|עריכת העדפות חשבון נכשלה עקב שם מידע חסר
 
|-
 
|-
 
|ERR 616
 
|ERR 616
−
|fail to edit account preferences
+
|עריכת העדפות חשבון נכשלה
 
|-
 
|-
 
|ERR 617
 
|ERR 617
−
|editing account configuration failed due to missing data
+
|עריכת תצורת חשבון נכשלה עקב שם מידע חסר
 
|-
 
|-
 
|ERR 618
 
|ERR 618
−
|fail to edit account configuration
+
|עריכת תצורת חשבון נכשלה
 
|-
 
|-
 
|ERR 619
 
|ERR 619
−
|viewing credit failed due to missing data
+
|הצגת אשראי נכשלה עקב מידע חסר
 
|-
 
|-
 
|ERR 620
 
|ERR 620
−
|fail to view credit
+
|הצגת אשראי נכשלה
 
|-
 
|-
 
|ERR 621
 
|ERR 621
−
|adding credit failed due to missing data
+
|הוספת אשראי נכשלה עקב מידע חסר
 
|-
 
|-
 
|ERR 622
 
|ERR 622
−
|fail to add credit
+
|הוספת אשראי נכשלה
 
|-
 
|-
 
|ERR 623
 
|ERR 623
−
|deducting credit failed due to missing data
+
|ניכוי אשראי נכשל עקב מידע חסר
 
|-
 
|-
 
|ERR 624
 
|ERR 624
−
|fail to deduct credit
+
|ניכוי אשראי נכשל
 
|-
 
|-
 
|ERR 625
 
|ERR 625
−
|setting login key failed due to missing data
+
|הגדרת קוד התחברות נכשלה עקב מידע חסר
 
|-
 
|-
 
|ERR 626
 
|ERR 626
−
|fail to set login key
+
|הגדרת קוד התחברות נכשלה
 
|}
 
|}
  
−
 
+
בעתיד יכולים להיות קודי שגיאות נוספים, הקודים הנוספים יופיעו בתבנית הבאה:
−
There might appear new error codes in the future, you should be aware that new codes might appear in this syntax:
 
  
 
{|border="1"  
 
{|border="1"  
שורה 221: שורה 218:
 
|-
 
|-
 
|ERR 1xx
 
|ERR 1xx
−
|authentication or parameter erorrs
+
|שגיאות אימות או פרמטרים
 
|-
 
|-
 
|ERR 2xx
 
|ERR 2xx
−
|specific pv errors
+
|שגיאות pv ספציפיות
 
|-
 
|-
 
|ERR 4xx
 
|ERR 4xx
−
| delivery status errors
+
|שגיאות סטטוס מסירה
 
|-
 
|-
 
|ERR 5xx
 
|ERR 5xx
−
|Others
+
|אחרים
 
|-
 
|-
 
|ERR 6xx
 
|ERR 6xx
−
|administrative tasks
+
|משימות מנהליות
 +
|}
 +
 
 +
= פרוטוקול משימות =
 +
== שליחת הודעה ==
 +
שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או groupcode#. <br>
 +
 
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|Pv
 +
|-
 +
|Mandatory
 +
|u h to msg
 +
|-
 +
|Optional
 +
|הקלד unicode מתבנית footer nofooter
 +
|-
 +
|Returns
 +
|מחזיר קודים
 +
|}
 +
 
 +
הפרמטר "to" יכול להיות מספר נייד בקידוד בינלאומי.
 +
 
 +
== SMS יוצא וסטטוס מסירה ==
 +
רשימת SMS יוצא וסטטוס מסירה. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|Ds
 +
|-
 +
|Mandatory
 +
|u h
 +
|-
 +
|Optional
 +
|queue src dst dt smslog_id c last format
 +
|-
 +
|Returns
 +
|מחזיר מידע או קודים
 +
|}
 +
 
 +
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון.
 +
 
 +
== SMS נכנס ==
 +
רשימת SMS נכנס. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|In
 +
|-
 +
|Mandatory
 +
|u h
 +
|-
 +
|Optional
 +
|queue src dst dt smslog_id c last format
 +
|-
 +
|Returns
 +
|מחזיר מידע או קודים
 +
|}
 +
 
 +
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון.
 +
 
 +
== User credit ==
 +
שליפת מידע אודות האשראי של המשתמש. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|Cr
 +
|-
 +
|Mandatory
 +
|u h
 +
|-
 +
|Optional
 +
|Format
 +
|-
 +
|Returns
 +
|מחזיר אשראי של המשתמש או קודים
 +
|}
 +
 
 +
== Get token ==
 +
שליפת טוקן webservices של המשתמש. יכול לשמש כמנגנון התחברות. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|get_token
 +
|-
 +
|Mandatory
 +
|u p
 +
|-
 +
|Optional
 +
|Format
 +
|-
 +
|Returns
 +
|מחזיר טוקן webservices או קודים
 +
|}
 +
 
 +
== Set token ==
 +
קביעת טוקן webservices של המשתמש. יכול לשמש כמנגנון שינוי סיסמא. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|set_token
 +
|-
 +
|Mandatory
 +
|u h
 +
|-
 +
|Optional
 +
|Format
 +
|-
 +
|Returns
 +
|מחזיר טוקן webservices חדש או קודים
 +
|}
 +
 
 +
== התחברות Webservices ==
 +
אימות משתמש באמצעות webservices והפניה לindex.php עם האימות, מוצלח, נכשל או לא תקין. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|ws_login
 +
|-
 +
|Mandatory
 +
|u login_key
 +
|-
 +
|Optional
 +
|None
 +
|-
 +
|Returns
 +
|אין החזרות, הפניה ל- index.php
 
|}
 
|}
 +
 +
הפרמטר login_key מוגדר על ידי חשבונות אדמין דרך קריאת webservices בשימוש הפעולה loginkeyset.
 +
 +
== JSON HTTPS ==
 +
חייב להיות שימוש ב HTTPS במקום HTTP. <br>
 +
ה-URL הבסיסי חייב להיות: <br>
 +
https://sms.voipe.co.il/playsms/api.php <br>
 +
כל הפרמטרים אמורים להיות מועברים כחלק מאובייקט JSON בגוף POST ולא ב-GET. <br>
 +
את הפרמטרים הבאים יש לשנות: <br>
 +
1. "user" במקום "u". <br>
 +
2. "token" במקום "h". <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 תווים.
 +
 +
== שליפת אשראי חשבון ==
 +
הצגת אשראי או יתרה של חשבון. <br>
 +
{|border="1"
 +
|-
 +
!פרמטרים
 +
!שם או תיאור
 +
|-
 +
|Operation
 +
|creditview
 +
|-
 +
|Mandatory
 +
|u h data_username
 +
|-
 +
|Optional
 +
|Format
 +
|-
 +
|Returns
 +
|מחזיר קודים ויתרה
 +
|}
 +
 +
= דוגמאות =
 +
== שליחת SMS ==
 +
'''דוגמא ל webservice URL:''' <br>
 +
http://sms.voipe.co.il/index.php?app=ws&u=anton&h=a45a02791b2fe2fedb078c39fd83637a&op=pv&to=0987654321&msg=test+only <br>
 +
 +
'''הסבר''' <br>
 +
VoIPe SMS  webservices ב-sms.voipe.co.il עם הפעולה op pv (שליחת SMS) נקרא עם הפרמטרים: <br>
 +
1. שם משתמש "u". <br>
 +
2. טוקן "h". <br>
 +
3. מספר יעד 050555555. <br>
 +
4. ההודעה "test only". <br>
 +
5. תבנית הפלט היא תבנית ברירת המחדל- JSON. <br>
 +
 +
כשהSMS נשלח בהצלחה VoUPe SMS יחזיר הודעת סטטוס OK בבתנית JSON: <br>
 +
{"data":[{"status":"OK","error":"0","smslog_id":"30","queue":"afb5f34575e30ec4efe4471cf5d1bee4","to":"0987654321"}],"error_string":null} <br>
 +
 +
במקרה ששגיאה אירעה, VoIPe SMS יחזיר את אחד מקודי ההחזרה בתבנית JSON.
 +
 +
== רשימת SMS נכנס ==
 +
'''דוגמא ל webservice URL:''' <br>
 +
http://x.com/index.php?app=ws&u=anton&h=482ac0069592c647289e52dfef88be68&op=in&kwd=IDOL&format=xml <br>
 +
'''הסבר''' <br>
 +
VoIPe SMS webservices ב x.com עם הפעולה op in (סמס נכנס) נקרא עם הפרמטרים: <br>
 +
1. שם משתמש "u". <br>
 +
2. טוקן "h". <br>
 +
3. מילת מפתח kwd. <br>
 +
4. תבנית הפלט ב XML. <br>
 +
 +
בעת הצלחה VoIPe SMS יחזיר הודעת סטטוס OK בבתנית XML: <br>
 +
[[File:Xml.png|800px|right|thumb|]]
 +
 +
<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
 +
במקרה ששגיאה אירעה, VoIPe SMS יחזיר את אחד מקודי ההחזרה בתבנית XML.

גרסה אחרונה מ־06:19, 25 באפריל 2021

גישה

Webservices URL: https://sms.voipe.co.il/playsms/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 משימות מנהליות

פרוטוקול משימות

שליחת הודעה

שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או groupcode#.

פרמטרים שם או תיאור
Operation Pv
Mandatory u h to msg
Optional הקלד unicode מתבנית footer nofooter
Returns מחזיר קודים

הפרמטר "to" יכול להיות מספר נייד בקידוד בינלאומי.

SMS יוצא וסטטוס מסירה

רשימת SMS יוצא וסטטוס מסירה.

פרמטרים שם או תיאור
Operation Ds
Mandatory u h
Optional queue src dst dt smslog_id c last format
Returns מחזיר מידע או קודים

הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון.

SMS נכנס

רשימת 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 מחזיר קודים ויתרה

דוגמאות

שליחת SMS

דוגמא ל webservice URL:
http://sms.voipe.co.il/index.php?app=ws&u=anton&h=a45a02791b2fe2fedb078c39fd83637a&op=pv&to=0987654321&msg=test+only

הסבר
VoIPe SMS webservices ב-sms.voipe.co.il עם הפעולה op pv (שליחת SMS) נקרא עם הפרמטרים:
1. שם משתמש "u".
2. טוקן "h".
3. מספר יעד 050555555.
4. ההודעה "test only".
5. תבנית הפלט היא תבנית ברירת המחדל- JSON.

כשהSMS נשלח בהצלחה VoUPe SMS יחזיר הודעת סטטוס OK בבתנית JSON:
{"data":[{"status":"OK","error":"0","smslog_id":"30","queue":"afb5f34575e30ec4efe4471cf5d1bee4","to":"0987654321"}],"error_string":null}

במקרה ששגיאה אירעה, VoIPe SMS יחזיר את אחד מקודי ההחזרה בתבנית JSON.

רשימת SMS נכנס

דוגמא ל webservice URL:
http://x.com/index.php?app=ws&u=anton&h=482ac0069592c647289e52dfef88be68&op=in&kwd=IDOL&format=xml
הסבר
VoIPe SMS webservices ב x.com עם הפעולה op in (סמס נכנס) נקרא עם הפרמטרים:
1. שם משתמש "u".
2. טוקן "h".
3. מילת מפתח kwd.
4. תבנית הפלט ב XML.

בעת הצלחה VoIPe SMS יחזיר הודעת סטטוס OK בבתנית XML:

Xml.png


























במקרה ששגיאה אירעה, VoIPe SMS יחזיר את אחד מקודי ההחזרה בתבנית XML.

אוחזר מתוך "http://wiki.voipe.co.il/index.php?title=VoIPe_SMS_API&oldid=1163"