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

מתוך wiki.voipe.co.il
שורה 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 Supprot ===

גרסה מ־08:39, 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 Supprot

Must be used HTTPS instead of HTTP Basic URL must be https://sms.voipe.co.il/playsms/api.php All parameters must be transferred not as GET parameters but as part of JSON object in POST body These parameters needs to be changed a) “user” instead of “u” b) “token” instead of “h” Other parameters of Playsms Webservice Api can be used as it is described in corresponding link mentioned early in this doc

Example of API call

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

View an account credit or balance

פרמטרים שם או תיאור
Operation creditview
Mandatory u h data_username
Optional Format
Returns return codes and balance