SOAP / Web services

SOAP/Web Services

These web services provide access to the core functionality of the messaging system allowing you to create your own applications that utilize text messaging and email.

2sms provide two types of web services for you to use: Simple and Complex.

Both of these contain the same functionality but require either the use of simple data types (e. g. string and integer) or complex data types (e. g. date/time and array).

To see code samples in SOAP/Web Services, click the Service Description for each element.

Note:

Any references to null in the documentation should be replaced by Nothing if you are programming in VB.NET.

Parameters

Username	2sms issued username
Password	2sms issued password
Result Text	Provide a string data type output parameter. When a method is executed this will be populated with readable text describing the outcome of the method. In the notes for each method there is an example of the ResultText that can be expected.
Code	Provide a string data type output parameter. This parameter will be populated with a code representing the outcome of the method. For a full list of codes please see the Response Generic Error Schema here.

Simple Web Services

Simple web services provide access to the core functionality of the messaging system using only simple data types. Each of the web services below expose a logical subset of our system allowing you to only connect to the functionality you require. This in turn means that it is clear and logical as to which aspects of the system are being used by any piece of client code.

Throughout these web services any ReportCSV output parameters will be populated with a CSV standard string in the following format:

The first record contains a comma separated list of column names without double-quotes.
Following this all columns are delimited by double-quote characters and separated by a comma.
Each row is separated by a single line feed, (0x0A).

This CSV standard string is in the same as that returned from the main web site. The following is an example of a CSV standard string:

First Name,Last Name,Email Address,Current Balance,Off Peak Balance

“Fred”,”Bob”,”Fred.Bob@Test.com”,”10.0″,”0.0″

“John”,”Smith”,”John.Smith@Test.com”,”15.0″,”0.0″

It should also be noted that any date/time strings must be in the format MM/DD/YYYY HH:MM:SS.

Account

This web service provides methods that allow you to open, manage, and report upon accounts and their sub-accounts.
Service Description

Contact

This web service provides methods that allow you to create, manage, and report upon address book contacts.
Service Description

EP

This web service provides methods that allow you to report upon the status of contacts in an emergency.
Service Description

Fixed Message

This web service provides methods that allow you to create, manage, and report upon the fixed messages defined for an account.
Service Description

Group

This web service provides methods that allow you to create, manage, and report upon address book groups.
Service Description

Message

This web service provides methods that allow you to send text messages and emails to individuals, or address book groups.
Service Description

Report

This web service provides methods that allow you to report upon text messages and emails sent to and from an account.
Service Description

COMPLEX WEB SERVICES

Complex web services provide access to the core functionality of the messaging system using complex data types. Each of the web services below expose a logical subset of our system allowing you to only connect to the functionality you require. This in turn means that it is clear and logical which aspects of the system are being used by any piece of client code.

Throughout these web services, any ReportArray parameters are declared as an array of arrays containing string elements (e.g. string[][]). These parameter will be populated in the following way:

The first array will contain all of the column names.
Following this, there will be one array for each record of the report.