NodeJS Library Introduction

const TNZAPI = require('tnzapi');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
    console.log("Response: ",JSON.stringify(data, null, "  "));
};

client.Messaging.Email.SendMessage({
    FromEmail: "from@test.com",             // Optional : Sets From Email Address - leave blank to use your api username as email sender
    EmailSubject: "Test Email",             // Email Subject
    MessagePlain: "Test Email Body",        // Email Body
    Destinations: [                         // Email Recipients
      { Recipient: "email.one@test.com" },
      { Recipient: "email.two@test.com" }
    ]
}).then(callback); // Send Message 

const TNZAPI = require('tnzapi');
const ContactModel = require('tnzapi/lib/Api/Addressbook/Contacts/models/ContactModel');
const GroupModel = require('tnzapi/lib/Api/Addressbook/Groups/models/GroupModel');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
    console.log("Response: ",JSON.stringify(data, null, "  "));
};

client.Messaging.Email.SendMessage({
  
    MessageID: "ID12345",                           // Your custom MessageID
    Reference: "Test Email - Advanced version",     // Your reference

    SMTPFrom: "email@test.com",                     // Sender SMTP From Address
    From: "Test Email",                             // Sender Email Name
    FromEmail: "from@test.com",                     // Sender Email Address
    ReplyTo: "reply@test.com",                      // Set Reply To

    EmailSubject: "Test Email",                     // Email subject
    MessagePlain: "Test Email Body",                // Email body (plain text)
    MessageHTML: "<html><body><p>This is <b>Test message body</b>. Thank you so much!</p></body></html>",

    Destinations: [                                 // Email Recipients
        {
            Recipient: "email1@test.com",           // Recipient Email Address
            Company: "Test Company",                // Company Name
            Attention: "Test Recipient",            // Attention
            Custom1: "Custom1",                     // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Recipient: "email2@test.com",           // Recipient Email Address
            Company: "Test Company 2",              // Company Name
            Attention: "Test Recipient 2",          // Attention
            Custom1: "Custom1",                     // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Group: new GroupModel({
                GroupID: "GGGGGGGG-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
            })
        },
        {
            GroupID: "GGGGGGGG-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        },
        {
            Contact: new ContactModel({
                ContactID: "CCCCCCCC-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            })
        },
        {
            ContactID: "CCCCCCCC-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        }
    ],

    Attachments: [
        "D:\\File1.pdf",
        "D:\\File2.pdf"
    ]
}).then(callback); // Send Message 

const TNZAPI = require('tnzapi');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
    console.log("Response: ",JSON.stringify(data, null, "  "));
};

client.Messaging.SMS.SendMessage({
    Reference: "Test",                  // Optional
    Message: "Test SMS",                // SMS Message
    Destinations: [                     // SMS Recipients
      { Recipient: "+64211111111" },
      { Recipient: "+64222222222" }
    ]
}).then(callback); // Send Message 

const TNZAPI = require('tnzapi');
const ContactModel = require('tnzapi/lib/Api/Addressbook/Contacts/models/ContactModel');
const GroupModel = require('tnzapi/lib/Api/Addressbook/Groups/models/GroupModel');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response: ",JSON.stringify(data, null, "  "));
};

client.Messaging.SMS.SendMessage({

    MessageID: "ID12345",                             // MessageID - Leave blank to auto-generate
    Reference: "Test SMS - Advanced version",         // Reference
    SMSEmailReply: "test@example.com",                // Email address to receive reply back
    CharacterConversion: true,                        //  Convert multi-byte characters into normalised GSM character
    Message: "Test SMS Message for [[Attention]] at [[Company]]. Click [[File1]] | [[File2]] to download files.",                              // SMS Message
    Destinations: [                                   // SMS Recipients
        {
            Recipient: "+64211231234",                // Recipient Mobile Number
            Company: "Test Company",                  // Company Name
            Attention: "Test Recipient",              // Attention
            Custom1: "Custom1",                       // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Recipient: "+64271231234",                // Recipient Mobile Number
            Company: "Test Company 2",                // Company Name
            Attention: "Test Recipient 2",            // Attention
            Custom1: "Custom1",                       // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Group: new GroupModel({
                GroupID: "GGGGGGGG-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
            })
        },
        {
            GroupID: "GGGGGGGG-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        },
        {
            Contact: new ContactModel({
                ContactID: "CCCCCCCC-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            })
        },
        {
            ContactID: "CCCCCCCC-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        }
    ],
    Attachments: [
        "D:/File1.pdf",
        "D:/File2.pdf",
    ]
    
}).then(callback); // Send Message 

const TNZAPI = require('tnzapi');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
    console.log("Response:",JSON.stringify(data, null, "  "));
};

client.Messaging.Fax.SendMessage({
    Reference: "Test",                      // Optional
    Destinations: [                         // Fax Numbers
        { Recipient:"+6491111111" },
        { Recipient:"+6492222222" }
    ],
    Attachments: [
        "D:/File1.pdf"
    ]         
}).then(callback);

const TNZAPI = require('tnzapi');
const ContactModel = require('tnzapi/lib/Api/Addressbook/Contacts/models/ContactModel');
const GroupModel = require('tnzapi/lib/Api/Addressbook/Groups/models/GroupModel');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response:",JSON.stringify(data, null, "  "));
};

