This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
invio_php_http_get [2020/08/01 23:00] dcantaluppi |
invio_php_http_get [2023/12/29 14:29] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | **# WEBSERVICES** | + | ====== invio PHP HTTP GET ====== |
- | + | ==== Esempio API ==== | |
- | This document explains webservices protocol. | + | < |
- | + | <? | |
- | + | ||
- | **## Access** | + | ////////////////// |
- | + | // | |
- | Webservices URL: | + | // |
- | `https:// | + | // |
- | + | // | |
- | + | // | |
- | ## Parameters | + | // Secured SSL // |
- | + | //Keep parameters in a safe place // | |
- | Listed in the below table are webservices parameters for individual tasks. | + | ////////////////// |
- | + | ||
- | Name | Description | + | //OUTPUT of the call |
- | -------------- | -------------- | + | //https:// |
- | h | webservices token, configured by user from Preferences menu | + | |
- | u | username | + | // |
- | p | password, supplied | + | |
- | op | operation or type of action | + | |
- | format | + | |
- | from | SMS sender ID (for op=pv) | + | |
- | to | destination numbers, @username or #groupcode, may use commas | + | |
- | footer | + | |
- | nofooter | + | // |
- | msg | message | + | // |
- | schedule | + | |
- | type | message type (flash or text) | + | |
- | unicode | + | function get_url( $url, $javascript_loop |
- | queue | queue code | + | { |
- | src | sender number or ID | + | $url = str_replace( "& |
- | dst | destination number | + | |
- | dt | send SMS date/time | + | $ch = curl_init(); |
- | smslog_id | + | curl_setopt( $ch, CURLOPT_USERAGENT, |
- | last | last SMS log ID (this number not included on result) | + | |
- | c | number of delivery status that will be retrieved | + | |
- | kwd | keyword | + | |
- | login_key | + | |
- | query | query server for useful information | + | |
- | + | | |
- | Listed in the below table are webservices parameters | + | |
- | + | | |
- | Name | Description | + | |
- | -------------- | -------------- | + | |
- | recvnum | + | |
- | smsc | SMSC (for op=inject) | + | |
- | data_* | + | |
- | + | | |
- | Please note that all values should be URL encoded. | + | |
- | + | | |
- | + | ||
- | ## Return Codes | + | curl_setopt( $ch, CURLOPT_MAXREDIRS, |
- | + | | |
- | Below table listed return coded after unsuccessful call to a webservices operation. Successful operation will returns an OK data in the response | + | |
- | + | | |
- | Please note that by default the response message is a JSON encoded message. | + | $response |
- | + | | |
- | Error code | Description | + | |
- | ---------- | ----------- | + | |
- | ERR 100 | authentication failed | + | |
- | ERR 101 | type of action is invalid or unknown | + | |
- | ERR 102 | one or more field empty | + | |
- | ERR 103 | + | |
- | ERR 104 | + | |
- | ERR 105 | webservice token not enable for this user | + | |
- | ERR 106 | webservice token not allowed from this IP address | + | |
- | ERR 200 | send message failed | + | |
- | ERR 201 | destination number or message is empty | + | |
- | ERR 400 | no delivery status available | + | |
- | ERR 401 | no delivery status retrieved and SMS still in queue | + | |
- | ERR 402 | no delivery status retrieved and SMS has been processed from queue | + | |
- | ERR 501 | no data returned or result is empty | + | |
- | ERR 600 | admin level authentication failed | + | |
- | ERR 601 | inject message failed | + | |
- | ERR 602 | sender id or message is empty | + | |
- | ERR 603 | account addition failed due to missing data | + | |
- | ERR 604 | fail to add account | + | |
- | ERR 605 | account removal failed due to unknown username | + | |
- | ERR 606 | fail to remove account | + | |
- | ERR 607 | set parent failed due to unknown username | + | |
- | ERR 608 | fail to set parent | + | |
- | ERR 609 | get parent failed due to unknown username | + | |
- | ERR 610 | fail to get parent | + | |
- | ERR 611 | account ban failed due to unknown username | + | |
- | ERR 612 | fail to ban account | + | |
- | ERR 613 | account unban failed due to unknown username | + | |
- | ERR 614 | fail to unban account | + | |
- | ERR 615 | editing account preferences failed due to missing data | + | |
- | ERR 616 | fail to edit account preferences | + | |
- | ERR 617 | editing account configuration failed due to missing data | + | |
- | ERR 618 | fail to edit account configuration | + | |
- | ERR 619 | + | |
- | ERR 620 | + | |
- | ERR 621 | adding credit failed due to missing data | + | |
- | ERR 622 | fail to add credit | + | |
- | ERR 623 | deducting credit failed due to missing data | + | |
- | ERR 624 | fail to deduct credit | + | |
- | ERR 625 | setting login key failed due to missing data | + | |
- | ERR 626 | fail to set login key | + | } |
- | + | | |
- | + | | |
- | There might appear new error codes in the future, you should be aware that new codes might appear in this syntax: | + | |
- | + | | |
- | Error code | Description | + | |
- | ---------- | ----------- | + | |
- | ERR 1xx | authentication or parameter erorrs | + | |
- | ERR 2xx | specific pv errors | + | } |
- | ERR 4xx | delivery status errors | + | |
- | ERR 5xx | others | + | } |
- | ERR 6xx | administrative tasks | + | |
- | + | | |
- | + | $url = ' | |
- | ## Protocol for non-admin tasks | + | |
- | + | | |
- | + | | |
- | ### Send message | + | echo $response; |
- | + | | |
- | Send message | + | |
- | + | </ | |
- | Parameters | Name or description | + | |
- | ---------- | -------------------- | + | |
- | Operation | + | |
- | Mandatory | + | |
- | Optional | + | |
- | Returns | + | |
- | + | ||
- | Parameter `to` can be international formatted mobile number, #groupcode or @username, or a mix of them. Separate by commas for multiple value. | + | |
- | + |