Welcome page
Products
Ozeki 10
Apps
Chat
SMS Gateway
SMS with Client Software
HTTP API
Get Started
HTTP API Tester
Send message
Receive message
Billing methods
URL encode
Select operator
Operate with single message
Query the addressbook
Operations with message folders
Examples
User handling
configuser
Service Provider Connection Handling
Reporting API
Dynamic SMPP parameters
SMS from/to Database
PHP SMS API
Solutions
C# SMS API
VB.NET SMS API
SQL Logging
System Database
Robot Controller
Softphone
Connections
Installation guide
Terms and Definitions
SMS
Bulk Messenger
Cluster
Developer tools
Robots
Hardware
Technology
Company


Ozeki SMS Gateway
Examples Examples | configuser configuser

HTTP API - Managing users

On this page you will find an example on how you can manage users in Ozeki SMS Gateway via HTTP API. Please note that this feature is available in Ozeki NG - SMS Gateway v4.1.12 and above.

User management with the HTTP API consists of a few easy steps. First you should create a user ('createuser') than you can configure it by using the necessary parameters ('configuser'). The user will be available after the 'startuser' action.

If you would like to suspend the created user, please use 'stopuser' or if you would like to delete the user with all of it's parameters, you can use 'deleteuser'.

Important user actions

'createuser' action

You can create a new user with 'createuser'. The action specific parameters are: type, name

Example:
HTTP request:

http://127.0.0.1:9501/api?action=createuser&username=admin&password=abc123&type=Standard&name=Alice

HTTP response:

StatusCode: 200, ReasonPhrase: 'OK'

Parameters:

Parameter Description Possible values Example M/O*
type Specifies the type of the user you wish to create. Learn more from the user type documentation. string value:
Standard,
SQL,
File,
Email,
HTTP Client,
HTTP Server,
SMPP,
Application starter,
Autoreply,
ASP,
Autoreply easy,
Autoreply database,
Forwarder,
FTP,
Outlook Message Service,
RSS,
PDF,
WCF,
Voting
type=Standard M
name Specifies the username belonging to the createable user. string value name=Alice M

* M = Mandatory parameter, O = Optional parameter

'configuser' action

This action can configure various types of users in SMS Gateway.
Learn more about 'configuser' by reading the following API documentation.

Use 'configuser' action to configure users in Ozeki SMS Gateway. The mandatory user parameter is: name.

There are two user type groups in Ozeki SMS Gateway:

-Fully configurable users:
Standard, SQL, File, Email, HTTPClient, HTTPServer, SMPP, Appstarter, AutoReply, AutoReplyEasy
-Users with restricted configurability (only Standard user parameters are configurable):
ASP, AutoreplyDatabase, Loopback, FTP, OutlookMobileService, RSS, PDF, WCF, Voting

For more details, please read the user type documentation.

'startuser' action

You can start a user with 'startuser'. The action specific parameters is: name

Example:
HTTP request:

http://127.0.0.1:9501/api?action=startuser&username=admin&password=abc123&name=Alice

HTTP response:

StatusCode: 200
XML: Ok

Parameters:

Parameter Description Possible values Example M/O*
name Specifies the username belonging to the createable user. string value name=Alice M

* M = Mandatory parameter, O = Optional parameter

'stopuser' action

You can stop a user with 'stopuser'. The action specific parameters is: name

Example:
HTTP request:

http://127.0.0.1:9501/api?action=stopuser&username=admin&password=abc123&name=Alice

HTTP response:

StatusCode: 200
XML: Ok

Parameters:

Parameter Description Possible values Example M/O*
name Specifies the username belonging to the createable user. string value name=Alice M

* M = Mandatory parameter, O = Optional parameter

'deleteuser' action

You can delete an existing user with 'deleteuser'. The action specific parameters is: name

Example:
HTTP request:

http://127.0.0.1:9501/api?action=deleteuser&username=admin&password=abc123&name=Alice

HTTP response:

StatusCode: 200
XML: Ok

Parameters:

Parameter Description Possible values Example M/O*
name Specifies the username belonging to the createable user. string value name=Alice M

* M = Mandatory parameter, O = Optional parameter


Copyright © 2000- - Ozeki Ltd | info@ozeki.hu | Tel: +36 1 371 0150
Home > Products > Ozeki 10 > Apps > SMS Gateway > HTTP API > User handling
Legal | Privacy policy | Terms of use
Page: 5698 | Login | 54.224.247.42