client.Messaging.Fax.SendMessage({
    MessageID: "ID12345",                         // MessageID - Leave blank to auto-generate
    Reference: "Test Fax - Advanced version",     // Reference

    Resolution: "High",                           // Resolution - High/Low
    CSID: "TEST FAX",                             // CSID

    RetryAttempts: 3,                             // RetryAttempts - no of retries
    RetryPeriod: 1,                               // RetryPeriod - no of minutes between retries

    Destinations: [
        {
            Recipient: "+6491231234",             // Fax number
            Company: "Test Company",              // Company Name
            Attention: "Test Recipient",          // Attention
            Custom1: "Custom1",                   // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Recipient: "+6471231234",             // Fax number
            Company: "Test Company 2",            // Company Name
            Attention: "Test Recipient",          // Attention
            Custom1: "Custom1",                   // Custom Field
            Custom2: "Custom2",
            Custom3: "Custom3",
            Custom4: "Custom4",
            Custom5: "Custom5"
        },
        {
            Group: new GroupModel({
                GroupID: "GGGGGGGG-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
            })
        },
        {
            GroupID: "GGGGGGGG-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        },
        {
            Contact: new ContactModel({
                ContactID: "CCCCCCCC-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            })
        },
        {
            ContactID: "CCCCCCCC-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        }
    ],

    Attachments: [
        "D:\\File1.pdf",
        "D:\\File2.pdf"
    ]
}).then(callback);

const TNZAPI = require('tnzapi');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response:",JSON.stringify(data, null, "  "));
};

client.Messaging.Voice.SendMessage({

    Destinations: [                         // Phone numbers to call
        { Recipient: "+6491111111" },
        { Recipient: "+6492222222" }
    ],

    // Message to play - WAV format, 16-bit, 8000hz recommended
    VoiceFiles: [
        {
            Name: "MessageToPeople",
            File: "D:/File1.wav"
        }
    ]

}).then(callback);

const TNZAPI = require('tnzapi');
const ContactModel = require('tnzapi/lib/Api/Addressbook/Contacts/models/ContactModel');
const GroupModel = require('tnzapi/lib/Api/Addressbook/Groups/models/GroupModel');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response:",JSON.stringify(data, null, "  "));
};

client.Messaging.Voice.SendMessage({

    MessageID: "ID12345",                             // MessageID - Leave blank to auto-generate
    Reference: "Test Voice - Advanced version",       // Reference

    CallerID: "+6499999999",                          // Caller ID
    BillingAccount: "TEST BILLING ACCOUNT",           // Billing Account (Sub Account)
    ReportTo: "report@example.com",                   // Email address to receive reports

    NumberOfOperators: 5,                             // No of Operators - Limits the maximum simultaneous calls
    RetryAttempts: 3,                                 // No of retries
    RetryPeriod: 1,                                   // Period between retries (minutes)

    // Message to play - WAV format, 16-bit, 8000hz recommended
    VoiceFiles: [
        {
            // Message to play when call answered - WAV format, 16-bit, 8000hz recommended
            Name: "MessageToPeople",
            File: "D:/message-to-people.wav"
        },
        {
            // Message to play when answerphone detected - WAV format, 16-bit, 8000hz recommended
            Name: "MessageToAnswerPhones",
            File: "D:/message-to-answerphones.wav"
        },
        {
            // Message to play when a keypad option is pressed - WAV format, 16-bit, 8000hz recommended
            Name: "CallRouteMessageToPeople",
            File: "D:/call-route-message-to-people.wav"
        },
        {
            // Message to play when a all centre representative answering the connected call - WAV format, 16-bit, 8000hz recommended
            Name: "CallRouteMessageToOperators",
            File: "D:/call-route-message-to-operators.wav"
        },
        {
            // Message to play when an unregistered keypad button is pressed - WAV format, 16-bit, 8000hz recommended
            Name: "CallRouteMessageOnWrongKey",
            File: "D:/call-route-message-on-wrong-key.wav"
        },
    ],

    // Adding Keypad options - WAV format, 16-bit, 8000hz recommended
    Keypads: [
        {
            Tone: 1,                                  // Keypad Tone
            RouteNumber: "+6491111111",               // Connect call to
            File: "D:/key1-play-message.wav"          // Message to play to caller
        },
        {
            Tone: 2,                                  // Keypad Tone
            RouteNumber: "+6492222222",               // Connect call to
        }
    ],

    Destinations: [                                   // Phone numbers to call
        { "Recipient": "+6491111111" },
        { "Recipient": "+6492222222" },
        {
            Group: new GroupModel({
                GroupID: "GGGGGGGG-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
            })
        },
        {
            GroupID: "GGGGGGGG-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        },
        {
            Contact: new ContactModel({
                ContactID: "CCCCCCCC-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            })
        },
        {
            ContactID: "CCCCCCCC-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        }
    ]


}).then(callback);

const TNZAPI = require('tnzapi');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response:",JSON.stringify(data, null, "  "));
}

client.Messaging.TTS.SendMessage({
    MessageToPeople: "Hi there!",               // Message to play
    Destinations: [                             // Recipients
        { Recipient: "+6491111111" },
        { Recipient: "+6492222222" }
    ]
}).then(callback);

const TNZAPI = require('tnzapi');
const ContactModel = require('tnzapi/lib/Api/Addressbook/Contacts/models/ContactModel');
const GroupModel = require('tnzapi/lib/Api/Addressbook/Groups/models/GroupModel');

const client = new TNZAPI({
    AuthToken: "[Your Auth Token]"          // Auth Token
});

var callback = function(data) {
  console.log("Response:",JSON.stringify(data, null, "  "));
};

client.Messaging.TTS.SendMessage({

    MessageID: "ID12345",                             // MessageID - Leave blank to auto-generate
    Reference: "Test TTS - Advanced version",         // Reference

    CallerID: "+6499999999",                          // Caller ID
    BillingAccount: "TEST BILLING ACCOUNT",           // Billing Account (Sub Account)
    ReportTo: "report@example.com",                   // Email address to receive reports

    NumberOfOperators: 10,                            // No of Operators - Limits the maximum simultaneous calls
    RetryAttempts: 3,                                 // No of retries
    RetryPeriod: 1,                                   // Period between retries (minutes)

    TTSVoiceType: "English-NewZealand@Female1",       // TTS Voice Engine

    // Message to play when call answered
    MessageToPeople: "Hello, this is a call from Department01. This is relevant information. Press one to be connected to our call centre.",

    // Message to play when answerphone detected (optional)
    MessageToAnswerPhones: "Hello, sorry we missed you. This is a call from Department 01. Please contact us on 0800 123123.",

    // Message to play when a keypad option is pressed (optional)
    CallRouteMessageToPeople: "Connecting you now.",

    // Message to play when a all centre representative answering the connected call
    CallRouteMessageToOperators: "Incoming Text To Speech call.",

    // Message to play when an unregistered keypad button is pressed
    CallRouteMessageOnWrongKey: "Sorry, you have pressed an invalid key. Please try again.",

    Keypads: [
      {
          Tone: 1,                                    // Keypad Tone
          RouteNumber: "+6491111111",                 // Connect call to
      },
      {
          Tone: 2,                                    // Keypad Tone
          Play: "You pressed 2",                      // Message to play to caller
          RouteNumber: "+6492222222",                 // Connect call to
      }
    ],

    Destinations: [
        {
            "Recipient": "+64211111111",              // Recipient Phone Number
            "Company": "Company 1",                   // Company
            "Attention": "Person 1",                  // Attention
            "Custom1": "Custom1",                     // Custom Field
            "Custom2": "Custom2", 
            "Custom3": "Custom3", 
            "Custom4": "Custom4"  
        },  
        { 
            "Recipient": "+64212222222",              // Recipient Phone Number
            "Company": "Company 2",                   // Company
            "Attention": "Person 2",                  // Attention
            "Custom1": "Custom1",                     // Custom Field
            "Custom2": "Custom2",
            "Custom3": "Custom3",
            "Custom4": "Custom4"
        },
        {
            Group: new GroupModel({
                GroupID: "GGGGGGGG-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
            })
        },
        {
            GroupID: "GGGGGGGG-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        },
        {
            Contact: new ContactModel({
                ContactID: "CCCCCCCC-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            })
        },
        {
            ContactID: "CCCCCCCC-BBBB-BBBB-BBBB-BBBBBBBBBBBB"
        }
    ]

}).then(callback);