Getting started

This repository contains the open source C# client for TransmitSMS REST API. Documentation can be found at: https://developer.transmitsms.com/

API authentication will require your API Key and Secret. Obtain these by logging into your account and visiting the settings page.

How to Build

The generated code uses the Newtonsoft Json.NET NuGet Package. If the automatic NuGet package restore is enabled, these dependencies will be installed automatically. Therefore, you will need internet access for build.

"This library requires Visual Studio 2017 for compilation."

Open the solution (TransmitSMS.sln) file.
Invoke the build process using Ctrl+Shift+B shortcut key or using the Build menu as shown below.

How to Use

The build process generates a portable class library, which can be used like a normal class library. The generated library is compatible with Windows Forms, Windows RT, Windows Phone 8, Silverlight 5, Xamarin iOS, Xamarin Android and Mono. More information on how to use can be found at the MSDN Portable Class Libraries documentation.

The following section explains how to use the TransmitSMS library in a new console project.

1. Starting a new project

For starting a new project, right click on the current solution from the solution explorer and choose Add -> New Project.

Next, choose "Console Application", provide a TestConsoleProject as the project name and click OK.

2. Set as startup project

The new console project is the entry point for the eventual execution. This requires us to set the TestConsoleProject as the start-up project. To do this, right-click on the TestConsoleProject and choose Set as StartUp Project form the context menu.

3. Add reference of the library project

In order to use the TransmitSMS library in the new project, first we must add a projet reference to the TestConsoleProject. First, right click on the References node in the solution explorer and click Add Reference....

Next, a window will be displayed where we must set the checkbox on TransmitSMS.Standard and click OK. By doing this, we have added a reference of the TransmitSMS.Standard project into the new TestConsoleProject.

4. Write sample code

Once the TestConsoleProject is created, a file named Program.cs will be visible in the solution explorer with an empty Main method. This is the entry point for the execution of the entire solution. Here, you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

How to Test

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
apikey	Obtain your API Key by logging into your account and visiting the settings page
apisecret	Obtain your API Secret by logging into your account and visiting the settings page

API client can be initialized as following.

// Configuration parameters and credentials
string apikey = "APIKEY"; // Obtain your API Key by logging into your account and visiting the settings page
string apisecret = "APISECRET"; // Obtain your API Secret by logging into your account and visiting the settings page

TransmitSMSClient client = new TransmitSMSClient(apikey, apisecret);

Class Reference

SMSController

Get singleton instance

The singleton instance of the SMSController class can be accessed from the API Client.

SMSController sMS = client.SMS;

SendSMS

The Send-SMS call is the primary method of sending SMS.

You can elect to pass us the recipient numbers from your database each time you make a call, or you can elect to store recipient data in a contact list and submit only the list_id to trigger the send. This is best for large databases. To add a list please refer to the add-list call.

You must provide either to or list_id.

Cost data is returned in the major unit of your account currency, e.g. dollars or pounds

NOTE: If you do not pass the 'from' parameter the messages will be sent from the shared number pool, unless you have a leased number on your account in which case it will be set as the Caller ID

