SubAccountActivate
Schema used to check and set-up sub-account functionality. There are two options available:
-
The managed sub-accounts option is intended for users who wish to set up several other accounts for people
within their company. The user will purchase a block of messages on their own account and allocate some of them
to the new sub-accounts. Sub-accounts are not expected to purchase directly, although they may (if they do the
user will not receive commission on their purchases). The user will manage these accounts with full
'administration' control. This includes the ability to add and remove credits from the accounts, provide access
to the user's address book and groups, and to run overview reports on their traffic. If they run out of credits
the user should top-up their balance from their own account.
-
The commission based sub-accounts are intended for individuals or organisations who wish to encourage
interested third parties to use the 2SMS service. New sub-accounts may be set up by the user, or by the third
parties themselves through the use of a tailored URL. Once set up the third parties will manage their own
accounts and purchase directly from 2SMS. The user will receive commission on all sub-account purchases. The
sub-accounts will run independently of the user's account, and as such the user will have only a severely
limited range of administrative access to their sub-accounts. When a sub-account runs out of credits the
third party will need to purchase another block directly from 2SMS, and the user will receive commission on
this top-up.
Administrative differences between sub-account options
2SMS provides a wide range of XML methods for sub-account maintenance. These include both the other SubAccount
family methods, and versions of the overview report method which contain a 'SubAccount' element.
These methods are mainly intended for use by customers who have chosen the managed sub-accounts option,
and users with managed sub-accounts can use all these methods.
Users with commission based sub accounts have the following restrictions:
- They may obtain a list of basic sub-account details (see method code 0510).
- They may obtain an overview report for their sub-accounts (see method code 0340).
- They may give message credits to their sub-accounts, but may not take message credits from their sub-accounts
(see method code 0520).
- They may not provide sub-accounts with access to their groups (see method codes 0515,
0530 & 0535).
- They may not provide sub-accounts with access to their address book(s) (see method codes
0540 & 0545).
Instructions for creating new sub-accounts
-
New sub-accounts may be registered by a master account either via the 2SMS website or through the XML
gateway. The sub-account section of the website has an option called 'open new account' which allows a new sub-account
to be opened. Method code 0020 contains information on opening new accounts
via the XML gateway: to create a sub-account rather than a new top-level account both the 'UserID' and 'Password'
must be supplied in the 'Identification' section. This method may be combined with calls to method code
0520 to assign initial credits to the newly created sub-account.
-
Interested third parties may also directly register for commision based sub-accounts through the 2SMS website.
The new registrant must be directed to the following URL: http://www.2sms.us/register.aspx?affiliate=XXXX,
where XXXX should be replaced by the 'AffiliateName' that was chosen when setting up sub-account functionality.
This URL may be supplied as a link on a website, or may be sent to the third party as a link in an email, etc.
When the third party navigates to this URL they will see the standard 2SMS registration page, but with an
additional 'Affiliate' entry containing the appropriate 'AffiliateName'. The third party should then register
with 2SMS as normal and will automatically be created as the corresponding commision based sub-account.
The 'UserID' and 'Password' elements identify the account.
The 'ServiceName' element must be set to 'SubAccountActivate'.
The 'SoftwareVersion' element is for internal 2SMS use only and should not be set.
The 'ServiceDetail' should contain one of the following three elements:
- A childless 'EnquireCurrentStatus' element: this is used to report on the current sub-account
set-up of the account, including how many credits are available for transfer to sub-accounts.
- A childless 'SetUpManagedSubAccouts' element: if the account does not currently have sub-accounts
activated then this will activate the managed sub-accounts option.
- A 'SetUpCommisionBasedSubAccouts' element: if the account does not currently have sub-accounts
activated then this will activate the commision based sub-accounts option. The element should
have the following complusory child elements:
- An 'AffiliateName' element containing the reference with which third parties may register at 2SMS.
- An 'PaymentAddress' element containing the address of the company to whom commision is due.
- A 'PostCode' element containing the zip/post code of the company to whom commision is due.
- A 'Country' element containing the location of the company to whom commision is due.
- A 'BankAccountNumber' element which is to be used for payment of commision.
- A 'SortCode' element which is to be used for payment of commision.
- A 'PaymentReference' element which is to be used for payment of commision.
This method returns a successful '00/OK' response if the current configuration status was returned or the chosen
sub-account option was set up correctly. The 'Result' element confirms that this has been done.
The 'Detail' element may contain the following child elements:
-
A 'Configuration' element which shows the current sub-account configuration of the account.
It will hold one of the following three values:
- 'NOT_SETUP' if the account has not yet been configured for sub-accounts.
- 'AFFILIATE' if the account has been configured for sub-accounts with the commision based option.
- 'MASTER' if the account has been configured for sub-accounts with the managed option.
-
The 'CurrentBalance' element is only shown in response to an 'EnquireCurrentStatus' request.
It shows the anytime balance that is available for transfer to sub-accounts (note that any free credits obtained
when opening an initial account with 2sms are not transferable to sub-accounts and thus not included in this total).
-
The 'OffPeakBalance' element is only shown in response to an 'EnquireCurrentStatus' request.
It shows the anytime balance that is available for transfer to sub-accounts.