This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
fullapi [2020/08/01 23:02] 127.0.0.1 external edit |
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 | + | Prima di poter usare le API attivale |
{{: | {{: | ||
Webservices URL: | Webservices URL: | ||
- | `https:// | + | `https:// |
- | **[[http:// | + | **[[https:// |
## 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 235: | Line 235: | ||
|Optional | |Optional | ||
|Returns | |Returns | ||
+ | |||
+ | **## Protocol for admin tasks** | ||
+ | |||
+ | |||
+ | ### Inject message | ||
+ | |||
+ | Inject message to the system | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | --------------------| | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | Injected message will be treated as a valid incoming SMS. | ||
+ | |||
+ | ### Stoplist Number | ||
+ | |||
+ | Will add a number to the stoplist. | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | Number used in the ' | ||
+ | example: `https:// | ||
+ | |||
+ | ### Add account | ||
+ | |||
+ | Add an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | Notes: | ||
+ | * most mandatory and optional query parameters are prefixed with `data_` | ||
+ | * data_status 2 is for admin level account | ||
+ | * data_status 3 is for user level account | ||
+ | * data_status 4 is for subuser level account | ||
+ | * data_parent may need to be set when adding subuser level account | ||
+ | |||
+ | |||
+ | ### Remove account | ||
+ | |||
+ | Remove an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Set parent for subuser | ||
+ | |||
+ | Set parent for subuser level account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Get parent from subuser | ||
+ | |||
+ | Get parent from subuser level account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | --------------------| | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Ban an account | ||
+ | |||
+ | Ban an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Unban an account | ||
+ | |||
+ | Unban an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Update account preferences | ||
+ | |||
+ | Update account preferences | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | Notes: | ||
+ | * most mandatory and optional query parameters are prefixed with `data_` | ||
+ | * this command may be used to update account' | ||
+ | |||
+ | |||
+ | ### Update account configuration | ||
+ | |||
+ | Update account configuration | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | Notes: | ||
+ | * most mandatory and optional query parameters are prefixed with `data_` | ||
+ | * this command may be used to update account' | ||
+ | * only valid sender ID may be selected | ||
+ | * `data_fwd_to_inbox` `data_fwd_to_email` `data_fwd_to_mobile` are boolean variables, fill with 0 to disable and 1 to enable | ||
+ | * `data_local_length` used to detect local destination number by its length | ||
+ | * `data_replace_zero` is a numeric only prefix number to replace prefix 0 | ||
+ | |||
+ | |||
+ | ### View account credit | ||
+ | |||
+ | View an account credit or balance | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | --------------------| | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Add account credit | ||
+ | |||
+ | Add credit to an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | --------------------| | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Deduct account credit | ||
+ | |||
+ | Deduct credit to an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | -------------------- | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ### Set login key | ||
+ | |||
+ | Set login key for an account | ||
+ | |||
+ | |Parameters | Name or description| | ||
+ | |---------- | --------------------| | ||
+ | |Operation | ||
+ | |Mandatory | ||
+ | |Optional | ||
+ | |Returns | ||
+ | |||
+ | |||
+ | ## Examples | ||
+ | |||
+ | |||
+ | ### Send SMS | ||
+ | |||
+ | Example webservice URL: | ||
+ | |||
+ | ``` | ||
+ | https:// | ||
+ | ``` | ||
+ | |||
+ | Explanation: | ||
+ | |||
+ | highway webservices in x.dom with operation `op` pv (send SMS) was accessed by a user using username `u` and webservices token `h` with destination number `to` 0987654321, message `msg` 'test only' and expected output format is the default format, JSON format. | ||
+ | |||
+ | When succeeded highway will returns OK status message in JSON format: | ||
+ | |||
+ | ``` | ||
+ | {" | ||
+ | ``` | ||
+ | When error occurred highway will returns one of the return code, also in JSON format. | ||
+ | |||
+ | ##### Scheduled SMS: | ||
+ | |||
+ | Send SMS at 15:30:00 2019-04-29 | ||
+ | |||
+ | ``` | ||
+ | https:// | ||
+ | ``` | ||
+ | Both `+` and `%20` can be used between date and time, but `%20` is recommended. | ||
+ | |||
+ | |||
+ | ### List of incoming SMS | ||
+ | |||
+ | Example webservice URL: | ||
+ | |||
+ | ``` | ||
+ | https:// | ||
+ | ``` | ||
+ | |||
+ | Explanation: | ||
+ | |||
+ | highway webservices in x.com with operation `op` in (incoming SMS) was accessed by a user using username `u` and webservices token `h` with keyword `kwd` IDOL and expected output format is in XML format `format=xml`. | ||
+ | |||
+ | When succeeded highway will returns OK status message in XML format: | ||
+ | |||
+ | ``` | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | ``` | ||
+ | |||
+ | When error occurred highway will returns one of the return code, also in XML format. | ||
+ | |||
+ | |||
+ | ### List of contacts on phonebook | ||
+ | |||
+ | Example webservice URL: | ||
+ | |||
+ | ``` | ||
+ | https:// | ||
+ | ``` | ||
+ | |||
+ | Explanation: | ||
+ | |||
+ | highway webservices in x.com with operation `op` get_contact was accessed by a user using username `u` and webservices token `h` with keyword `kwd` example and expected output format is in JSON format. | ||
+ | |||
+ | When succeeded highway will returns OK status message in JSON format: | ||
+ | |||
+ | ``` | ||
+ | {" | ||
+ | ``` | ||
+ | |||
+ | When error occurred highway will returns one of the return code, also in JS | ||