Task<dynamic> SendSMS(
        string format,
        string message,
        string to = null,
        int? listId = null,
        string mfrom = null,
        string sendAt = null,
        string dlrCallback = null,
        string replyCallback = null,
        int? validity = null,
        string repliesToEmail = null,
        bool? fromShared = null,
        string countrycode = null,
        string trackedLinkUrl = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format, either `json` or `xml`. Appended to the URL path.
message	`Required` `DefaultValue`	Message text. Include `[tracked-link]` if you are using the tracked link feature where you want the link to appear.
to	`Optional`	Required if `list_id` is not provided. Mobile number or set of up to 1000 comma separated mobile numbers to send the SMS to. If your number set has some invalid numbers, they won’t cause a validation error and will be simply ignored. Number must be defined in international format. Some examples by destination: AU `61491570156`, NZ `64212670129`, SG `6598654321`, UK `44750017696`, US `1213811413`
listId	`Optional`	Required if `to` is not provided. This is a reference to one of your stored lists. Note: List ID's are made up of digits and will be returned by the add-list call, or can be found at any time by logging into your account and visiting your contacts page.
mfrom	`Optional`	Set the sender ID for the message. Mobile numbers should be in international format, max 15 digits. Alphanumeric sender IDs up to 11 characters, no spaces, are available in some regions. If not set message will use the shared number option.
sendAt	`Optional`	A time in the future to send the message. Note: All returned timestamps are in ISO8601 format e.g. `YYYY-MM-DD HH:MM:SS`. The timezone is always UTC.
dlrCallback	`Optional`	A URL which we can call to notify you of Delivery Receipts. If required, this Parameter can be different for each message sent and will take precedence over the DLR Callback URL supplied by you in the API Settings.
replyCallback	`Optional`	A URL which we can call to notify you of incoming messages. If required, this parameter can be different and will take precedence over the Reply Callback URL supplied by you on the API Settings.
validity	`Optional`	Specify the maximum time to attempt to deliver. In minutes, 0 (zero) implies no limit.
repliesToEmail	`Optional`	Specify an email address to send responses to this message to. NOTE: specified email must be authorised to send messages via add-email or in your account under the 'Email SMS' section.
fromShared	`Optional`	Forces sending via the shared number when you have virtual numbers
countrycode	`Optional`	Formats numbers given to international format for this 2 letter country code. i.e. `0422222222` will become `6142222222` when `countrycode` is `AU`. Codes available `AU` Australia, `NZ` New Zealand, `SG` Singapore, `GB` United Kingdom, `US` United States
trackedLinkUrl	`Optional`	Converts this URL to unique tapth.is/xxxxxx tracking link for each contact. Inserted into message with variable [tracked-link]. Clicks on this URL will be passed as notifications via 'Link hits callback URL' defined in account settings.

Example Usage

string format = "json";
string message = "[Enter your message here]";
string to = "to";
int? listId = 27;
string mfrom = "from";
string sendAt = "send_at";
string dlrCallback = "dlr_callback";
string replyCallback = "reply_callback";
int? validity = 27;
string repliesToEmail = "replies_to_email";
bool? fromShared = false;
string countrycode = "countrycode";
string trackedLinkUrl = "tracked_link_url";

dynamic result = await sMS.SendSMS(format, message, to, listId, mfrom, sendAt, dlrCallback, replyCallback, validity, repliesToEmail, fromShared, countrycode, trackedLinkUrl);

FormatNumber

Format and validate a given number.

Task<dynamic> FormatNumber(string msisdn, string countrycode, string format)

Parameters

Parameter	Tags	Description
msisdn	`Required`	The number to check
countrycode	`Required`	2 Letter countrycode to validate number against
format	`Required` `DefaultValue`	Response Format

Example Usage

string msisdn = "msisdn";
string countrycode = "countrycode";
string format = "json";

dynamic result = await sMS.FormatNumber(msisdn, countrycode, format);

GetSMS

Get information about a message you have sent.

Task<dynamic> GetSMS(string messageId, string format)

Parameters

Parameter	Tags	Description
messageId	`Required`	Message ID
format	`Required` `DefaultValue`	Response format either json or xml

Example Usage

string messageId = "message_id";
string format = "json";

dynamic result = await sMS.GetSMS(messageId, format);

GetSMSStats

Get the status about a message you have sent.

Task<dynamic> GetSMSStats(string messageId, string format)

Parameters

Parameter	Tags	Description
messageId	`Required`	Message ID
format	`Required` `DefaultValue`	Response Format e.g. json or xml

Example Usage

string messageId = "message_id";
string format = "json";

dynamic result = await sMS.GetSMSStats(messageId, format);

GetSMSResponses

Pick up responses to messages you have sent. Filter by keyword or for just one phone number.

Task<dynamic> GetSMSResponses(
        string format,
        string messageId = null,
        string keywordId = null,
        string keyword = null,
        string number = null,
        string msisdn = null,
        string page = null,
        string max = null,
        string includeOriginal = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
messageId	`Optional`	Message ID
keywordId	`Optional`	Keyword ID
keyword	`Optional`	Keyword
number	`Optional`	Filter results by response number, If keyword is set
msisdn	`Optional`	Filter results by a particular mobile number
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page
includeOriginal	`Optional`	include text of original message

Example Usage

string format = "json";
string messageId = "message_id";
string keywordId = "keyword_id";
string keyword = "keyword";
string number = "number";
string msisdn = "msisdn";
string page = "page";
string max = "max";
string includeOriginal = "include_original";

dynamic result = await sMS.GetSMSResponses(format, messageId, keywordId, keyword, number, msisdn, page, max, includeOriginal);

GetUserSMSResponses

Pick up responses to messages you have sent. Instead of setting message ID, you should provide a time frame.

Task<dynamic> GetUserSMSResponses(
        string format,
        string start = null,
        string end = null,
        string page = null,
        string max = null,
        string keywords = null,
        string includeOriginal = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
start	`Optional`	A timestamp to start the report from (Format yyyy-mm-dd, Timezone UTC)
end	`Optional`	A timestamp to end the report at (Format yyyy-mm-dd, Timezone UTC)
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page
keywords	`Optional`	Filter if keyword responses should be included. Can be: ‘only’ - only keyword responses will be included‘omit’ - only regular campaign responses will be included ‘both’ - both keyword and campaign responses will be included (default)
includeOriginal	`Optional`	include text of original message

Example Usage

string format = "json";
string start = "start";
string end = "end";
string page = "page";
string max = "max";
string keywords = "keywords";
string includeOriginal = "include_original";

dynamic result = await sMS.GetUserSMSResponses(format, start, end, page, max, keywords, includeOriginal);

GetLinkHits

Get the list of recipients who have clicked on your tracked link.

Task<dynamic> GetLinkHits(string messageId, string format)

Parameters

Parameter	Tags	Description
messageId	`Required`	Message ID
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string messageId = "message_id";
string format = "json";

dynamic result = await sMS.GetLinkHits(messageId, format);

GetSMSSent

Get a list of recipients from a message send. Get up to date information such as opt-out status and delivery status.

Task<dynamic> GetSMSSent(
        string messageId,
        string format,
        string optouts = null,
        string page = null,
        string max = null,
        string delivery = null)

Parameters

Parameter	Tags	Description
messageId	`Required`	Message ID's are made up of digits
format	`Required` `DefaultValue`	Response format e.g json or xml
optouts	`Optional`	Whether to include optouts. Valid options are: only - only get optouts omit - do not get optouts include - get all recipients including optouts (default)
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page
delivery	`Optional`	Only show messages with requested delivery status. Valid options are: delivered - only show delivered messages failed - only show failed messages pending - only show pending messages

Example Usage

string messageId = "message_id";
string format = "json";
string optouts = "optouts";
string page = "page";
string max = "max";
string delivery = "delivery";

dynamic result = await sMS.GetSMSSent(messageId, format, optouts, page, max, delivery);

GetSMSDeliveryStatus

Get the delivery time of a delivered message.

Task<dynamic> GetSMSDeliveryStatus(string messageId, string msisdn, string format)

Parameters

Parameter	Tags	Description
messageId	`Required`	Message ID
msisdn	`Required`	Mobile number
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string messageId = "message_id";
string msisdn = "msisdn";
string format = "json";

dynamic result = await sMS.GetSMSDeliveryStatus(messageId, msisdn, format);

CancelSMS

Cancel a message you have scheduled to be sent in the future.

Task<dynamic> CancelSMS(string id, string format)

Parameters

Parameter	Tags	Description
id	`Required`	Message ID
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string id = "id";
string format = "json";

dynamic result = await sMS.CancelSMS(id, format);

GetContactSMSStats

Get Contact SMS stats

Task<dynamic> GetContactSMSStats(
        string format,
        string mobile,
        string countrycode,
        string start = null,
        string end = null,
        string sortField = null,
        string order = null,
        string page = null,
        string max = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
mobile	`Required`	valid phone number in international format
countrycode	`Required`	required if mobile is not in international format , will default to account country code setting
start	`Optional`	default to account registration date
end	`Optional`	default to current date
sortField	`Optional`	possible values our "delivery_status" - possible values our hard-bounce, "soft-bounce", "delivered", "pending" "message_id" - the unique number identifying the message "datetime_send" the date and time the message was sent
order	`Optional`	possible values our "asc" and "desc" default to "asc"
page	`Optional`	page number for pagination
max	`Optional`	maximum result returned per page

Example Usage

string format = "json";
string mobile = "mobile";
string countrycode = "countrycode";
string start = "start";
string end = "end";
string sortField = "sort_field";
string order = "order";
string page = "page";
string max = "max";

dynamic result = await sMS.GetContactSMSStats(format, mobile, countrycode, start, end, sortField, order, page, max);

Back to List of Controllers

NumbersController

Get singleton instance

The singleton instance of the NumbersController class can be accessed from the API Client.

NumbersController numbers = client.Numbers;

LeaseNumber

Lease a dedicated virtual number.

Task<dynamic> LeaseNumber(string number, string format)

Parameters

Parameter	Tags	Description
number	`Required`	The virtual number to lease. Omit this field to be given a random number. Use get-numbers to find out which numbers are currently available.
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string number = "number";
string format = "json";

dynamic result = await numbers.LeaseNumber(number, format);

EditNumberOptions

Edit your dedicated virtual number options.

Task<dynamic> EditNumberOptions(
        string number,
        string format,
        string forwardEmail = null,
        string forwardSms = null,
        string forwardUrl = null,
        string listId = null,
        string welcomeMessage = null,
        string membersMessage = null)

Parameters

Parameter	Tags	Description
number	`Required`	The dedicated virtual number.
format	`Required` `DefaultValue`	Response format e.g. json or xml
forwardEmail	`Optional`	Forward incoming messages to a set of email addresses.
forwardSms	`Optional`	Forward incoming messages to a set of mobile numbers.
forwardUrl	`Optional`	Forward incoming messages to a URL.
listId	`Optional`	Add new numbers that message in to this list.
welcomeMessage	`Optional`	Auto-response for all messages received.
membersMessage	`Optional`	Auto-response if the number is already on the list. (must be adding the number to a list)

Example Usage

string number = "number";
string format = "json";
string forwardEmail = "forward_email";
string forwardSms = "forward_sms";
string forwardUrl = "forward_url";
string listId = "list_id";
string welcomeMessage = "welcome_message";
string membersMessage = "members_message";

dynamic result = await numbers.EditNumberOptions(number, format, forwardEmail, forwardSms, forwardUrl, listId, welcomeMessage, membersMessage);

GetNumbers

Get a list of numbers either leased by you or available to be leased.

Task<dynamic> GetNumbers(
        string filter,
        string format,
        string page = null,
        string max = null)

Parameters

Parameter	Tags	Description
filter	`Required` `DefaultValue`	Possible values are owned - retrieve your own response numbers (default) available - retrieve response numbers available for purchase
format	`Required` `DefaultValue`	Response format e.g. json or xml
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string filter = "owned";
string format = "json";
string page = "page";
string max = "max";

dynamic result = await numbers.GetNumbers(filter, format, page, max);

GetNumber

Get detailed information about a response number you have leased.

Task<dynamic> GetNumber(string number, string format)

Parameters

Parameter	Tags	Description
number	`Required`	The virtual number to retrieve
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string number = "number";
string format = "json";

dynamic result = await numbers.GetNumber(number, format);

GetSenderIds

Get Sender ID's

Task<dynamic> GetSenderIds(string format)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string format = "json";

dynamic result = await numbers.GetSenderIds(format);

Back to List of Controllers

ListsController

Get singleton instance

The singleton instance of the ListsController class can be accessed from the API Client.

ListsController lists = client.Lists;

AddToList

Add a member to a list.

Task<dynamic> AddToList(
        string listId,
        string msisdn,
        string format,
        string firstName = null,
        string lastName = null,
        string countrycode = null)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list to add to
msisdn	`Required`	Mobile number of the member
format	`Required` `DefaultValue`	Response format e.g. json or xml
firstName	`Optional`	First name of the member
lastName	`Optional`	Last name of the member
countrycode	`Optional`	Formats msisdn for the given countrycode

Example Usage

string listId = "list_id";
string msisdn = "msisdn";
string format = "json";
string firstName = "first_name";
string lastName = "last_name";
string countrycode = "countrycode";

dynamic result = await lists.AddToList(listId, msisdn, format, firstName, lastName, countrycode);

AddFieldToList

Update or add custom fields to a list

Task<dynamic> AddFieldToList(
        string listId,
        string field1,
        string format,
        string field2 = null,
        Dictionary<string, object> queryParameters = null)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list to add to
field1	`Required`	Custom field value where n is an integer between 1 and 10. You can also use the names of the custom fields you have chosen for your list, e.g. field.birthday.
format	`Required` `DefaultValue`	Response format e.g. json or xml
field2	`Optional`	Custom field value where n is an integer between 1 and 10. You can also use the names of the custom fields you have chosen for your list, e.g. field.birthday.
queryParameters	`Optional`	Additional optional query parameters are supported by this method

Example Usage

string listId = "list_id";
string field1 = "field_1";
string format = "json";
string field2 = "field_2";
// key-value map for optional query parameters
var queryParams = new Dictionary<string, object>();


dynamic result = await lists.AddFieldToList(listId, field1, format, field2, queryParams);

AddList

Create a new list including the ability to add custom fields.

Task<dynamic> AddList(
        string name,
        string format,
        string field1 = null,
        Dictionary<string, object> queryParameters = null)

Parameters

Parameter	Tags	Description
name	`Required`	name
format	`Required` `DefaultValue`	Response format e.g. json or xml
field1	`Optional`	A custom field name where n is an integer between 1 and 10. Once field names have been set they cannot be changed.
queryParameters	`Optional`	Additional optional query parameters are supported by this method

Example Usage

string name = "name";
string format = "json";
string field1 = "field_1";
// key-value map for optional query parameters
var queryParams = new Dictionary<string, object>();


dynamic result = await lists.AddList(name, format, field1, queryParams);

OptoutListMember

Opt a user out of one list or all lists.

Task<dynamic> OptoutListMember(string listId, string msisdn, string format)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list to opt the user out of. Set this to 0 (zero) to opt out of all of your lists.
msisdn	`Required`	Mobile number of the member to opt out
format	`Required` `DefaultValue`	Response format e.g json or xml

Example Usage

string listId = "list_id";
string msisdn = "msisdn";
string format = "json";

dynamic result = await lists.OptoutListMember(listId, msisdn, format);

DeleteFromList

Remove a member from one list or all lists.

Task<dynamic> DeleteFromList(int listId, string msisdn, string format)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list to remove from. If set to 0 (zero) the member will be removed from all lists.
msisdn	`Required`	Mobile number of the member
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

int listId = 27;
string msisdn = "msisdn";
string format = "json";

dynamic result = await lists.DeleteFromList(listId, msisdn, format);

GetList

Get information about a list and its members.

Task<dynamic> GetList(
        string listId,
        string format,
        string members = null,
        string page = null,
        string max = null)

Parameters

Parameter	Tags	Description
listId	`Required`	List ID
format	`Required` `DefaultValue`	Response format e.g. json or xml
members	`Optional`	Which types of members to return. Possible values: active - only get active members (default) inactive - only get inactive members all - get active and inactive members none - do not get any members, just metadata
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string listId = "list_id";
string format = "json";
string members = "members";
string page = "page";
string max = "max";

dynamic result = await lists.GetList(listId, format, members, page, max);

GetLists

Get the metadata of all your lists.

Task<dynamic> GetLists(string format, string page = null, string max = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string format = "json";
string page = "page";
string max = "max";

dynamic result = await lists.GetLists(format, page, max);

EditListMember

Edit a member of a list.

Task<dynamic> EditListMember(
        string listId,
        string msisdn,
        string format,
        string firstName = null,
        string lastName = null,
        string field1 = null,
        Dictionary<string, object> queryParameters = null)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list the member belongs to
msisdn	`Required`	Mobile number of the member to edit
format	`Required` `DefaultValue`	Response format e.g. json or xml
firstName	`Optional`	First name of the member
lastName	`Optional`	Last name of the member
field1	`Optional`	Custom field value where n is an integer between 1 and 10. You can also use the names of the custom fields you have chosen for your list, e.g. field.birthday. To remove a value set it to an empty string.
queryParameters	`Optional`	Additional optional query parameters are supported by this method

Example Usage

string listId = "list_id";
string msisdn = "msisdn";
string format = "json";
string firstName = "first_name";
string lastName = "last_name";
string field1 = "field.1";
// key-value map for optional query parameters
var queryParams = new Dictionary<string, object>();


dynamic result = await lists.EditListMember(listId, msisdn, format, firstName, lastName, field1, queryParams);

GetContact

Get contact information from a list.

Task<dynamic> GetContact(string listId, string msisdn, string format)

Parameters

Parameter	Tags	Description
listId	`Required`	ID of the list the contact is on.
msisdn	`Required`	Mobile number of the contact.
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string listId = "list_id";
string msisdn = "msisdn";
string format = "json";

dynamic result = await lists.GetContact(listId, msisdn, format);

AddContactsBulk

Upload a list of contacts

Task<dynamic> AddContactsBulk(
        string name,
        string fileUrl,
        string format,
        string countrycode = null,
        string field1 = null,
        Dictionary<string, object> queryParameters = null)

Parameters

Parameter	Tags	Description
name	`Required`	Name of the list
fileUrl	`Required`	URL location of the contact list (NB: The list you are uploading requires a column labelled mobile)
format	`Required` `DefaultValue`	Response format e.g. json or xml
countrycode	`Optional`	Specifies which country the numbers are to be formatted in (e.g AU). If uploading numbers for multiple countries, do not define this, you will need to ensure that all the numbers are in correct international format before upload.
field1	`Optional`	Adds custom fields to the list.
queryParameters	`Optional`	Additional optional query parameters are supported by this method

Example Usage

string name = "name";
string fileUrl = "file_url";
string format = "json";
string countrycode = "countrycode";
string field1 = "field_1";
// key-value map for optional query parameters
var queryParams = new Dictionary<string, object>();


dynamic result = await lists.AddContactsBulk(name, fileUrl, format, countrycode, field1, queryParams);

RemoveList

Delete a list and its members.

Task<dynamic> RemoveList(string listId, string format)

Parameters

Parameter	Tags	Description
listId	`Required`	List ID
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string listId = "list_id";
string format = "json";

dynamic result = await lists.RemoveList(listId, format);

Back to List of Controllers

EmailSMSController

Get singleton instance

The singleton instance of the EmailSMSController class can be accessed from the API Client.

EmailSMSController emailSMS = client.EmailSMS;

AddEmail

Authorise an email address for sending Email to SMS

Task<dynamic> AddEmail(
        string email,
        string number,
        string format,
        string maxSms = null)

Parameters

Parameter	Tags	Description
email	`Required`	Email address to register. You may also register a wild-card email which allows any user on the same domain to use Email to SMS. Wild-card format: *@example.com
number	`Required`	Optional dedicated virtual number virtual number
format	`Required` `DefaultValue`	Response format e.g. json or xml
maxSms	`Optional`	The maximum number of SMS messages to send from one email message sent from this email address. Possible values: 1 - up to 160 characters (default) 2 - up to 306 characters 3 - up to 459 characters 4 - up to 612 characters

Example Usage

string email = "email";
string number = "number";
string format = "json";
string maxSms = "max_sms";

dynamic result = await emailSMS.AddEmail(email, number, format, maxSms);

DeleteEmail

Remove an email address from the Email to SMS authorised list.

Task<dynamic> DeleteEmail(string email, string format)

Parameters

Parameter	Tags	Description
email	`Required`	Email address to remove. You may also use a wild-card email which removes all emails on that domain. Wild-card format: *@example.com
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string email = "email";
string format = "json";

dynamic result = await emailSMS.DeleteEmail(email, format);

Back to List of Controllers

KeywordsController

Get singleton instance

The singleton instance of the KeywordsController class can be accessed from the API Client.

KeywordsController keywords = client.Keywords;

GetKeywords

Get a list of existing keywords.

Task<dynamic> GetKeywords(
        string format,
        string number = null,
        string page = null,
        string max = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
number	`Optional`	Filter the list by virtual number
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string format = "json";
string number = "number";
string page = "page";
string max = "max";

dynamic result = await keywords.GetKeywords(format, number, page, max);

AddKeyword

Add a keyword to an existing virtual number.

Task<dynamic> AddKeyword(
        string keyword,
        string number,
        string format,
        string reference = null,
        string listId = null,
        string welcomeMessage = null,
        string membersMessage = null,
        string activate = null,
        string forwardUrl = null,
        string forwardEmail = null,
        string forwardSms = null)

Parameters

Parameter	Tags	Description
keyword	`Required`	The first word of a text message
number	`Required`	The dedicated virtual number that the keyword belongs to
format	`Required` `DefaultValue`	Response format e.g. json or xml
reference	`Optional`	Your own reference (up to 100 characters)
listId	`Optional`	ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL
welcomeMessage	`Optional`	SMS message to send to new members
membersMessage	`Optional`	SMS message to existing members
activate	`Optional`	Whether to make the keyword active immediately. Possible values: true - activate immediately (default) false - create the keyword but do not activate
forwardUrl	`Optional`	Forward messages to a URL
forwardEmail	`Optional`	Forward messages to a set of email addresses
forwardSms	`Optional`	Forward messages to a set of msisdns

Example Usage

string keyword = "keyword";
string number = "number";
string format = "json";
string reference = "reference";
string listId = "list_id";
string welcomeMessage = "welcome_message";
string membersMessage = "members_message";
string activate = "activate";
string forwardUrl = "forward_url";
string forwardEmail = "forward_email";
string forwardSms = "forward_sms";

dynamic result = await keywords.AddKeyword(keyword, number, format, reference, listId, welcomeMessage, membersMessage, activate, forwardUrl, forwardEmail, forwardSms);

EditKeyword

Edit an existing keyword.

Task<dynamic> EditKeyword(
        string keyword,
        string number,
        string format,
        string reference = null,
        string status = null,
        string listId = null,
        string welcomeMessage = null,
        string membersMessage = null,
        string activate = null,
        string forwardUrl = null,
        string forwardEmail = null,
        string forwardSms = null)

Parameters

Parameter	Tags	Description
keyword	`Required`	The first word of a text message
number	`Required`	The dedicated virtual number that the keyword belongs to
format	`Required` `DefaultValue`	Response format e.g. json or xml
reference	`Optional`	Your own reference (up to 100 characters)
status	`Optional`	Your own reference (up to 100 characters)
listId	`Optional`	ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL
welcomeMessage	`Optional`	SMS message to send to new members
membersMessage	`Optional`	SMS message to existing members
activate	`Optional`	Whether to make the keyword active immediately. Possible values: true - activate immediately (default) false - create the keyword but do not activate
forwardUrl	`Optional`	Forward messages to a URL
forwardEmail	`Optional`	Forward messages to a set of email addresses
forwardSms	`Optional`	Forward messages to a set of msisdns

Example Usage

string keyword = "keyword";
string number = "number";
string format = "json";
string reference = "reference";
string status = "status";
string listId = "list_id";
string welcomeMessage = "welcome_message";
string membersMessage = "members_message";
string activate = "activate";
string forwardUrl = "forward_url";
string forwardEmail = "forward_email";
string forwardSms = "forward_sms";

dynamic result = await keywords.EditKeyword(keyword, number, format, reference, status, listId, welcomeMessage, membersMessage, activate, forwardUrl, forwardEmail, forwardSms);

Back to List of Controllers

ResellersController

Get singleton instance

The singleton instance of the ResellersController class can be accessed from the API Client.

ResellersController resellers = client.Resellers;

GetTransaction

Get a list of transactions for an account.

Task<dynamic> GetTransaction(string id, string format)

Parameters

Parameter	Tags	Description
id	`Required`	Transaction ID
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string id = "id";
string format = "json";

dynamic result = await resellers.GetTransaction(id, format);

EditClient

Edit an existing client

Task<dynamic> EditClient(
        string clientId,
        string format,
        string name = null,
        string contact = null,
        string password = null,
        string msisdn = null,
        string timezone = null,
        string clientPays = null,
        string smsMargin = null,
        int? fixedTopUpAmount = null,
        string paymentMethod = null)

Parameters

Parameter	Tags	Description
clientId	`Required`	The ID of the client
format	`Required` `DefaultValue`	Response format e.g. json or xml
name	`Optional`	Client company name. Must be unique
contact	`Optional`	Contact name
password	`Optional`	Client password
msisdn	`Optional`	Client phone number
timezone	`Optional`	A valid timezone, Australia/Sydney. Defaults to your own
clientPays	`Optional`	Set to true if the client will pay (the default) or false if you will pay
smsMargin	`Optional`	The number of cents to add to the base SMS price. A decimal value.
fixedTopUpAmount	`Optional`	Fixed top up amount
paymentMethod	`Optional`	Payment Method e.g. variable or fixed

Example Usage

string clientId = "client_id";
string format = "json";
string name = "name";
string contact = "contact";
string password = "password";
string msisdn = "msisdn";
string timezone = "timezone";
string clientPays = "client_pays";
string smsMargin = "sms_margin";
int? fixedTopUpAmount = 27;
string paymentMethod = "payment_method";

dynamic result = await resellers.EditClient(clientId, format, name, contact, password, msisdn, timezone, clientPays, smsMargin, fixedTopUpAmount, paymentMethod);

GetTransactions

Get a list of transactions for a client.

Task<dynamic> GetTransactions(
        string clientId,
        string format,
        string start = null,
        string end = null,
        string page = null,
        string max = null)

Parameters

Parameter	Tags	Description
clientId	`Required`	Only retrieve records for a particular client
format	`Required` `DefaultValue`	Response format e.g. json or xml
start	`Optional`	A timestamp to start the report from
end	`Optional`	A timestamp to end the report at
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string clientId = "client_id";
string format = "json";
string start = "start";
string end = "end";
string page = "page";
string max = "max";

dynamic result = await resellers.GetTransactions(clientId, format, start, end, page, max);

GetClient

Get detailed information about a client.

Task<dynamic> GetClient(string clientId, string format)

Parameters

Parameter	Tags	Description
clientId	`Required`	The ID of the client
format	`Required` `DefaultValue`	Response format e.g. json or xml

Example Usage

string clientId = "client_id";
string format = "json";

dynamic result = await resellers.GetClient(clientId, format);

GetClients

Get a list of all clients.

Task<dynamic> GetClients(string format, string page = null, string max = null)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format e.g. json or xml
page	`Optional`	Page number, for pagination
max	`Optional`	Maximum results returned per page

Example Usage

string format = "json";
string page = "page";
string max = "max";

dynamic result = await resellers.GetClients(format, page, max);

AddClient

Add a new client.

Task<dynamic> AddClient(
        string name,
        string email,
        string password,
        string msisdn,
        string format,
        string contact = null,
        string timezone = null,
        string clientPays = null,
        string smsMargin = null,
        string numberMargin = null,
        int? fixedTopUpAmount = null,
        string paymentMethod = null,
        string apiSecret = null)

Parameters

Parameter	Tags	Description
name	`Required`	Client company name
email	`Required`	Client email address
password	`Required`	Client password
msisdn	`Required`	Client phone number
format	`Required` `DefaultValue`	Response format e.g. json
contact	`Optional`	Contact name
timezone	`Optional`	A valid timezone, Australia/Sydney. Defaults to your own
clientPays	`Optional`	Set to true if the client will pay (the default) or false if you will pay
smsMargin	`Optional`	The number of cents to add to the base SMS price. A decimal value
numberMargin	`Optional`	The number of cents to add to the base number price. A decimal value
fixedTopUpAmount	`Optional`	Fixed top up amount
paymentMethod	`Optional`	Payment Method e.g. variable or fixed
apiSecret	`Optional`	API Secret. Note: if omitted it will be auto generated

Example Usage

string name = "name";
string email = "email";
string password = "password";
string msisdn = "msisdn";
string format = "json";
string contact = "contact";
string timezone = "timezone";
string clientPays = "client_pays";
string smsMargin = "sms_margin";
string numberMargin = "number_margin";
int? fixedTopUpAmount = 27;
string paymentMethod = "payment_method";
string apiSecret = "api_secret";

dynamic result = await resellers.AddClient(name, email, password, msisdn, format, contact, timezone, clientPays, smsMargin, numberMargin, fixedTopUpAmount, paymentMethod, apiSecret);

Back to List of Controllers

AccountController

Get singleton instance

The singleton instance of the AccountController class can be accessed from the API Client.

AccountController account = client.Account;

GetBalance

Get a summary of your account balance.

Task<dynamic> GetBalance(string format)

Parameters

Parameter	Tags	Description
format	`Required` `DefaultValue`	Response format

Example Usage

string format = "json";

dynamic result = await account.GetBalance(format);

Back to List of Controllers

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
TransmitSMS.Standard		TransmitSMS.Standard
LICENSE		LICENSE
README.md		README.md
TransmitSMS.sln		TransmitSMS.sln

License

transmitsms/transmitsms-api-csharp-client

Folders and files

Latest commit

History

Repository files navigation

Getting started

How to Build

How to Use

1. Starting a new project

2. Set as startup project

3. Add reference of the library project

4. Write sample code

How to Test

Initialization

Authentication

Class Reference

List of Controllers

SMSController

Get singleton instance

SendSMS

Parameters

Example Usage

FormatNumber

Parameters

Example Usage

GetSMS

Parameters

Example Usage

GetSMSStats

Parameters

Example Usage

GetSMSResponses

Parameters

Example Usage

GetUserSMSResponses

Parameters

Example Usage

GetLinkHits

Parameters

Example Usage

GetSMSSent

Parameters

Example Usage

GetSMSDeliveryStatus

Parameters

Example Usage

CancelSMS

Parameters

Example Usage

GetContactSMSStats

Parameters

Example Usage

NumbersController

Get singleton instance

LeaseNumber

Parameters

Example Usage

EditNumberOptions

Parameters

Example Usage

GetNumbers

Parameters

Example Usage

GetNumber

Parameters

Example Usage

GetSenderIds

Parameters

Example Usage

ListsController

Get singleton instance

AddToList

Parameters

Example Usage

AddFieldToList

Parameters

Example Usage

AddList

Parameters