Create user and/or customer accounts

All the below endpoints require the reseller to authenticate themselves with a resellerName and a resellerPassword. A response with {"status":3} is returned when the provided credentials are invalid.

Status codes and their meaning: User and Reseller REST API Response Status Codes

Parameter names are case sensitive.

Create user and customer account

Rest End-point

URL: /services/rest/customer-user/create

method: POST

Note: Customer Billing Type is defined by the Reseller property; All Accounts are created with rotationAlgorithm = "CONVERSATION"

defaultCustomerBillingType

Parameters

name	description	example value	validation rules
contactName	User's contact name	John Doe	none
email	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.
resellerName	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:

{"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
email	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
finalStatusPush	Push notification type for final message statuses	{"type": "URL", "data": {"url": "http://push.example.com"}}	optional, if present - must be a valid JSON with a `type`field defining the notification type and an optional `data`field with details of the given notification type; the supported notification types are: URL: `{"type": "URL", "data": {"url": "http://push.example.com"}}` e-mail: `{"type": "EMAIL", "data": {"to": "user@example.com", "subject": "Message subject", "body": "Message body"}}` SMPP: `{"type": "SMPP"}`
swappingSourceAddressAllowed	Flag indicating whether the source address can be swapped	true	optional, value must be either "true" or "false", case insensitive, default: "false"
sourceAddress	Source address to be used when the sender is absent from the original message	48123456789	optional, if present must be either of: 3-16 digits 2-11 characters if any non-digit valid GSM character is present

Response

Reponse will be sent as a JSON with single value. Example:

{"id":"abc1234","status":0}

Possible statuses

0, 1, 2, 3, 201, 220, 300, 400, 9999

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	Required
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 even is reseller Default billing type is Pre-Paid`
moCharge	MO charge	0	optional, if present - must be a valid integer; default: 0
sourceAddress	Source address to be used when the sender is absent from the original message and no source address is defined for the user sending the message	48123456789	optional, if present must be either of: 3-16 digits 2-11 characters if any non-digit valid GSM character is present

Response

Reponse will be sent as a JSON with single value. Example:

{"id":"abc123","status":0}

Possible statuses

0, 1, 2, 3, 301, 400, 9999