| Table of Contents |
|---|
| Info |
|---|
All the below endpoints require the reseller to authenticate themselves with a |
| Info |
|---|
Status codes and their meaning: User and Reseller REST API Response Status Codes |
| Note |
|---|
Parameter names are case sensitive. |
Create user and customer account
Rest End-point
URL: /services/rest/customer-user/create
method: POST
Parameters
| name | description | example value | validation rules |
|---|---|---|---|
| contactName | User's contact name | John Doe | none |
| User's e-mail. | john@doe.com | optional, but if provided must be a valid e-mail | |
| username | username of the user to be created. | 1212412@testReseller | required, can't contain spaces. For the phone applications we will use customer@reseller as the username. |
| password | Password | password | required |
| customer | Name of customer | exampleCustomer | required, can't contain spaces. Customer with given name must not exist. For the phone applications we will use customer@reseller as the customer name, the same like for username. |
| resellerresellerName | Name of reseller | resellerName | required, can't contain spaces and '@'. Reseller with given name must exist |
| resellerPassword | Reseller password | password | required for authentication |
| phoneNumber | Phone number to contact with user | 999444111 | optional, can contain only +, " " and digits, no other validation |
| applyFreeCredits | flag indicating whether we should add free credits to account | false | required, value must be either "true" or "false", case insensitive |
...
Response
Reponse will be sent as a JSON with single value. Example:
| Code Block |
|---|
{"status":0} |
Possible statuses
0, 1, 2, 3, 201, 220, 301, 400, 9999
Create user account
Rest End-point
URL: /services/rest/user/create
method: POST
Parameters
| name | description | example value | validation rules |
|---|---|---|---|
| username | username of the user to be created. | 1212412@testReseller | required, can't contain spaces |
| password | Password | password | required |
| resellerName | Name of reseller | resellerName | required, can't contain spaces and '@'. Reseller with given name must exist |
| resellerPassword | Reseller password | password | required for authentication |
| customerId | ID of the customer | 5a4e96a030046095c7ef280f | must be a valid Mongo ObjectId, the customer with the given ID has to exist |
| User's e-mail. | john@doe.com | required, must be a valid e-mail | |
| phoneNumber | Phone number to contact with user | 999444111 | required, can contain only +, " " and digits, no other validation |
| virtualNumber | Virtual number | 999444111 | optional, can contain only +, " " and digits, no other validation |
| moPush | Push notification type for MO messages | {"type": "URL", "data": {"url": "http://push.example.com"}} | optional, if present - must be a valid JSON with a
|
| finalStatusPush | Push notification type for final message statuses | {"type": "SMPP"} | same as for moPush, see above |
| swappingSourceAddressAllowed | Flag indicating whether the source address can be swapped | true | optional, value must be either "true" or "false", case insensitive, default: "false" |
Response
Reponse will be sent as a JSON with single value. Example:
| Code Block |
|---|
{"status":0} |
Possible statuses
0, 1, 2, 3, 201, 220, 301300, 400, 9999 Status codes and their meaning: User and Reseller REST API Response Status Codes
Create customer
Rest End-point
URL: /services/rest/customer/create
method: POST
Parameters
| name | description | example value | validation rules |
|---|---|---|---|
| name | name of the customer to be created | test-customer | required, can't contain spaces. Customer with given name must not exist. |
| resellerName | Name of reseller | resellerName | required, can't contain spaces and '@'. Reseller with given name must exist |
| resellerPassword | Reseller password | password | required for authentication |
| integrationId | ID of the integration | integrationId | optional string, default: "" |
| rotationAlgorithm | Rotation algoritgm | MAX_ROTATION | optional, if present - must be one of: CONVERSATION, MAX_ROTATION; default: MAX_ROTATION |
| billingType | Billing type | PRE_PAID | optional, if present - must be one of: PRE_PAID, POST_PAID; default: POST_PAID |
| moCharge | MO charge | 42 | optional, if present - must be a valid integer; default: 0` |
Response
Reponse will be sent as a JSON with single value. Example:
| Code Block |
|---|
{"status":0} |
Possible statuses
0, 1, 2, 3, 301, 400, 9999