KDEV SMS API

User Tools

Site Tools

Trace:
fullapi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
fullapi [2020/08/01 23:30]
dcantaluppi 		fullapi [2023/12/29 14:29] (current)
Line 1: Line 1:
 **## ACCESSO API AVANZATE - FULL API** **## ACCESSO API AVANZATE - FULL API**
  
-Prima di poter usare le API attivale in "il mio account > configurazione utente"+Prima di poter usare le API attivale clicca a destra  "sul nome utente > settings > enable webservice" e annota la token che verrà visualizzata in "webservice token"
  
 {{:schermata_2014-10-14_alle_22.24.00.png?600|}} {{:schermata_2014-10-14_alle_22.24.00.png?600|}}
Line 8: Line 8:
 `https://www.smskdev.it/highway/index.php?app=ws` `https://www.smskdev.it/highway/index.php?app=ws`
  
-**[[http://www.smskdev.it/api/lib/exe/fetch.php/webservices_examples.zip|ZIP ARCHIVIO ESEMPI]]**+**[[https://www.smskdev.it/api/lib/exe/fetch.php?media=webservices_examples.zip|ZIP ARCHIVIO ESEMPI]]**
  
 ## Parametri ## Parametri
Line 38: Line 38:
 |kwd            | keyword| |kwd            | keyword|
  
-Listed in the below table are webservices parameters for admin tasks.+**Listed in the below table are webservices parameters for admin tasks.**
  
 |Name           | Description| |Name           | Description|
Line 236: Line 236:
 |Returns    | return codes and balance| |Returns    | return codes and balance|
  
-## Protocol for admin tasks+**## Protocol for admin tasks**
  
  
Line 243: Line 243:
 Inject message to the system Inject message to the system
  
-|Parameters | Name or description +|Parameters | Name or description| 
-|---------- | -------------------- +|---------- | --------------------| 
-|Operation  | `inject` +|Operation  | `inject`| 
-|Mandatory  | `u` `h` `from` `msg` `recvnum` `smsc` +|Mandatory  | `u` `h` `from` `msg` `recvnum` `smsc`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes+|Returns    | return codes|
  
 Injected message will be treated as a valid incoming SMS. Injected message will be treated as a valid incoming SMS.
Line 256: Line 256:
 Will add a number to the stoplist. Will add a number to the stoplist.
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `stoplist` +|Operation  | `stoplist`| 
-|Mandatory  | `u` `h` `from` +|Mandatory  | `u` `h` `from`| 
-|Optional   | none +|Optional   | none| 
-|Returns    |  return codes (failure code is 627)+|Returns    |  return codes (failure code is 627)|
  
 Number used in the 'from' field will be added to the stoplist feature to globally prevent outgoing messages sending to it. Number used in the 'from' field will be added to the stoplist feature to globally prevent outgoing messages sending to it.
Line 270: Line 270:
 Add an account Add an account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountadd` +|Operation  | `accountadd`| 
-|Mandatory  | `u` `h` `data_status` `data_username` `data_password` `data_name` `data_email` +|Mandatory  | `u` `h` `data_status` `data_username` `data_password` `data_name` `data_email`| 
-|Optional   | `format` `data_parent` `data_mobile` `data_datetime_timezone` `data_language_module` +|Optional   | `format` `data_parent` `data_mobile` `data_datetime_timezone` `data_language_module`| 
-|Returns    | return codes and info+|Returns    | return codes and info|
  
 Notes: Notes:
Line 289: Line 289:
 Remove an account Remove an account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountremove` +|Operation  | `accountremove`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes and info+|Returns    | return codes and info|
  
  
Line 301: Line 301:
 Set parent for subuser level account Set parent for subuser level account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `parentset` +|Operation  | `parentset`| 
-|Mandatory  | `u` `h` `data_username` `data_parent` +|Mandatory  | `u` `h` `data_username` `data_parent`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes+|Returns    | return codes|
  
  
Line 313: Line 313:
 Get parent from subuser level account Get parent from subuser level account
  
-|Parameters | Name or description +|Parameters | Name or description| 
-|---------- | -------------------- +|---------- | --------------------| 
-|Operation  | `parentget` +|Operation  | `parentget`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes and data parent+|Returns    | return codes and data parent|
  
  
Line 325: Line 325:
 Ban an account Ban an account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountban` +|Operation  | `accountban`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes+|Returns    | return codes|
  
  
Line 337: Line 337:
 Unban an account Unban an account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountunban` +|Operation  | `accountunban`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes+|Returns    | return codes|
  
  
Line 349: Line 349:
 Update account preferences Update account preferences
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountpref` +|Operation  | `accountpref`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` `data_name` `data_email` `data_mobile` `data_address` `data_city` `data_state` |`data_country` `data_zipcode` `data_password` +|Optional   | `format` `data_name` `data_email` `data_mobile` `data_address` `data_city` `data_state`| |`data_country` `data_zipcode` `data_password`| 
-|Returns    | return codes and info+|Returns    | return codes and info|
  
 Notes: Notes:
Line 365: Line 365:
 Update account configuration Update account configuration
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `accountconf` +|Operation  | `accountconf`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-Optional   | `format` `data_footer` `datetime_timezone` `data_language_module` `data_fwd_to_inbox` `data_fwd_to_email` `data_fwd_to_mobile` `data_local_length` `data_replace_zero` `data_sender`  +|Optional   | `format` `data_footer` `datetime_timezone` `data_language_module` `data_fwd_to_inbox`| |`data_fwd_to_email` `data_fwd_to_mobile` `data_local_length` `data_replace_zero` `data_sender` | 
-Returns    | return codes and info+|Returns    | return codes and info|
  
 Notes: Notes:
Line 385: Line 385:
 View an account credit or balance View an account credit or balance
  
-|Parameters | Name or description +|Parameters | Name or description| 
-|---------- | -------------------- +|---------- | --------------------| 
-|Operation  | `creditview` +|Operation  | `creditview`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes and balance+|Returns    | return codes and balance|
  
  
Line 397: Line 397:
 Add credit to an account Add credit to an account
  
-|Parameters | Name or description +|Parameters | Name or description| 
-|---------- | -------------------- +|---------- | --------------------| 
-|Operation  | `creditadd` +|Operation  | `creditadd`| 
-|Mandatory  | `u` `h` `data_username` `data_amount` +|Mandatory  | `u` `h` `data_username` `data_amount`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes, updated balance and amount+|Returns    | return codes, updated balance and amount|
  
  
Line 409: Line 409:
 Deduct credit to an account Deduct credit to an account
  
-|Parameters | Name or description+|Parameters | Name or description|
 |---------- | -------------------- |---------- | --------------------
-|Operation  | `creditdeduct` +|Operation  | `creditdeduct`| 
-|Mandatory  | `u` `h` `data_username` `data_amount` +|Mandatory  | `u` `h` `data_username` `data_amount`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes, updated balance and amount+|Returns    | return codes, updated balance and amount|
  
  
Line 421: Line 421:
 Set login key for an account Set login key for an account
  
-|Parameters | Name or description +|Parameters | Name or description| 
-|---------- | -------------------- +|---------- | --------------------| 
-|Operation  | `loginkeyset` +|Operation  | `loginkeyset`| 
-|Mandatory  | `u` `h` `data_username` +|Mandatory  | `u` `h` `data_username`| 
-|Optional   | `format` +|Optional   | `format`| 
-|Returns    | return codes and login key+|Returns    | return codes and login key|
  
  
fullapi.1596324628.txt.gz · Last modified: 2023/12/29 14:29 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki