Register your account

If you don't have an account, head to https://www.tnz.co.nz/Customer/SignUp/ and fill in the form.

Create an API user

To access the API, you'll need a User with API access:

1. Log into the TNZ Dashboard
2. Select Users from the menu, then click Create to create a new user, or select an existing user from the list.
3. Under the API Options tab, if API access isn't set up, toggle Enable API, then create an "API Key" (you can click the Generate button to auto-create one), then click Update to save your changes.
4. Under the API Options tab, next to "Auth Token" click Copy button. This will copy your Auth Token to your clipboard.

The API v2.02 uses JWT token Authentication. Contact your TNZ Representative for OAuth2 authentication.

You can use one Auth Token for multiple use-cases, using the SubAccount and Department values to track reporting and billing.

Understanding the .NET Library basics

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

For a brief overview of the API, see the TNZ API Structure guide.

Download the Library:

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

Install & Reference the Library:

Reference the library in your code:

Send Messages using the Library:

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

Capture Status & Replies using the Library:

Message Status and Received Messages can be captured using a Webhook (a POST to your nominated URL), or can be Polled for using the DLL's GET function.

See Status Reporting and Receive Messages.

Send Messages - build your application with the .NET Library

Find instructions for each Message Type:

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 = Enums.SendModeType.Test;

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

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

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

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

Edit Messages - Edit a submitted message

