Using a single DLL library, C# / .NET developers can send Email, SMS, Fax, Voice and Text-to-Speech messages using their own software.

Register your account

Head to https://www.tnz.co.nz/Services/SignUp to create a new account.

A test account is possible, however creating a commerical account and using the SendMode=[MessageType].SendModeType.Test function of the library is simpler to use when you’re ready to push your application live.

After completing the sign up form, a sales consultant will manually activate your account. This may take one business day. Once the account has been activated, you will be able to Create a new API user token.

Create a new API user token

Using the API will require a Sender and APIKey pair to authenticate with the API.

You can generate this using the Web Dashboard under: Users | Outbound Users | Create
User Email Address = Sender
User Token = APIKey

Understanding the .NET Library basics

Save hundreds of lines of code and hours of time by dropping the .NET DLL into your project and sending messages via TNZ. Using one DLL and simple code tweaks, your software can send Email, SMS, Fax, Voice and Text-to-Speech messages.

Using the [MessageType].SendMessage() function, the DLL will connect to TNZ's REST API (in XML format) and submit messages.

Building your application with the .NET Library

Step 1: Download and extract the .NET library DLL:   TNZAPI.dll.zip

Step 2:Add Reference downloaded DLL into your project(s)

Step 3: Reference library to your code

using TNZAPI;
using TNZAPI.Messaging;
using TNZAPI.Messaging.Functions;
using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Send;
using TNZAPI.Messaging.Get;
                                      

Resending and retrying messages

To resend or retry sending a message via API, this will need to be submitted as a new, unique message.
To resend or retry sending a message via the Web Dashboard, once logged in and viewing an individual message, you will see Resubmit and Forward buttons.

Sending messages in test mode

Under Message object you can specify an additional SendMode=Test parameter.

SendMode=Test means any messages will be handled by the API, instantly called a SUCCESS and the success report will be delivered to you. This is a useful way to end-to-end test without sending a live message.

// For Email
EmailMessage.SendMode = Email.SendModeType.Test;

// For SMS
SMSMessage.SendMode = SMS.SendModeType.Test;

// For Fax
FaxMessage.SendMode = Fax.SendModeType.Test;

// For Voice
VoiceMessage.SendMode = Voice.SendModeType.Test;

// For TTS
TTSMessage.SendMode = TTS.SendModeType.Test;
                                              

Delivery reporting and event tracking

Delivery Reports advise whether a message’s delivery was successful. If not, it will describe why. Delivery reports can be supplied via Webhook or SMTP Email, or accessed by logging into the Web Dashboard.

Each delivery report type is optional.

1. Web Dashboard

You will be supplied with a Web Dashboard login at registration. The Dashboard can be used to set up new sender/token pairs, as well as track sent and replied messages. You can drill into specific messages to view individual events, such as delivery attempts, retries, replies, results, clicks, etc.

2. SMTP Email

A Webhook is preferred, however Delivery Reports can be emailed if desired (analytics reports are not sent via SMTP Email).
Please advise the email address to email these to.

The email address to receive SMS Reply reports can be specified on the original message submission using the SMSEmailReply parameter.

Whitelabelling of SMTP Email reports is available.

3. Webhook

To receive Delivery Reports via Webhook, please advise the URL to submit to.
Webhooks are provided as an HTTP POST in either XML or JSON format (your preference).

Supplied parameters are:

4. GET Status Poll

API users able poll status of message (summary) through Get Status API.

Reference : TNZAPI.Messaging.Get

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Get;

namespace TNZStatusPoll
{
    class Program
    {
        static void Main(string[] args)
        {
            const string sender = "application@domain.com";
            const string api_key = "ta8wr7ymd";
            const string message_id = "ID123456";

            StatusRequest status_request = new StatusRequest(sender, api_key);

            StatusResult status_result = status_request.Poll(message_id);

            if( status_result.Result == StatusResult.ResultCode.Success )
            {
                Console.WriteLine("Status of MessageID '" + message_id + "':");
                Console.WriteLine(" => Status: '" + status_result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + status_result.JobNum + "'");
                Console.WriteLine(" => Account: '" + status_result.Account + "'");
                Console.WriteLine(" => SubAccount: '" + status_result.SubAccount + "'");
                Console.WriteLine(" => Department: '" + status_result.Department + "'");
                Console.WriteLine(" => Count: " + status_result.Count.ToString());
                Console.WriteLine(" => Complete: " + status_result.Complete.ToString());
                Console.WriteLine(" => Success: " + status_result.Success.ToString());
                Console.WriteLine(" => Failed: " + status_result.Failed.ToString());
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + message_id + "' : '" + status_result.ErrorMessage + "'");
            }
        }
    }
}
                                          
Download snippet

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Get;

namespace TNZStatusPoll
{
    class Program
    {
        static void Main(string[] args)
        {
            const string sender = "application@domain.com";
            const string api_key = "ta8wr7ymd";
            const string message_id = "ID123456";

            StatusRequest status_request = new StatusRequest(sender, api_key);

            StatusResult status_result = status_request.Poll(message_id);

            if( status_result.Result == StatusResult.ResultCode.Success )
            {
                Console.WriteLine("Status of MessageID '" + message_id + "':");
                Console.WriteLine(" => Status: '" + status_result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + status_result.JobNum + "'");
                Console.WriteLine(" => Account: '" + status_result.Account + "'");
                Console.WriteLine(" => SubAccount: '" + status_result.SubAccount + "'");
                Console.WriteLine(" => Department: '" + status_result.Department + "'");
                Console.WriteLine(" => Count: " + status_result.Count.ToString());
                Console.WriteLine(" => Complete: " + status_result.Complete.ToString());
                Console.WriteLine(" => Success: " + status_result.Success.ToString());
                Console.WriteLine(" => Failed: " + status_result.Failed.ToString());
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + message_id + "' : '" + status_result.ErrorMessage + "'");
            }
        }
    }
}
                                          
Download snippet

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Get;

namespace TNZStatusPoll
{
    class Program
    {
        static void Main(string[] args)
        {
            const string sender = "paul@tnz.co.nz";
            const string api_key = "15153";
            const string message_id = "AE8CB484-834E-DDD0-F326-B6575F53DA78";

            StatusRequest status_request = new StatusRequest(sender, api_key);

            StatusResult status_result = status_request.Poll(message_id);

            if( status_result.Result == StatusResult.ResultCode.Success )
            {
                Console.WriteLine("Status of MessageID '" + message_id + "':");
                Console.WriteLine(" => Status: '" + status_result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + status_result.JobNum + "'");
                Console.WriteLine(" => Account: '" + status_result.Account + "'");
                Console.WriteLine(" => SubAccount: '" + status_result.SubAccount + "'");
                Console.WriteLine(" => Department: '" + status_result.Department + "'");
                Console.WriteLine(" => Count: " + status_result.Count.ToString());
                Console.WriteLine(" => Complete: " + status_result.Complete.ToString());
                Console.WriteLine(" => Success: " + status_result.Success.ToString());
                Console.WriteLine(" => Failed: " + status_result.Failed.ToString());
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + message_id + "' : '" + status_result.ErrorMessage + "'");
            }
        }
    }
}
                                          
Download snippet

As new versions of the APIs are released, this API reference guide will be updated to reflect the latest version and features supported:
API Version ChangeLog