To create an initial 2SMS account the 'Identification' element must not be supplied.
To create a sub account the 'Identification' element must contain 'UserID' and 'Password' children for the creating account.
In both cases the 'ServiceName' element must be set to 'AccountOpen'.
The 'Affiliate', 'Brand' and 'SoftwareVersion' elements are for internal 2SMS use only and should not be set.
The 'ServiceDetail' element must contain child elements as follows:
-
'FirstName' The first-name of the individual who will own the new account.
-
'LastName' The last-name of the individual who will own the new account.
-
'MobilePhone' The mobile phone number of the individual who will own the new account. This element may
be omitted when creating a sub-account as we already have a contact number for the main account.
-
'EmailAddress' Email for the new account - note that this also becomes the UserID to use with this account.
-
'Company' The name of the company to which the new account belongs.
-
'Phone' A general phone number for the individual who will own the account. This element may
be omitted when creating a sub-account as we already have a contact number for the main account.
-
'Password' The password for authenticating this account in future.
-
'AltEmail' Is optional and may be used to supply 2SMS with an alternative e-mail address for your account
-
'DefaultHeader' Is only functional with sub-accounts and is an optional parameter. If the master account
has more than one header available then the sub-account may select which one it will use
(see here for more details on headers)
-
'TimeZone' Is an optional parameter and may be used to set the time-zone used when sending and reporting on messages
for the account. The time-zone must be supplied as a string, and acceptable values can be seen on the 'Time Zone'
drop-down list here. If this parameter is not supplied then
the default for the master account is 'Europe/London' and the default for a sub-account is the same as the master.
-
'Location' Is an optional parameter and may be used to supply the ISO 3166-1 two-letter country code for
the location in which to register the account. Note that a sub account may only be in the same 2SMS region
as its master account (see here for the 2SMS regions).
If this parameter is not supplied then the default for the master account is 'GB' and the default for a
sub-account is the same as the master.
-
'PromoCode' Is an optional element and should not be supplied unless a 2SMS promo-code has been explicitly provided.
-
'EmailOptOut' Is an optional element to determine wether the user will receive 2SMS email updates.
The default is to receive these but this can be altered by supplying this element.
Setting the element content to 'true' means you are opted-out and will not receive updates,
whilst setting the element content to 'false' means you are opted in and will receive updates.
-
'infoSource' Is an optional element that can contain one a a fixed number of values used to indicate how the person
opening the account learned about 2sms. For example if they found about 2sms using a search engine then the
'SEARCH_ENGINE' value should be supplied.
NB When creating an initial 2SMS account, the account will require validation
(see method code 0040 for more details).