Once a message has been sent, you can retry a failed message, reschedule a delayed message, abort a delayed message and edit the NumberOfOperators value on Voice/TTS messages.

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetResubmit
{
    class Program
    {
        static void Main(string[] args)
        {
            ResubmitRequest request = new ResubmitRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",          // Auth Token
                //Sender = "application@domain.com",    // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                 // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                  // MessageID
            };

            ResubmitRequestResult response = request.Submit();

            if (response.Result == ResubmitRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Action: '" + response.Action + "'");
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetResubmit
{
    class Program
    {
        static void Main(string[] args)
        {
            ResubmitRequest request = new ResubmitRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",          // Auth Token
                //Sender = "application@domain.com",    // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                 // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                  // MessageID
            };

            ResubmitRequestResult response = request.Submit();

            if (response.Result == ResubmitRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Action: '" + response.Action + "'");
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetResubmitBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // Sample code using ResubmitRequestBuilder()
            //

            var request = new ResubmitRequestBuilder()
                            .SetAuthToken("[Your Auth Token]")          // Auth Token
                            .SetMessageID("ID123456")                   // MessageID
                            .SetSendTime(new DateTime().AddMinutes(5))  // Optional: Set SendTime
                            .Build();                                   // Build ResubmitRequestBuilder() object

            var result = request.Submit();

            if (result.Result == ResubmitRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetResubmit
{
    class Program
    {
        static void Main(string[] args)
        {
            ResubmitRequest request = new ResubmitRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",          // Auth Token
                //Sender = "application@domain.com",    // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                 // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                  // MessageID
            };

            ResubmitRequestResult response = request.Submit();

            if (response.Result == ResubmitRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Action: '" + response.Action + "'");
            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetReschedule
{
    class Program
    {
        static void Main(string[] args)
        {
            RescheduleRequest request = new RescheduleRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",                      // Auth Token
                //Sender = "application@domain.com",                // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                             // API Key - Using Auth Token is recommended
                MessageID = "ID123456",                             // MessageID
                SendTime = DateTime.Parse("2021-12-31 12:00:00")    // Set send time
            };

            RescheduleRequestResult result = request.Submit();

            if (result.Result == RescheduleRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetReschedule
{
    class Program
    {
        static void Main(string[] args)
        {
            RescheduleRequest request = new RescheduleRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",                      // Auth Token
                //Sender = "application@domain.com",                // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                             // API Key - Using Auth Token is recommended
                MessageID = "ID123456",                             // MessageID
                SendTime = DateTime.Parse("2021-12-31 12:00:00")    // Set send time
            };

            RescheduleRequestResult result = request.Submit();

            if (result.Result == RescheduleRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetRescheduleBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // Sample code using RescheduleRequestBuilder()
            //

            var request = new RescheduleRequestBuilder()
                            .SetAuthToken("[Your Auth Token]")          // Auth Token
                            .SetMessageID("ID123456")                   // MessageID
                            .SetSendTime(new DateTime().AddMinutes(5))  // Set SendTime
                            .Build();                                   // Build AbortRequest() object

            var result = request.Submit();

            if (result.Result == RescheduleRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetReschedule
{
    class Program
    {
        static void Main(string[] args)
        {
            RescheduleRequest request = new RescheduleRequest
            {
                AuthToken = "YOUR_AUTH_TOKEN",                      // Auth Token
                //Sender = "application@domain.com",                // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                             // API Key - Using Auth Token is recommended
                MessageID = "ID123456",                             // MessageID
                SendTime = DateTime.Parse("2021-12-31 12:00:00")    // Set send time
            };

            RescheduleRequestResult result = request.Submit();

            if (result.Result == RescheduleRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetAbort
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // AuthToken can be found from our web portal
            //

            AbortRequest request = new AbortRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                      // MessageID
            };

            AbortRequestResult result = request.Submit();

            if (result.Result == AbortRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetAbort
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // AuthToken can be found from our web portal
            //

            AbortRequest request = new AbortRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                      // MessageID
            };

            AbortRequestResult result = request.Submit();

            if (result.Result == AbortRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetAbortBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // Sample code using AbortRequestBuilder()
            //

            var request = new AbortRequestBuilder()
                            .SetAuthToken("[Your Auth Token]")      // Auth Token
                            .SetMessageID("ID123456")               // MessageID
                            .Build();                               // Build AbortRequest() object

            var result = request.Submit();

            if (result.Result == AbortRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetAbort
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // AuthToken can be found from our web portal
            //

            AbortRequest request = new AbortRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended
                MessageID = "ID123456"                      // MessageID
            };

            AbortRequestResult result = request.Submit();

            if (result.Result == AbortRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetPacing
{
    class Program
    {
        static void Main(string[] args)
        {
            PacingRequest request = new PacingRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended

                MessageID = "ID123456",                     // MessageID
                NumberOfOperators = 1                       // No. of concurrent calls
            };

            PacingRequestResult result = request.Submit();

            if (result.Result == PacingRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetPacing
{
    class Program
    {
        static void Main(string[] args)
        {
            PacingRequest request = new PacingRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended

                MessageID = "ID123456",                     // MessageID
                NumberOfOperators = 1                       // No. of concurrent calls
            };

            PacingRequestResult result = request.Submit();

            if (result.Result == PacingRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetPacingBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            //
            // Sample code using PacingRequestBuilder()
            //

            var request = new PacingRequestBuilder()
                            .SetAuthToken("[Your Auth Token]")      // Auth Token
                            .SetMessageID("ID123456")               // MessageID
                            .SetNumberOfOperators(5)                // No. of concurrent calls
                            .Build();                               // Build PacingRequest() object

            var result = request.Submit();

            if (result.Result == PacingRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

using TNZAPI.Messaging.Objects;
using TNZAPI.Messaging.Set;

namespace TNZSetPacing
{
    class Program
    {
        static void Main(string[] args)
        {
            PacingRequest request = new PacingRequest
            {
                AuthToken = "[YOUR_AUTH_TOKEN]",            // Auth Token
                //Sender = "application@domain.com",        // API Sender - Using Auth Token is recommended
                //APIKey = "ta8wr7ymd",                     // API Key - Using Auth Token is recommended

                MessageID = "ID123456",                     // MessageID
                NumberOfOperators = 1                       // No. of concurrent calls
            };

            PacingRequestResult result = request.Submit();

            if (result.Result == PacingRequestResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + result.MessageID + "':");
                Console.WriteLine(" => Status: '" + result.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + result.JobNum + "'");
                Console.WriteLine(" => Action: '" + result.Action + "'");
            }
            else
            {
                Console.WriteLine("Error occurred while processing MessageID '" + request.MessageID + "' : '" + result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

Status Reporting - Reporting and event tracking

Delivery Reports advise whether delivery was successful. If not, it will describe why.

Each delivery report type is optional and multiple delivery report types can be used.

Web Dashboard - Tracking message statuses via the online 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.

SMTP Email - Receive message statuses via email

Delivery reports are emailed as an HTML email for viewing by an end-user. Your sales representative can enable this for you.

Whitelabelling of SMTP Email reports is available.

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

Webhook - Message statuses delivered via a webhook

To receive Delivery Reports via Webhook, please advise the URL to submit to.

Webhooks are delivered as an HTTP POST in either XML or JSON format (your preference).
Webhook failures are retried every five minutes for a maximum of 24 hours.

Supplied parameters are:

GET Status Poll - Track message statuses using a GET poll

You are able to poll for the status of a message via the GET Status API.

The Poll should be configured to timeout after 48 hours with no result.

Reference : TNZAPI.Messaging.Get

using System;

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

namespace TNZGetStatus
{
    class Program
    {
        static void Main(string[] args)
        {
            StatusRequest request = new StatusRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            StatusRequestResult response = request.Poll();

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

            Console.ReadLine();
        }

    }
}
                                          
Copy code

using System;

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

namespace TNZGetStatus
{
    class Program
    {
        static void Main(string[] args)
        {
            StatusRequest request = new StatusRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            StatusRequestResult response = request.Poll();

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

            Console.ReadLine();
        }

    }
}
                                          
Copy code

using System;

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

namespace TNZGetStatusBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            // Sample code use StatusRequestBuilder()

            var request = new StatusRequestBuilder()
                                .SetAuthToken("[Your Auth Token]")      // Auth Token
                                .SetMessageID("ID123456")               // MessageID
                                .Build();                               // Build StatusRequest() object

            var response = request.Poll();

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

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZGetStatus
{
    class Program
    {
        static void Main(string[] args)
        {
            StatusRequest request = new StatusRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            StatusRequestResult response = request.Poll();

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

            Console.ReadLine();
        }

    }
}
                                          
Copy code

Receive Messages - Track messages received

Currently, tracking SMS Received is supported.

Tracking of faxes and voicemail received is scheduled for a future release. Let your account manager know if this interests you.

Web Dashboard - Tracking messages received via the online 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.

SMTP Email - Track messages received via email

Delivery reports are emailed as an HTML email for viewing by an end-user. Your sales representative can enable this for you.
Whitelabelling of SMTP Email reports is available.

When submitting SMS messages, specify the SMSEmailReply parameter.

Webhook - Messages received data delivered via a webhook

If you are set up to receive Status webhooks, you will also be receiving SMS Received webhooks.

To receive SMS replies via Webhook, please advise the URL to submit to.

Webhooks are delivered as an HTTP POST in either XML or JSON format (your preference).
Webhook failures are retried every five minutes for a maximum of 24 hours.

The mobile has 7 days to reply to a message. Any replies received after the 7 day window will be treated as a new message.

Supplied parameters are:

GET SMS Received Poll - Track SMS Received using a GET poll

You are able to poll for all received SMS messages in a given time-frame.

The Poll should be configured to timeout after 48 hours with no result.

Reference : TNZAPI.Messaging.Get

using System;

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

namespace TNZ_Get_SMS_Received
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReceivedRequest request = new SMSReceivedRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.TimePeriod = 1440;                          // No. of minutes

            SMSReceivedResult sms_received_result = request.Poll();

            if (sms_received_result.Result == SMSReceivedResult.ResultCode.Success)
            {
                Console.WriteLine("Inbound SMS Messages for the Time Period '" + request.TimePeriod.ToString() + "':");

                foreach (SMSReceivedMessage received in sms_received_result.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText.Replace("'", "\'") + "'");
                }

            }
            else
            {
                Console.WriteLine("Could not find any inbound sms messages for the time period '" + request.TimePeriod.ToString() + "' : '" + sms_received_result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZ_Get_SMS_Received
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReceivedRequest request = new SMSReceivedRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.TimePeriod = 1440;                          // No. of minutes

            SMSReceivedResult sms_received_result = request.Poll();

            if (sms_received_result.Result == SMSReceivedResult.ResultCode.Success)
            {
                Console.WriteLine("Inbound SMS Messages for the Time Period '" + request.TimePeriod.ToString() + "':");

                foreach (SMSReceivedMessage received in sms_received_result.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText.Replace("'", "\'") + "'");
                }

            }
            else
            {
                Console.WriteLine("Could not find any inbound sms messages for the time period '" + request.TimePeriod.ToString() + "' : '" + sms_received_result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZGetSMSReceivedBuilder
{
    internal class Program
    {
        static void Main(string[] args)
        {
            // Sample code use SMSReceivedRequestBuilder()

            var request = new SMSReceivedRequestBuilder()               
                                .SetAuthToken("[Your Auth Token]")      // Auth Token
                                .SetTimePeriod(1440)                    // No. of minutes
                                .SetDateFrom(                           // Optional: Set DateFrom
                                    DateTime.Parse("2022-08-01 00:00:00")
                                )
                                .SetDateTo(                             // Optional: Set DateTo
                                    DateTime.Parse("2022-08-01 23:59:59")
                                )
                                .SetRecordsPerPage(10)                  // Optional: Set Records Per Page
                                .SetPage(1)                             // Optional: Current page
                                .Build();                               // Build SMSReceivedRequest() object

            var response = request.Poll();

            if (response.Result == SMSReceivedResult.ResultCode.Success)
            {
                Console.WriteLine($"Inbound SMS Messages ( found):");

                Console.WriteLine($" => {response.ReceivedMessages.Count} MessageReceived");

                foreach (var message in response.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + message.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + message.From + "'");
                    Console.WriteLine("    -> MessageText: '" + message.MessageText.Replace("'", "\'") + "'");
                }

            }
            else
            {
                Console.WriteLine($"Error occurred while processing - '{response.ErrorMessage}'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZ_Get_SMS_Received
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReceivedRequest request = new SMSReceivedRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";                      // Auth Token
            request.DateFrom = DateTime.Parse("2022-08-01T00:00:00");   // Return results from the date/time
            request.DateTo = DateTime.Parse("2022-08-01T23:59:59");     // Return results to the date/time
            request.RecordsPerPage = 10;                                // x numbers of records to return per request
            request.Page = 1;                                           // current location

            SMSReceivedResult sms_received_result = request.Poll();

            if (sms_received_result.Result == SMSReceivedResult.ResultCode.Success)
            {
                Console.WriteLine("Inbound SMS Messages for the Time Period '" + request.TimePeriod.ToString() + "':");

                foreach (SMSReceivedMessage received in sms_received_result.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText.Replace("'", "\'") + "'");
                }

            }
            else
            {
                Console.WriteLine("Could not find any inbound sms messages for the time period '" + request.TimePeriod.ToString() + "' : '" + sms_received_result.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

GET SMS Reply Poll - Track SMS replies using a GET poll

You are able to poll for replies to a specific SMS message, tracked using the MessageID on the outbound message.

The Poll should be configured to timeout after 48 hours with no result.

Reference : TNZAPI.Messaging.Get

using System;

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

namespace TNZGetSMSReply
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReplyRequest request = new SMSReplyRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            SMSReplyResult response = request.Poll();

            if (response.Result == SMSReplyResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Account: '" + response.Account + "'");
                Console.WriteLine(" => SubAccount: '" + response.SubAccount + "'");
                Console.WriteLine(" => Department: '" + response.Department + "'");
                Console.WriteLine("======================================");
                Console.WriteLine(" => MessageSent");
                Console.WriteLine("    -> Date: '" + response.SentMessage.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                Console.WriteLine("    -> Destination: '" + response.SentMessage.Destination + "'");
                Console.WriteLine("    -> MessageText: '" + response.SentMessage.MessageText + "'");

                foreach (SMSReceivedMessage received in response.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText + "'");
                }

            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZGetSMSReply
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReplyRequest request = new SMSReplyRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            SMSReplyResult response = request.Poll();

            if (response.Result == SMSReplyResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Account: '" + response.Account + "'");
                Console.WriteLine(" => SubAccount: '" + response.SubAccount + "'");
                Console.WriteLine(" => Department: '" + response.Department + "'");
                Console.WriteLine("======================================");
                Console.WriteLine(" => MessageSent");
                Console.WriteLine("    -> Date: '" + response.SentMessage.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                Console.WriteLine("    -> Destination: '" + response.SentMessage.Destination + "'");
                Console.WriteLine("    -> MessageText: '" + response.SentMessage.MessageText + "'");

                foreach (SMSReceivedMessage received in response.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText + "'");
                }

            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZGetSMSReplyBuilder
{
    class Program
    {
        static void Main(string[] args)
        {
            // Sample code use SMSReplyRequestBuilder()

            var request = new SMSReplyRequestBuilder()
                                .SetAuthToken("[Your Auth Token]")      // Auth Token
                                .SetMessageID("ID123456")               // MessageID
                                .Build();                               // Build SMSReplyRequest() object

            var response = request.Poll();

            if (response.Result == SMSReplyResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Account: '" + response.Account + "'");
                Console.WriteLine(" => SubAccount: '" + response.SubAccount + "'");
                Console.WriteLine(" => Department: '" + response.Department + "'");
                Console.WriteLine("======================================");
                Console.WriteLine(" => MessageSent");
                Console.WriteLine("    -> Date: '" + response.SentMessage.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                Console.WriteLine("    -> Destination: '" + response.SentMessage.Destination + "'");
                Console.WriteLine("    -> MessageText: '" + response.SentMessage.MessageText + "'");

                foreach (SMSReceivedMessage received in response.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText + "'");
                }

            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

using System;

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

namespace TNZGetSMSReply
{
    class Program
    {
        static void Main(string[] args)
        {
            SMSReplyRequest request = new SMSReplyRequest();

            request.AuthToken = "YOUR_AUTH_TOKEN";              // Auth Token
            request.MessageID = "ID123456";

            SMSReplyResult response = request.Poll();

            if (response.Result == SMSReplyResult.ResultCode.Success)
            {
                Console.WriteLine("Status of MessageID '" + response.MessageID + "':");
                Console.WriteLine(" => Status: '" + response.GetStatusString() + "'");
                Console.WriteLine(" => JobNum: '" + response.JobNum + "'");
                Console.WriteLine(" => Account: '" + response.Account + "'");
                Console.WriteLine(" => SubAccount: '" + response.SubAccount + "'");
                Console.WriteLine(" => Department: '" + response.Department + "'");
                Console.WriteLine("======================================");
                Console.WriteLine(" => MessageSent");
                Console.WriteLine("    -> Date: '" + response.SentMessage.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                Console.WriteLine("    -> Destination: '" + response.SentMessage.Destination + "'");
                Console.WriteLine("    -> MessageText: '" + response.SentMessage.MessageText + "'");

                foreach (SMSReceivedMessage received in response.ReceivedMessages)
                {
                    Console.WriteLine("======================================");
                    Console.WriteLine(" => MessageReceived");
                    Console.WriteLine("    -> Date: '" + received.Date.ToString("yyyy-MM-dd hh:mm:ss") + "'");
                    Console.WriteLine("    -> From: '" + received.From + "'");
                    Console.WriteLine("    -> MessageText: '" + received.MessageText + "'");
                }

            }
            else
            {
                Console.WriteLine("Cannot find MessageID '" + request.MessageID + "' : '" + response.ErrorMessage + "'");
            }

            Console.ReadLine();
        }
    }
}
                                          
Copy code

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