הבדלים בין גרסאות בדף "פרוטוקול משימות"

מתוך wiki.voipe.co.il
 
(6 גרסאות ביניים של אותו משתמש אינן מוצגות)
שורה 1: שורה 1:
  
−
=== Send message ===
+
=== שליחת הודעה ===
−
Send message to a single or multiple mobile numbers, @username or #groupcode
+
שליחת הודעה למספר יחיד או מספרי נייד מרובים, username@ או groupcode#. <br>
  
 
{|border="1"  
 
{|border="1"  
שורה 15: שורה 15:
 
|-
 
|-
 
|Optional
 
|Optional
−
|type unicode from footer nofooter format
+
|הקלד unicode מתבנית footer nofooter
 
|-
 
|-
 
|Returns
 
|Returns
−
|return codes
+
|מחזיר קודים
 
|}
 
|}
  
−
Parameter to can be international formatted mobile number. Separate by commas for multiple value.
+
הפרמטר "to" יכול להיות מספר נייד בקידוד בינלאומי
  
−
=== Outgoing SMS and delivery status ===
+
=== SMS יוצא וסטטוס מסירה ===
−
List outgoing SMS and delivery status.
 
  
 
{|border="1"  
 
{|border="1"  
שורה 41: שורה 40:
 
|-
 
|-
 
|Returns
 
|Returns
−
|data or return codes
+
|מחזיר מידע או קודים
 
|}
 
|}
  
−
Parameter c will retrieve as many as c value, last will retrieves data from last SMS log ID.
+
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון
  
−
=== Incoming SMS ===
+
=== SMS נכנס ===
−
List incoming SMS.
 
  
 
{|border="1"  
 
{|border="1"  
שורה 64: שורה 62:
 
|-
 
|-
 
|Returns
 
|Returns
−
|data or return codes
+
|מחזיר מידע או קודים
 
|}
 
|}
  
−
Parameter c will retrieve as many as c value, last will retrieves data from last SMS log ID.
+
הפרמטר c יאחזר מספר פעמים כהערך c, האחרון יאחזר מידע מהSMS LOG ID האחרון
  
 
=== User credit ===  
 
=== User credit ===  
−
Get user's credit information.
+
שליפת מידע אודות האשראי של המשתמש
  
 
{|border="1"  
 
{|border="1"  
שורה 87: שורה 85:
 
|-
 
|-
 
|Returns
 
|Returns
−
|user's credit or return codes
+
|מחזיר אשראי של המשתמש או קודים
 
|}
 
|}
  
 
=== Get token ===
 
=== Get token ===
−
Get user's webservices token. This can be used as a login mechanism.
+
שליפת טוקן webservices של המשתמש. יכול לשמש כמנגנון התחברות.
  
 
{|border="1"  
 
{|border="1"  
שורה 108: שורה 106:
 
|-
 
|-
 
|Returns
 
|Returns
−
|webservices token or return codes
+
|מחזיר טוקן webservices או קודים
 
|}
 
|}
  
 
=== Set token ===
 
=== Set token ===
−
Set user's webservices token. This can be used as a change password mechanism.
+
קביעת טוקן webservices של המשתמש. יכול לשמש כמנגנון שינוי סיסמא.
  
 
{|border="1"  
 
{|border="1"  
שורה 129: שורה 127:
 
|-
 
|-
 
|Returns
 
|Returns
−
|new webservices token or return codes
+
|מחזיר טוקן webservices חדש או קודים
 
|}
 
|}
  
−
=== Webservices login ===
+
=== התחברות Webservices ===
−
Authenticate user via webservices and redirect to index.php upon authentication, successful or failed or invalid
+
אימות משתמש באמצעות webservices והפניה לindex.php עם האימות, מוצלח, נכשל או לא תקין.
  
 
{|border="1"  
 
{|border="1"  
שורה 150: שורה 148:
 
|-
 
|-
 
|Returns
 
|Returns
−
|none, web redirect to index.php
+
|אין החזרות, הפניה ל- index.php
 
|}
 
|}
  
−
Parameter login_key is set by admin accounts through webservices call using operation loginkeyset
+
הפרמטר login_key מוגדר על ידי חשבונות אדמין דרך קריאת webservices בשימוש הפעולה loginkeyset
  
−
=== JSON HTTPS Supprot ===
+
=== JSON HTTPS ===
−
Must be used HTTPS instead of HTTP
+
חייב להיות שימוש ב HTTPS במקום HTTP. <br>
−
Basic URL must be
+
ה-URL הבסיסי חייב להיות: <br>
−
https://sms.voipe.co.il/playsms/api.php
+
https://sms.voipe.co.il/playsms/api.php <br>
−
All parameters must be transferred not as GET parameters but as part of JSON object in POST body
+
כל הפרמטרים אמורים להיות מועברים כחלק מאובייקט JSON בגוף POST ולא ב-GET. <br>
−
These parameters needs to be changed
+
את הפרמטרים הבאים יש לשנות: <br>
−
a) “user” instead of “u”
+
1. "user" במקום "u". <br>
−
b) “token” instead of “h”
+
2. "token" במקום "h". <br>
−
Other parameters of Playsms Webservice Api can be used as it is described in corresponding link mentioned early in this doc
+
 
 +
בשאר הפרמטרים של 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>
 
   
 
   
−
Example of API call
+
{"user":"vipuser","token":"1212121212121212121212121212","op":"pv","to":"052111222","msg":"Test message","from":"VipInvest"}
 
   
 
   
−
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"}'
 
−
 
−
Few notes
 
−
field “from” must contain predefined value wich is set in our panel by our administrator - so this field must be discussed with our responsible person
 
−
field “from” must be not more then 8 latin symbols
 
  
−
=== View account credit ===  
+
'''מספר הערות''' <br>
−
View an account credit or balance
+
* השדה "from" חייב להכיל ערך מוגדר מראש אשר נקבע בפאנל הניהול שלנו ע"י האדמין- לכן יש להתייעץ לגבי שדה זה עם התמיכה שלנו. <br>
 +
* השדה "from" אמור להיות עד 8 תווים.
 +
 
 +
=== שליפת אשראי חשבון ===  
  
 
{|border="1"  
 
{|border="1"  
שורה 194: שורה 193:
 
|-
 
|-
 
|Returns
 
|Returns
−
|return codes and balance
+
|מחזיר קודים ויתרה
 
|}
 
|}

גרסה אחרונה מ־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 מחזיר קודים ויתרה
אוחזר מתוך "http://wiki.voipe.co.il/index.php?title=פרוטוקול_משימות&oldid=1147"