This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
invio_php_http_get [2020/08/01 22:57] dcantaluppi created |
invio_php_http_get [2020/08/01 23:00] dcantaluppi |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | Access | + | **# WEBSERVICES** |
- | Webservices URL: https:// | + | |
+ | This document explains webservices protocol. | ||
+ | |||
+ | |||
+ | **## Access** | ||
+ | |||
+ | Webservices URL: | ||
+ | `https:// | ||
+ | |||
+ | |||
+ | ## Parameters | ||
- | Parameters | ||
Listed in the below table are webservices parameters for individual tasks. | Listed in the below table are webservices parameters for individual tasks. | ||
- | Name Description | + | Name | Description |
- | h webservices token, configured by user from Preferences menu | + | -------------- | -------------- |
- | u username | + | h |
- | p password, supplied for op=get_token | + | u |
- | op operation or type of action | + | p |
- | format output format selection | + | op | operation or type of action |
- | from SMS sender ID (for op=pv) | + | format |
- | to destination numbers, @username or #groupcode, may use commas | + | from |
- | footer SMS footer (for op=pv) | + | to | destination numbers, @username or #groupcode, may use commas |
- | nofooter remove SMS footer | + | footer |
- | msg message (+ or %20 for spaces, urlencode for non ascii chars) | + | nofooter |
- | schedule schedule message delivery, format: YYYY-MM-DD hh:mm:ss | + | msg |
- | type message type (flash or text) | + | schedule |
- | unicode whether message unicode or not (1=unicode, 0=not unicode) | + | type | message type (flash or text) |
- | queue queue code | + | unicode |
- | src sender number or ID | + | queue |
- | dst destination number (single number) | + | src |
- | dt send SMS date/time | + | dst |
- | smslog_id SMS Log ID | + | dt | send SMS date/time |
- | last last SMS log ID (this number not included on result) | + | smslog_id |
- | c number of delivery status that will be retrieved | + | last | last SMS log ID (this number not included on result) |
- | kwd keyword | + | c |
- | login_key login key sets by admin through webservices call op=loginkeyset | + | kwd |
- | query query server for useful information | + | login_key |
+ | query | ||
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 |
- | recvnum receiver number (for op=inject) | + | -------------- | -------------- |
- | smsc SMSC (for op=inject) | + | recvnum |
- | data_* admin tasks related supplied data | + | smsc | SMSC (for op=inject) |
+ | data_* | ||
Please note that all values should be URL encoded. | Please note that all values should be URL encoded. | ||
- | Return Codes | + | |
+ | ## Return Codes | ||
Below table listed return coded after unsuccessful call to a webservices operation. Successful operation will returns an OK data in the response message. | Below table listed return coded after unsuccessful call to a webservices operation. Successful operation will returns an OK data in the response message. | ||
Please note that by default the response message is a JSON encoded message. | Please note that by default the response message is a JSON encoded message. | ||
- | Error code Description | + | Error code | Description |
- | ERR 100 authentication failed | + | ---------- | ----------- |
- | ERR 101 type of action is invalid or unknown | + | ERR 100 |
- | ERR 102 one or more field empty | + | ERR 101 |
- | ERR 103 not enough credit for this operation | + | ERR 102 |
- | ERR 104 webservice token is not available | + | ERR 103 |
- | ERR 105 webservice token not enable for this user | + | ERR 104 |
- | ERR 106 webservice token not allowed from this IP address | + | ERR 105 |
- | ERR 200 send message failed | + | ERR 106 |
- | ERR 201 destination number or message is empty | + | ERR 200 |
- | ERR 400 no delivery status available | + | ERR 201 |
- | ERR 401 no delivery status retrieved and SMS still in queue | + | ERR 400 |
- | ERR 402 no delivery status retrieved and SMS has been processed from queue | + | ERR 401 |
- | ERR 501 no data returned or result is empty | + | ERR 402 |
- | ERR 600 admin level authentication failed | + | ERR 501 |
- | ERR 601 inject message failed | + | ERR 600 |
- | ERR 602 sender id or message is empty | + | ERR 601 |
- | ERR 603 account addition failed due to missing data | + | ERR 602 |
- | ERR 604 fail to add account | + | ERR 603 |
- | ERR 605 account removal failed due to unknown username | + | ERR 604 |
- | ERR 606 fail to remove account | + | ERR 605 |
- | ERR 607 set parent failed due to unknown username | + | ERR 606 |
- | ERR 608 fail to set parent | + | ERR 607 |
- | ERR 609 get parent failed due to unknown username | + | ERR 608 |
- | ERR 610 fail to get parent | + | ERR 609 |
- | ERR 611 account ban failed due to unknown username | + | ERR 610 |
- | ERR 612 fail to ban account | + | ERR 611 |
- | ERR 613 account unban failed due to unknown username | + | ERR 612 |
- | ERR 614 fail to unban account | + | ERR 613 |
- | ERR 615 editing account preferences failed due to missing data | + | ERR 614 |
- | ERR 616 fail to edit account preferences | + | ERR 615 |
- | ERR 617 editing account configuration failed due to missing data | + | ERR 616 |
- | ERR 618 fail to edit account configuration | + | ERR 617 |
- | ERR 619 viewing credit failed due to missing data | + | ERR 618 |
- | ERR 620 fail to view credit | + | ERR 619 |
- | ERR 621 adding credit failed due to missing data | + | ERR 620 |
- | ERR 622 fail to add credit | + | ERR 621 |
- | ERR 623 deducting credit failed due to missing data | + | ERR 622 |
- | ERR 624 fail to deduct credit | + | ERR 623 |
- | ERR 625 setting login key failed due to missing data | + | ERR 624 |
- | ERR 626 fail to set login key | + | ERR 625 |
+ | ERR 626 | ||
+ | |||
There might appear new error codes in the future, you should be aware that new codes might appear in this syntax: | There might appear new error codes in the future, you should be aware that new codes might appear in this syntax: | ||
- | Error code Description | + | Error code | Description |
- | ERR 1xx authentication or parameter erorrs | + | ---------- | ----------- |
- | ERR 2xx specific pv errors | + | ERR 1xx |
- | ERR 4xx delivery status errors | + | ERR 2xx |
- | ERR 5xx others | + | ERR 4xx |
- | ERR 6xx administrative tasks | + | ERR 5xx |
- | Protocol for non-admin tasks | + | ERR 6xx |
- | Send message | + | |
+ | |||
+ | ## Protocol for non-admin tasks | ||
+ | |||
+ | |||
+ | ### Send message | ||
Send message to a single or multiple mobile numbers, @username or #groupcode | Send message to a single or multiple mobile numbers, @username or #groupcode | ||
- | Parameters Name or description | + | Parameters |
- | Operation pv | + | ---------- | -------------------- |
- | Mandatory u h to msg | + | Operation |
- | Optional type unicode from footer nofooter format schedule | + | Mandatory |
- | Returns return codes | + | Optional |
- | Parameter to can be international formatted mobile number, #groupcode or @username, or a mix of them. Separate by commas for multiple value. | + | Returns |
+ | |||
+ | Parameter | ||
+ |