HTTPS API v2 / Management of subaccounts

The system allows remote listing and creating sub-accounts in the system (which can also be logged in from the Customer Panel level). To create an account, you must first define at least one sub-account in the Customer Panel that will later be used as a permission template. All settings regarding, for example, forwarding of delivery reports or answers to ECO + SMS will be copied from the template subaccount to a new sub-account.

Listing subaccounts

Calling address

 

For using the remote operating available to list the current sub-account, call the specified URL using the POST method.

subaccounts/index

Avaliable parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account

The parameters in bold are obligatory. Others are optional.

Return response

{
   "items":[{
      "id":123,
      "username":"wojtek"
   },
   {
      "id":456,
      "username":"login2"
   },
   {
      "id":789,
      "username":"testowy"
   }]
}

Displays details of subaccounts

Calling address

For using the remote operating send a text message should be sent to specific application protocol HTTP or HTTPS POST method.

subaccounts/view

Avaliable parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account
id	Integer	eg. 123	ID subaccounts.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "id":1194,
   "username":"wojtek",
   "name":"Wojciech",
   "phone":"+48730856000",
   "email":"wojtek@mail.com"
}

Create subaccounts

Calling address

For using the remote operating send a text message should be sent to specific application protocol HTTP or HTTPS POST method.

subaccounts/add

Available parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account
subaccount_username	String	eg. „login1”	Login new subaccount (3-20 characters in the field (a-z, A-Z, 0-9, and characters, '_ @.
subaccount_password	String	eg. „testABC”	Password new subaccount (3-20 characters).
subaccount_id	Integer	eg. 123	ID subaccounts from which you want to transfer access rights and view.
name	String	eg. „testowe subkonto”	The name describes the new subaccount.
phone	String	eg. „500600700”	The phone number of the new subaccount.
email	String	eg. „test@test.pl”	E-mail address of the new subaccount.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true,
   "id":1485
}

Setting message limits for subaccount

Calling address

For using the remote operating send a text message should be sent to specific application protocol HTTP or HTTPS POST method.

subaccounts/limit

Available parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account
id	Integer	eg. 123	ID subaccounts
type	String	eco|full|voice|mms|hlr	The message type for which updates the limit.
value	Integer	eg. 100	Number of messages.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true,
   "id":1485
}

Deleting subaccounts

Calling address

For using the remote operating send a text message should be sent to specific application protocol HTTP or HTTPS POST method.

subaccounts/delete

Available parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account
id	Integer	eg. 123	ID subaccounts

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true
}