פרוטוקול משימות
Send message
Send message to a single or multiple mobile numbers, @username or #groupcode
| פרמטרים | שם או תיאור |
|---|---|
| Operation | Pv |
| Mandatory | u h to msg |
| Optional | type unicode from footer nofooter format |
| Returns | return codes |
Parameter to can be international formatted mobile number. Separate by commas for multiple value.
Outgoing SMS and delivery status
List outgoing SMS and delivery status.
| פרמטרים | שם או תיאור |
|---|---|
| Operation | Ds |
| Mandatory | u h |
| Optional | queue src dst dt smslog_id c last format |
| Returns | data or return codes |
Parameter c will retrieve as many as c value, last will retrieves data from last SMS log ID.
Incoming SMS
List incoming SMS.
| פרמטרים | שם או תיאור |
|---|---|
| Operation | In |
| Mandatory | u h |
| Optional | queue src dst dt smslog_id c last format |
| Returns | data or return codes |
Parameter c will retrieve as many as c value, last will retrieves data from last SMS log ID.
User credit
Get user's credit information.
| פרמטרים | שם או תיאור |
|---|---|
| Operation | Cr |
| Mandatory | u h |
| Optional | Format |
| Returns | user's credit or return codes |
Get token
Get user's webservices token. This can be used as a login mechanism.
| פרמטרים | שם או תיאור |
|---|---|
| Operation | get_token |
| Mandatory | u p |
| Optional | Format |
| Returns | webservices token or return codes |
Set token
Set user's webservices token. This can be used as a change password mechanism.
| פרמטרים | שם או תיאור |
|---|---|
| Operation | set_token |
| Mandatory | u h |
| Optional | Format |
| Returns | new webservices token or return codes |
Webservices login
Authenticate user via webservices and redirect to index.php upon authentication, successful or failed or invalid
| פרמטרים | שם או תיאור |
|---|---|
| Operation | ws_login |
| Mandatory | u login_key |
| Optional | None |
| Returns | none, web redirect to index.php |
Parameter login_key is set by admin accounts through webservices call using operation 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 |
