SMSEagle NXS-9700-3G, User Manual

Page: 84 / 229

84
| SMSEagle NXS-9700 | User’s Manual
SMSEAGLE API
SMSEagle has powerful built-in REST API functionalities. API is dedicated for integration of SMSEagle with
any external system or application. Below you will find a detailed description of API functionalities.
SMSEagle API supports both HTTP and HTTPS protocol.
For your convenience sample usage of SMSEagle’s API in most popular programming languages are available
at:
https://www.smseagle.eu/code-samples/
0. API Authentication
Before you can start using API, first you need to enable API access.
a) go to WebGUI > Users
b) create a new User with access level "User", set "Access to API" to "On" (optionally you may limit
access only to selected API methods)
c) choose API authentication method. This can be either:
• access_token (recommended solution)
Edit your API User > check “Enable token” and generate new access token. The token will
be used to authenticate in API methods
or
•
b) login and password
Use your API User credentials to authenticate in API methods
EXAMPLES OF AUTHENTICATION:
• with access token
https://url-of-smseagle/http_api/send_sms? access_token=0001gOjCOlMH8F2q
•
with login and password
https://url-of-smseagle/http_api/send_sms?
login=john&pass=doe
API credentials created here will be used to authenticate in all API methods (see descriptions below).
1. Send SMS: HTTP GET method
HTTP GET METHOD:
https://url-of-smseagle/http_api/send_sms
PARAMETERS:
Parameter Description
access_token authentication access token (see details in point API Authentication)
login your user to login to SMSEagle (see details in point API Authentication)
pass your password to login to SMSEagle
to recipient telephone number (or numbers separated with comma)