Python Library Introduction

Using a single Python library, Python developers can send Email, SMS, Fax, Voice and Text-to-Speech messages using their own software.

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:

Login to the TNZ Dashboard
Navigate to 'Users'
Create a new user or select an existing one
Enable API access (if it's not already enabled)
Click on the 'API' tab
Enable 'Auth Token' and create a new Auth Token
Click the ' Copy' button to copy it to your clipboard
Paste the Auth Token into the Authorization Header in your application or code

At any time, you can refresh your Auth Token by clicking the button and exporting your new Auth Token. This action will invalidate any apps using your old Auth Token.

Auth Tokens can be used for multiple use-cases, with SubAccount and Department values helping in tracking reporting and billing.

API v2.04 utilizes JWT token Authentication. For OAuth2 authentication options, contact your TNZ representative.

Understanding the Python Library basics

Save hundreds of lines of code and hours of time by add the TNZ Python library into your project. Using one package 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 install the 'tnzapi' using pip: pip install tnzapi

TNZAPI Python Package

Alternatively you can download source code from GitHub

Reference the Library:

Reference the library in your code: from tnzapi import TNZAPI

Send Messages using the Library:

Using the [request].SendMessage() function, the package will connect to TNZ's REST API (in JSON 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 Library's [request].Poll() function.

See Status Reporting and Receive Messages.

Send Messages - build your application with the Python Library

Find instructions for each Message Type:

Sending Email - Send Email via TNZ Python Library

Python

Basic Advanced

Send Email (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = 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
    Recipients = [                          # Email Recipients
        "email.one@test.com",
        "email.two@test.com"
    ]
)

print(response)                                                Copy code

Send Email (Advanced):


from tnzapi import TNZAPI
from tnzapi.api.addressbook.contacts.dtos.contact_model import ContactModel
from tnzapi.api.addressbook.groups.dtos.group_model import GroupModel
from tnzapi.api.messaging.dtos.recipient_model import RecipientModel

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Messaging.Email.SendMessage(
    MessageID   = "ID12345",                    # Your custom MessageID
    Reference   = "Test Email - Advanced version",

    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",
    MessagePlain    = "Test Email Body",
    MessageHTML     = "This is Test message body. Thank you so much!",
    Recipients      = [
        "email.one@test.com",                   # Simple email address
        {
            "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"
        },
        {
            "GroupID": "4000000b-f002-4007-b00a-c00000000001"
        },
        {
            "ContactID": "6000000b-f002-4007-b00a-c00000000002"
        },
        RecipientModel(
            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"
        ),
        GroupModel (
            GroupID = "4000000b-f002-4007-b00a-d00000000003"
        ),
        ContactModel (
            ContactID = "6000000b-f002-4007-b00a-c00000000004"
        ),
        RecipientModel(
            ContactID = "6000000b-f002-4007-b00a-c00000000005"
        )
    ],
    Attachments = [
        "D:\\File1.pdf",                        # Add Attachment
        "D:\\File2.pdf"                         # Add Attachment
    ]
)

print(response)                                                Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
EmailSubject	Test Email	Sets the email subject
MessagePlain	Hello, This is a test message. Thank you.	Content used for the message/plain section of the email (overrides 'Template')
Recipients	john.doe@example.com	Email address to receive the message (for detailed formatting, see the Destinations parameter below)

Optional parameters

Parameter		Example Value	Description
MessageID		ID12345	A Message Identifier helps you keep track of each message (maximum 40 characters, alphanumeric). Use a unique MessageID for each request. If you leave this field blank, the API will generate a 36-character UUID (v4) for you and include it in the response body.
Reference		Test1	Human readable message description (free format field, maximum 80 characters).
SendTime		new DateTime()	Delay sending until the specified date/time (YYYY-MM-DD HH:mm in your local timezone, specified by your Sender setting or overridden using the TimeZone command)
Timezone		New Zealand	User's local timezone (see Setting Timezones)
SubAccount		SubAccount01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department		Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ChargeCode		BillingGroup01	Bespoke app cost allocation code (for invoice segmentation)
SMTPFrom		noreply@example.com	Sets the email Sender/Return-Path at the SMTP level (this address receives bounce-back emails and is used for SPF/DKIM type authentication; 'FromEmail' is used if not specified)
From		noreply	Sets the email sender's Friendly Name (seen by the email recipient)
FromEmail		noreply@example.com	Sets the email sender's Email Address (seen by the email recipient; API 'Sender' is used if not specified)
ReplyTo		reply@example.com	Sets the email sender's Reply-To Address (if the recipient replies, the Reply To will receive the reply)
MessageHTML		<html>Hello,<br /><br />This is a test message.<br /><br />Thank you.</html>	Content used for the message/html section of the email (overrides 'Template' and 'MessagePlain')
Recipients	> Recipient	john.doe@example.com	Recipient of the email
	> Attention	John Doe	Recipient's friendly name
	> Company	Example Corp	Recipient's company
	> Custom1		Customisable field
	> Custom2		Customisable field
Attachments	> Name	Sample.pdf	Attachment's filename
Attachments	> Data	%%Base-64%%	Base-64 encoded value of the attached file

Sending SMS - Send SMS/TXT via Python

Python

Basic Advanced

Send SMS (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Messaging.SMS.SendMessage(
    Reference = "Test",               # Optional
    MessageText = "Test SMS",         # SMS Message
    Recipients = [                    # Recipient
        "+6421111111",
        "+6422222222"
    ]
)

print(response)                                                Copy code

Send SMS (Advanced):


from tnzapi import TNZAPI
from tnzapi.api.addressbook.contacts.dtos.contact_model import ContactModel
from tnzapi.api.addressbook.groups.dtos.group_model import GroupModel
from tnzapi.api.messaging.dtos.recipient_model import RecipientModel

client = TNZAPI(
    AuthToken="[Your Auth Token]"                     # Auth Token
)

response = client.Messaging.SMS.SendMessage(
    MessageID   = "ID12345",                          # Your custom MessageID
    Reference   = "Test SMS - Advanced version",      # Reference
    SMSEmailReply = "reply@test.com",                 # Email address to receive reply back

    ForceGSMChars = True,                             #  Convert multi-byte characters into normalised GSM character 
    MessageText = "Test SMS Message for [[Attention]] at [[Company]]. Click [[File1]] | [[File2]] to download files.",

    Recipients      = [
        "+6421000001",                                # Mobile Number
        {
            "Recipient": "+6421000002",               # Recipient Mobile Number
            "Company": "Example Corp",                # Company Name
            "Attention": "John Doe",                  # Attention
            "First Name": "John",
            "Last Name": "Doe",
            "Custom1": "",
            "Custom2": ""
        },
        {
            "GroupID": "4000000b-f002-4007-b00a-c00000000001"
        },
        {
            "ContactID": "6000000b-f002-4007-b00a-c00000000002"
        },
        RecipientModel(
            Recipient = "+6421000003",                # 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"
        ),
        GroupModel (
            GroupID = "4000000b-f002-4007-b00a-c00000000003"
        ),
        ContactModel (
            ContactID = "6000000b-f002-4007-b00a-c00000000004"
        ),
        RecipientModel(
            ContactID = "6000000b-f002-4007-b00a-c00000000005"
        )
    ],
    Attachments = [
        "D:\\File1.pdf",
        "D:\\File2.pdf"
    ]
)

print(response)                                                Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageText	Hello, this is a test message from Department01. Thank you.	Plain or UTF-8 formatted SMS message
Recipients	+6421000002	Mobile number to receive the message (for detailed formatting, see the Destinations parameter below)

Optional parameters

Parameter		Example Value	Description
MessageID		ID12345	A Message Identifier helps you keep track of each message (maximum 40 characters, alphanumeric). Use a unique MessageID for each request. If you leave this field blank, the API will generate a 36-character UUID (v4) for you and include it in the response body.
Reference		Test1	Human readable message description (free format field, maximum 80 characters).
SendTime		new DateTime()	Delay sending until the specified date/time (YYYY-MM-DD HH:mm in your local timezone, specified by your Sender setting or overridden using the TimeZone command)
TimeZone		New Zealand	User's local timezone (see Setting Timezones)
SubAccount		SubAccount01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department		Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ChargeCode		BillingGroup01	Bespoke app cost allocation code (for invoice segmentation)
FromNumber		+6421000001	Setting SMS origination number, short code(s) will override in New Zealand - Not for New Zealand.
SMSEmailReply		person.one@domain.com	For email (SMTP) reply receipt notifications
ForceGSMChars		True	Convert multi-byte characters into normalised GSM character format. ie. © to (C)
Message		Hello, view the link at [[Link:https://www.example.com/path/to/page.html]] or view the file at [[File1]] or reply at [[REPLY]] or OptOut at [[STOP]]	An example Message that uses the URL Shortener, File Link, Reply Link and Unsubscribe functions
Recipients	> Recipient	+6421000001	Recipient of the SMS in E.164 internationalised format (for localized or friendly formatting, contact your account manager)
	> Attention	John Doe	Recipient's friendly name
	> Company	Example Corp	Recipient's company
	> Custom1		Customisable field
	> Custom2		Customisable field

Sending Faxes - Send Fax via Python

Python

Basic Advanced

Send Fax (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Messaging.Fax.SendMessage(
    Reference = "Test",               # Optional
    Attachments = ["C:\\File1.pdf"],  # Fax Documents
    Recipients = [                    # Fax Numbers
      "+6491111111",
      "+6492222222",
    ]
)
  
print(response)                                                Copy code

Send Fax (Advanced):


from tnzapi import TNZAPI
from tnzapi.api.addressbook.contacts.dtos.contact_model import ContactModel
from tnzapi.api.addressbook.groups.dtos.group_model import GroupModel
from tnzapi.api.messaging.dtos.recipient_model import RecipientModel

client = TNZAPI(
    AuthToken="[Your Auth Token]"                   # Auth Token
)

response = 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

    Recipients      = [
        "+6430000001",                              # Fax Number
        {
            "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"
        },
        {
            "GroupID": "4000000b-f002-4007-b00a-c00000000001"
        },
        {
            "ContactID": "6000000b-f002-4007-b00a-c00000000002"
        },
        RecipientModel(
            Recipient = "+6492342345",                # Fax number
            Company = "Test Company 2",               # Company Name
            Attention = "Test Recipient 2",           # Attention
            Custom1 = "Custom1",                      # Custom Field
            Custom2 = "Custom2",
            Custom3 = "Custom3",
            Custom4 = "Custom4",
            Custom5 = "Custom5"
        ),
        GroupModel (
            GroupID = "4000000b-f002-4007-b00a-c00000000003"
        ),
        ContactModel (
            ContactID = "6000000b-f002-4007-b00a-c00000000004"
        ),
        RecipientModel(
            ContactID = "6000000b-f002-4007-b00a-c00000000005"
        )
    ],
    Attachments = [
        "D:\\File1.pdf",                            # Add Fax Document 
        "D:\\File2.pdf"
    ]
)

print(response)                                                Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
Recipients		+6495005001	Fax number(s) to receive the message (for detailed formatting, see the Destinations parameter below)
Attachments	> Name	Sample.pdf	Fax document's filename
Attachments	> Data	%%Base-64%%	Base-64 encoded value of the document

Optional parameters

Parameter		Example Value	Description
MessageID		ID12345	A Message Identifier helps you keep track of each message (maximum 40 characters, alphanumeric). Use a unique MessageID for each request. If you leave this field blank, the API will generate a 36-character UUID (v4) for you and include it in the response body.
Reference		Test1	Human readable message description (free format field, maximum 80 characters).
SendTime		new DateTime()	Delay sending until the specified date/time (YYYY-MM-DD HH:mm in your local timezone, specified by your Sender setting or overridden using the TimeZone command)
Timezone		New Zealand	User's local timezone (see Setting Timezones)
SubAccount		SubAccount01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department		Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ChargeCode		BillingGroup01	Bespoke app cost allocation code (for invoice segmentation)
WatermarkFolder		Folder01	Directory/location of Watermark file to use
WatermarkFirstPage		Watermark File Name	Watermark file to apply to the first page only
WatermarkAllPages		Watermark File Name	Watermark file to apply to all pages
Resolution		High	Quality of the fax image. High for better quality, low for lower quality (faster delivery speed)
CSID		Station ID	Called Subscriber Identification - Maximum 30 characters
RetryAttempts		3	Number of retries (retry_period required)
RetryPeriod		1	Minutes between retries (retry_attempts required)
Recipients	> Recipient	+6495005000	Recipient of the Fax in E.164 internationalised format (for localized or friendly formatting, contact your account manager)
	> Attention	John Doe	Recipient's friendly name
	> Company	Example Corp	Recipient's company
	> Custom1		Customisable field
	> Custom2		Customisable field

Sending Voice (Voicemail) - Send VoiceCast via Python

C#

Basic Advanced

Send Voice (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"               # Auth Token
)

response = client.Messaging.Voice.SendMessage(
    MessageToPeople = "D:\\Temp\\input.wav",    # Voice file location on your server
    Recipients = [                              # Phone numbers to call
        "+6491111111",
        "+6492222222"
    ]
)

print(response)                                                Copy code

Send Voice (Advanced):


from tnzapi import TNZAPI
from tnzapi.api.addressbook.contacts.dtos.contact_model import ContactModel
from tnzapi.api.addressbook.groups.dtos.group_model import GroupModel
from tnzapi.api.messaging.dtos.recipient_model import RecipientModel
from tnzapi.core.messaging import Keypad

client = TNZAPI(
    AuthToken="[Your Auth Token]"                         # Auth Token
)

response = 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 = 10,                               # No of Operators - Limits the maximum simultaneous calls
    RetryAttempts = 3,                                    # No of retries
    RetryPeriod = 1,                                      # Period between retries (minutes)  
    
    MessageToPeople = "D:\\Temp\\input.wav",              # Message to play when call answered - WAV format, 16-bit, 8000hz recommended
    MessageToAnswerPhones = "D:\\Temp\\input.wav",        # Message to play when answerphone detected - WAV format, 16-bit, 8000hz recommended
    CallRouteMessageToPeople = "D:\\Temp\\input.wav",     # Message to play when a keypad option is pressed - WAV format, 16-bit, 8000hz recommended
    CallRouteMessageToOperators = "D:\\Temp\\input.wav",  # Message to play when a all centre representative answering the connected call - WAV format, 16-bit, 8000hz recommended
    CallRouteMessageOnWrongKey = "D:\\Temp\\input.wav",   # Message to play when an unregistered keypad button is pressed - WAV format, 16-bit, 8000hz recommended

    Keypads = [
        Keypad(
            Tone = 1,
            PlayFile = "D:\\Temp\\input.wav"              # Adding Keypad options - WAV format, 16-bit, 8000hz recommended
        ),
        Keypad(
            Tone=2,
            RouteNumber="+6492222222",
            PlayFile = "D:\\Temp\\input.wav"              # Adding Keypad options - WAV format, 16-bit, 8000hz recommended
        )
    ],
    
    Recipients = [
        "+64211111111",                                     # Phone Number
        {
            "Recipient": "+64212222222",                    # Phone Number
            "Company": "Company 1",
            "Attention": "Person 1",
            "Custom1": "Custom1",                           # Custom Field
            "Custom2": "Custom2",
            "Custom3": "Custom3",
            "Custom4": "Custom4"
        },
        {
            "GroupID": "4000000b-f002-4007-b00a-c00000000001"
        },
        {
            "ContactID": "6000000b-f002-4007-b00a-c00000000002"
        },
        RecipientModel(
            Recipient = "+642333333333",              # Phone number
            Company = "Test Company 2",               # Company Name
            Attention = "Test Recipient 2",           # Attention
            Custom1 = "Custom1",                      # Custom Field
            Custom2 = "Custom2",
            Custom3 = "Custom3",
            Custom4 = "Custom4",
            Custom5 = "Custom5"
        ),
        GroupModel (
            GroupID = "4000000b-f002-4007-b00a-c00000000003"
        ),
        ContactModel (
            ContactID = "6000000b-f002-4007-b00a-c00000000004"
        ),
        RecipientModel(
            ContactID = "6000000b-f002-4007-b00a-c00000000005"
        )
    ]
)

print(response)                                                Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageToPeople	[Base64encoded data]	The audio data played if the call is answered by a human (WAV format, 16-bit, 8000hz)
Recipient	+6495005001	Telephone number(s) to receive the message (for detailed formatting, see the Destinations parameter below)

Optional parameters

Parameter		Example Value	Description
MessageID		ID12345	A Message Identifier helps you keep track of each message (maximum 40 characters, alphanumeric). Use a unique MessageID for each request. If you leave this field blank, the API will generate a 36-character UUID (v4) for you and include it in the response body.
Reference		Test1	Human readable message description (free format field, maximum 80 characters).
SendTime		new DateTime()	Delay sending until the specified date/time (YYYY-MM-DD HH:mm in your local timezone, specified by your Sender setting or overridden using the TimeZone command)
Timezone		New Zealand	User's local timezone (see Setting Timezones)
BillingAccount		BillingAccount01	Used for reporting, billing and Web Dashboard segmentation (called SubAccount). See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department		Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ChargeCode		BillingGroup01	Bespoke app cost allocation code (for invoice segmentation)
ReportTo		report@example.com	For email (SMTP) message delivery report notifications.
MessageToAnswerphones		[Base64encoded data]	The audio data played when the call is answered by an answering machine/voicemail service (WAV format, 16-bit, 8000hz)
Keypads	> Tone	1	Keypad for call connection (supports buttons 1-9)
	> RouteNumber	+64800123123	Telephone number for call routing in dialling format
	> PlayFile	C:\Message.wav	Audio file played to B-Party when a keypad option is pressed (WAV format, 16-bit, 8000hz), eg "Thank you. You have pressed keypad 1."
CallRouteMessageToPeople		[Base64encoded data]	Audio data played when a keypad option is pressed (WAV format, 16-bit, 8000hz), eg "Connecting you now."
CallRouteMessageToOperators		[Base64encoded data]	Audio data played to the call centre representative answering the connected call (WAV format, 16-bit, 8000hz), eg "Incoming Text To Speech call."
CallRouteMessageOnWrongKey		[Base64encoded data]	Audio data played when an unregistered keypad button is pressed (WAV format, 16-bit, 8000hz), eg "Sorry, you have pressed an invalid key. Please try again"
NumberOfOperators		5	Limits the maximum simultaneous calls (where multiple 'Destinations' are listed)
RetryAttempts		3	Number of retry attempts if the recipients line is busy or unavailable
RetryPeriod		1	Minutes apart when performing retries
CallerID		+6495005000	Sets the Caller ID used on the call (must be E.164 format)
Options			Customisable field that allows advanced voice options including recording survey responses, recording phone numbers, playing IVR options, capturing DTMF tones for account numbers or credit card numbers, etc.
Recipients	> Recipient	+6495005000	Recipient of the call in E.164 internationalised format (for localized or friendly formatting, contact your account manager)
	> Custom1		Customisable field
	> Custom2		Customisable field
	> Custom3		Customisable field
	> Custom4		Customisable field

Sending Voice Text To Speech - Send TTS Calls via Python

Python

Basic Advanced

Send TextToSpeech (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Messaging.TTS.SendMessage(
    MessageToPeople = "Hi there!",    # Message to play
    Recipients = [                    # Phone numbers to call
      "+6491111111",
      "+6492222222"
    ]
)

print(response)                                                Copy code

Send TextToSpeech (Advanced):

from tnzapi import TNZAPI client = TNZAPI( AuthToken="[Your Auth Token]" # Auth Token ) response = 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", MessageToPeople = "Hello, this is a call from Department01. This is relevant information. Press one to be connected to our call centre.", MessageToAnswerPhones = "Hello, sorry we missed you. This is a call from Department 01. Please contact us on 0800 123123.", CallRouteMessageToPeople = "Connecting you now.", CallRouteMessageToOperators = "Incoming Text To Speech call.", CallRouteMessageOnWrongKey = "Sorry, you have pressed an invalid key. Please try again.", Keypads = [ Keypad( Tone = 1, RouteNumber="+6491111111" ), Keypad( Tone=2, RouteNumber="+6492222222", Play="You pressed 1" ) ], Recipients = [ "+64211111111", # Phone Number { "Recipient": "+64212222222", # Phone Number "Company": "Company 1", "Attention": "Person 1", "Custom1": "Custom1", # Custom Field "Custom2": "Custom2", "Custom3": "Custom3", "Custom4": "Custom4" }, { "GroupID": "4000000b-f002-4007-b00a-c00000000001" }, { "ContactID": "6000000b-f002-4007-b00a-c00000000002" }, RecipientModel( Recipient = "+642333333333", # Phone number Company = "Test Company 2", # Company Name Attention = "Test Recipient 2", # Attention Custom1 = "Custom1", # Custom Field Custom2 = "Custom2", Custom3 = "Custom3", Custom4 = "Custom4", Custom5 = "Custom5" ), GroupModel ( GroupID = "4000000b-f002-4007-b00a-c00000000003" ), ContactModel ( ContactID = "6000000b-f002-4007-b00a-c00000000004" ), RecipientModel( ContactID = "6000000b-f002-4007-b00a-c00000000005" ) ] ) print(response)

Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageToPeople	Hello, this is a call from Department01. This is relevant information. Press one to be connected to our call centre.	The text-to-speech message played if the call is answered by a human (may optionally include SSML commands)
Destinations	+6495005001	Telephone number(s) to receive the message (for detailed formatting, see the Destinations parameter below)

Optional parameters

Parameter		Example Value	Description
MessageID		ID12345	A Message Identifier helps you keep track of each message (maximum 40 characters, alphanumeric). Use a unique MessageID for each request. If you leave this field blank, the API will generate a 36-character UUID (v4) for you and include it in the response body.
Reference		Test1	Human readable message description (free format field, maximum 80 characters).
SendTime		new DateTime()	Delay sending until the specified date/time (YYYY-MM-DD HH:mm in your local timezone, specified by your Sender setting or overridden using the TimeZone command)
Timezone		New Zealand	User's local timezone (see Setting Timezones)
SubAccount		SubAccount01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department		Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ChargeCode		BillingGroup01	Bespoke app cost allocation code (for invoice segmentation)
ReportTo		report@example.com	For email (SMTP) message delivery report notifications.
MessageToAnswerphones			Hello, sorry we missed you. This is a call from Department 01. Please contact us on 0800 123123.	The text-to-speech message played when the call is answered by an answering machine/voicemail service (may optionally include SSML commands)
Keypads	> Tone	1	Keypad for call connection (supports buttons 1-9)
	> RouteNumber	+64800123123	Telephone number for call routing in dialling format
	> Play	You pressed Keypad 1	Message played to B-Party when a keypad option is pressed
CallRouteMessageToPeople		Connecting you now.	Text-to-speech message played when a keypad option is pressed
CallRouteMessageToOperators		Incoming Text To Speech call.	Text-to-speech message played to the call centre representative answering the connected call
CallRouteMessageOnWrongKey		Sorry, you have pressed an invalid key. Please try again.	Text-to-speech message played when an unregistered keypad button is pressed
NumberOfOperators		5	Limits the maximum simultaneous calls (where multiple 'Recipients' are listed)
RetryAttempts		3	Number of retry attempts if the recipients line is busy or unavailable
RetryPeriod		1	Minutes apart when performing retries
CallerID		6495005000	Sets the Caller ID used on the call (must be E.164 format)
TTSVoiceType		Female1	Text-to-Speech voice to use (Male1, Female1, Nicole, Russell, Amy, Brian, Emma)
Options			Customisable field that allows advanced voice options including recording survey responses, recording phone numbers, playing IVR options, capturing DTMF tones for account numbers or credit card numbers, etc.
Recipients	> Recipient	+6495005000	Recipient of the call in E.164 internationalised format (for localized or friendly formatting, contact your account manager)
	> Attention	John Doe	Recipient's friendly name
	> Company	Example Corp	Recipient's company
	> Custom1		Customisable field
	> Custom2		Customisable field

Sending messages in test mode

Under request 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.


# Test mode
request.SendMode = "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.

Retry Sending - Resubmit a failed message

If your message is 'Failed' (sending completed and was unsuccessful), you can use this API module to retry sending.

The Retry is applied to a specific MessageID. If you use common MessageID values across multiple messages, it will apply to the most recent message and only if the Status was Failed.

Python

Set Resubmit:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Resubmit.SendRequest(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
)

print(response)
                                          Copy code

Set Resubmit:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Resubmit.SendRequest(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
    SendTime="2023-08-10 09:00"       # Date/Time to resend
)

print(response)
                                          Copy code

ResubmitRequest Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID		ID123456	MessageID the Action should apply to

ResubmitRequestResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
Status	Transmit	Current Status of your message
JobNum	ABCD1234	Your Job Number
Action	Resubmit	What action (Resubmit) was requested
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Reschedule Sending - Adjust the Delayed Sending Date/Time

If you have an existing Delayed message (scheduled for sending at a future date/time), you can use this API module to adjust the sending date/time.

The adjustment is applied to a specific MessageID. If you use common MessageID values across multiple messages, it will apply to the most recent message.

Python

Set Reschedule:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Reschedule.SendRequest(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
    SendTime="2023-08-12 12:00:00"    # New Date/Time
)

print(response)
                                          Copy code

Set Reschedule:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Reschedule.SendRequest(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
    SendTime="2023-08-12 12:00:00"    # New Date/Time
)

print(response)
                                          Copy code

RescheduleRequest Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID	ID123456	MessageID the Action should apply to
SendTime	2020-05-12 14:05:00	Reschedule sending for the specified date/time (YYYY-MM-DD HH:mm in your Account/Sender's default timezone setting)

RescheduleRequestResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
Status	Delayed	Current Status of your message
JobNum	ABCD1234	Your Job Number
Action	Reschedule	What action (Reschedule) was requested
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Abort Sending - Cancel/Delete a Message from the Queue

If you have an existing Delayed message (scheduled for sending at a future date/time) you can use this API module to Cancel sending of the message.

The cancellation is applied to a specific MessageID. If you use common MessageID values across multiple messages, it will apply to the most recent message.

Python

Set Abort:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Abort.SendRequest(
    MessageID="ID123456",             # MessageID generated from system OR your message ID if specified
)

print(response)                                          Copy code

Set Abort:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Abort.SendRequest(
    MessageID="ID123456",             # MessageID generated from system OR your message ID if specified
)

print(response)                                          Copy code

AbortRequest Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID		ID123456	MessageID the Action should apply to

AbortRequestResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
Status	Pending	Current Status of your message
JobNum	ABCD1234	Your Job Number
Action	Abort	What action (Abort) was requested
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Adjust NumberOfOperators - Change the Voice/Text-to-Speech NumberOfOperators Value

When sending a Voice/Text-to-Speech message, you may specify the NumberOfOperators value (limits the quantity of simultaneous/concurrent calls). You can use this API module to adjust the NumberOfOperators value in real-time.

The cancellation is applied to a specific MessageID. If you use common MessageID values across multiple messages, it will apply to the most recent message.

Python

Change NumberOfOperators:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

request = client.Set.Pacing(
    MessageID="ID123456",             # MessageID generated from system OR your message ID if specified
    NumberOfOperators=1               # No of operators
)

response = request.SendRequest()      # Abort Job

print(repr(response))                                          Copy code

Change NumberOfOperators:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Actions.Pacing.SendRequest(
    MessageID="ID123456",             # MessageID generated from system OR your message ID if specified
    NumberOfOperators=1               # No of operators
)

print(response)                                          Copy code

PacingRequest Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID	ID123456	MessageID the Action should apply to
NumberOfOperators	4	NumberOfOperators value to apply

PacingRequestResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
Status	Pending	Current Status of your message
JobNum	ABCD1234	Your Job Number
Action	Pacing	What action (Pacing) was requested
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

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

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

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:

Parameter	Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
Type	SMS	Type of Message ('Email', 'SMS', 'Fax', 'Voice' or 'TextToSpeech')
Destination	+6421000001	Destination that the webhook is for (alphanumeric field, where telephone/mobile numbers are supplied in E.164 internationalised format)
MessageID	js82hn8n	MessageID parameter supplied when sending your original API call
SubAccount	SubAccount01	Used for reporting, billing and Web Dashboard segmentation
Department	Department01	Used for reporting, billing and Web Dashboard segmentation
JobNumber	10C7B9A0	Eight digit alphanumeric tracking number (our internal Job Number)
SentTime	16/10/2018 13:43 p.m.	Time message was completed (Sender's local time time in 'YYYY-MM-DD HH:mm tt' format)
Status	SUCCESS	For submission results, values are SUCCESS, FAILED, PENDING For reply reports, this will be RECEIVED For additional analytics, this will be UPDATED
Result	Sent OK	Final delivery result and/or the cause for a message delivery failure For a list of possible values, see SMS, Fax, Voice, TextToSpeech Email result codes are defined by the receiving email server For reply reports, this will be RECEIVED For additional analytics, this will be the event description
Message		Field will be blank; it is used by the Receive Messages webhook only
Price	0.20	Your cost for this transaction, charged by us to you
Detail	SMSParts:2	Additional billing detail: "SMSParts", "FaxPages", "VoiceMinutes", "Size", "Prompts"
URL	https://www.example.com/webhook	The URL this webhook is sent to
RESPONSEMODE	JSON	This webhook's format

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

Python

Get Status:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.Status.Poll(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
)

print(response)
                                          Copy code

Get Status:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.Status.Poll(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
)

print(response)                                          Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID		ID123456	Your provided Message ID or TNZ Group generated Message ID

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:

Parameter	Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
Type	SMSReply	Type of Message ('Email', 'SMS', 'Fax', 'Voice', 'TextToSpeech', 'SMSInbound' or 'SMSReply')
Destination	+6421000001	Mobile number sending the SMS message (alphanumeric field, where telephone/mobile numbers are supplied in E.164 internationalised format)
MessageID	js82hn8n	MessageID parameter supplied when sending your original API call
SubAccount	SubAccount01	Used for reporting, billing and Web Dashboard segmentation
Department	Department01	Used for reporting, billing and Web Dashboard segmentation
JobNumber	10C7B9A0	Eight digit alphanumeric tracking number (our internal Job Number)
SentTime	16/10/2018 13:43 p.m.	Time reply message was received
Status	RECEIVED	For submission results, values are SUCCESS, FAILED, PENDING For reply reports, this will be RECEIVED For additional analytics, this will be UPDATED
Result	RECEIVED	Final delivery result and/or the cause for a message delivery failure For reply reports, this will be RECEIVED For additional analytics, this will be the event description
Message	This is a reply.	The received SMS message (if 'Type=SMSInbound' or 'Type=SMSReply')
Price	0.20	Your cost for the outbound message sent, charged by us to you (no cost for the reply received)
Detail	SMSParts:2	Additional billing detail: "SMSParts", "FaxPages", "VoiceMinutes", "Size", "Prompts" on the outbound message sent (not the SMS Received)
URL	https://www.example.com/webhook	The URL this webhook is sent to
RESPONSEMODE	JSON	This webhook's format

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

Python

Basic Advanced

Get SMS Received:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.SMSReceived.Poll(
    TimePeriod = 1440                 # Return results from the last x minutes
)

print(response)
                                          Copy code

Get SMS Received:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.SMSReceived.Poll(
    DateFrom = "2024-08-01 00:00:00", # Return results from the date/time
    DateTo = "2024-08-31 23:59:59",   # Return results to the date/time
    RecordsPerPage = 10,              # x numbers of records to return per request
    Page = 1                          # current location
)

print(response)
                                          Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
TimePeriod	1440	Return results from the last x minutes
DateFrom	2022-08-01T00:00:00	Return results from the specified date (optional)
DateTo	2022-08-01T23:59:59	Return results to the specified date (optional)
RecordsPerPage	20	Return x number of records per request (optional)
Page	1	Current location of the result set (optional)

SMSReceivedResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
ReceivedMessages	SMSReceivedMessage	List of SMS messages received
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

SMSReceivedMessage object parameters

Parameter	Example Value	Description
Date	2019-12-01 14:02:03	Date/Time SMS was received (yyyy-mm-dd HH:mm:ss)
From	+6421000001	Sender of the SMS in E.164 internationalised format
MessageText	This is a reply back from the mobile phone.	The SMS message received

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

Python

Get SMS Reply:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.SMSReply.Poll(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
)

print(response)
                                          Copy code

Get SMS Reply:


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Reports.SMSReply.Poll(
    MessageID="ID123456"              # MessageID generated from system OR your message ID if specified
)

print(response)
                                          Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
MessageID		ID123456	Your provided Message ID or TNZ Group generated Message ID

SMSReceivedResult object parameters

Parameter	Example Value	Description
Result	Success	Result of your API call (not the result of the message)
Status	Received	Status of your job
MessageID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Your provided Message ID or TNZ Group generated Message ID
JobNum	10AB20CE	Eight digit alphanumeric tracking number (our internal Job Number)
Account	102030	Your TNZ Account
SubAccount		Your supplied TNZ SubAccount
Department		Your supplied TNZ Department
SentMessage	SMSSentMessage Object	Details of your sent message
ReceivedMessages	SMSReceivedMessage Objects	Details of your received message(s)
ErrorMessage	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

SMSSentMessage object parameters

Parameter	Example Value	Description
Date	2019-12-01 14:02:03	Date/Time SMS was received (yyyy-mm-dd HH:mm:ss)
Destination	6421000001	Recipient of the SMS in E.164 internationalised format
MessageText	This is an outbound message sent via API.	Plain or UTF-8 formatted SMS message sent

SMSReceivedMessage object parameters

Parameter	Example Value	Description
Date	2019-12-01 14:02:03	Date/Time SMS was received (yyyy-mm-dd HH:mm:ss)
From	+6421000001	Sender of the SMS in E.164 internationalised format
MessageText	This is a reply back from the mobile phone.	The SMS message received

List Contact - List Contact via TNZ Python Library

Python

Basic Advanced

List Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.List(
    Page=1
)

print(response)            Copy code

List Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.List(
    RecordsPerPage=10,
    Page= 1
)

print(response)            Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token

Optional parameters

Parameter		Example Value	Description
RecordsPerPage		50	Specifies the number of records per page to be returned. If not provided, the default number (100) of records per page will be used.
Page		1	Specifies the page number of the contact list to retrieve. If not provided, the default (1) behaviour will be followed.

ContactListApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
TotalRecords	int	3	Total number of contacts
RecordsPerPage	int	100	Return x number of records per request (optional)
PageCount	int	1	Maximum number of pages
Page	int	1	Current location of the result set (optional)
Contacts	list[ContactModel]	ContactModel	List of contacts
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Get Contact Detail - Get Contact Detail via TNZ Python Library

Python

Basic Advanced

Get Contact Detail (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Detail(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

Get Contact Detail (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Detail(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to retrieve.

ContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

ContactModel object properties

Property	Type	Example Value	Description
ID	str	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Unique identifier for the contact
Owner	str	COM\EXAMPLE\TEST	Your UserKey
Created	datetime	2023-12-01T12:00:00	Creation date for this contact in your local date/time
CreatedUTC	datetime	2023-12-01T00:00:00	Creation date for this contact in UTC date/time
Updated	datetime	2023-12-01T12:00:00	Last updated date for this contact in your local date/time
UpdatedUTC	datetime	2023-12-01T00:00:00	Last updated date for this contact in UTC date/time
Timezone	str	New Zealand	Timezone associated with Created/Updated date/time
Attention	str	Person Attention	Indicates the attention or focus associated with the contact.
Title	str	Ms	Represents the title or honorific of the contact (e.g., Mr, Mrs, Ms).
Company	str	TNZ Group LTD.	Specifies the company or organization associated with the contact.
CompanyDepartment	str	Sales Dept.	Indicates the department or division within the company associated with the contact.
FirstName	str	Person first name	Represents the first name of the contact.
LastName	str	Person last name	Represents the last name of the contact.
Position	str	Sales Represent	Specifies the job position or role of the contact.
StreetAddress	str	Sales Represent	Represents the street address or location of the contact.
Suburb	str	My Suburb	Specifies the suburb or district associated with the contact's address.
City	str	Auckland	Indicates the city or locality associated with the contact's address.
State	str	AKL	Represents the state or province associated with the contact's address.
Country	str	New Zealand	Specifies the country associated with the contact's address.
Postcode	str	1234	Represents the postal code or ZIP code associated with the contact's address.
MainPhone	str	092223333	Specifies the main phone number of the contact. This property typically used for Voice & Text-To-Speech messages.
AltPhone1	str	093334444	Represents an alternate phone number for the contact. This property typically used for Voice & Text-To-Speech messages.
AltPhone2	str	094445555	Represents a second alternate phone number for the contact. This property typically used for Voice & Text-To-Speech messages.
DirectPhone	str	094445555	Indicates the direct phone number of the contact.
MobilePhone	str	0211144489	Represents the mobile phone number of the contact. This property typically used for SMS messages.
FaxNumber	str	093334444	Specifies the fax number associated with the contact.
EmailAddress	str	person1@example.com	Represents the email address of the contact.
WebAddress	str	https://www.tnz.co.nz	Specifies the website address or URL associated with the contact.
Custom1...4	str	Custom Value	Represents custom fields or additional information associated with the contact.
ViewBy	str	Account	Specifies the visibility of the contact. Values can be "Account", "SubAccount", "Department" or "No" visibility option.
EditBy	str	Account	Specifies the permission level required to edit the contact. Values can be "Account", "SubAccount", "Department" or "No" permission option.

Create Contact - Create Contact via TNZ Python Library

Python

Basic Advanced

Create Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Create(
    Attention="Test Person",
    FirstName="First",
    LastName="Last",
    MobilePhone="+6421000001",
)

print(response)            Copy code

Create Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Create(
    Title="Mr",
    Company="TNZ Group",
    FirstName="First",
    LastName="Last",
    MobilePhone="+6421000001",
    ViewPublic="Account",
    EditPublic="Account"
)

print(response)            Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token

ContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Update Contact - Update Contact via TNZ Python Library

Python

Basic Advanced

Update Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Update(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    Attention="Test Attention"
)

print(response)            Copy code

Update Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Update(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    Attention="Test Attention"
    Title="Mr",
    Company="TNZ Group",
    FirstName="First",
    LastName="Last",
    MobilePhone="+64213334444",
    ViewPublic="Account",
    EditPublid="Account"
)

print(response)            Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID		AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to update.

ContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Delete Contact - Delete Contact via TNZ Python Library

Python

Basic Advanced

Delete Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Delete(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

Delete Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Contact.Delete(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID		AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to delete.

ContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

List Contact Group - List Contact Group via TNZ Python Library

Python

Basic Advanced

List Contact Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.List(
    Page=1,
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

List Contact Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.List(
    RecordsPerPage=10,
    Page=1,
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to retrieve. (required)

ContactGroupListApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
TotalRecords	int	3	Total number of groups associated with this contact
RecordsPerPage	int	100	Return x number of records per request (optional)
PageCount	int	1	Maximum number of pages
Page	int	1	Current location of the result set (optional)
Contact	ContactModel	ContactModel object	Contact detail
Groups	list[GroupModel]	GroupModel list	List of groups associated with this contact
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Get Contact Group Detail - Get Contact Group Detail via TNZ Python Library

Python

Basic Advanced

Get Contact Group Detail (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Detail(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupCode="Test_Group"
)

print(response)            Copy code

Get Contact Group Detail (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Detail(
    ContactID="AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupCode="Test_Group"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to retrieve. (required)
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to retrieve. (required)

ContactGroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
Contact	ContactModel	ContactModel object	Contact detail
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Create Contact Group - Create Contact Group via TNZ Python Library

Python

Basic Advanced

Create Contact Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Create(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Create Contact Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Create(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to create. (required)
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to create. (required)

ContactGroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Contact	ContactModel	ContactModel object	Contact detail
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Delete Contact Group - Delete Contact Group via TNZ Python Library

Python

Basic Advanced

Delete Contact Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Delete(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Delete Contact Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Delete(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to delete. (required)
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to delete. (required)

ContactGroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Contact	ContactModel	ContactModel object	Contact detail
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

List Group - List Group via TNZ Python Library

Python

Basic Advanced

List Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.List(
    Page=1
)

print(response)            Copy code

List Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.List(
    RecordsPerPage=10,
    Page=1
)

print(response)            Copy code

Required parameters

Parameter		Example Value	Description
AuthToken		eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token

Optional parameters

Parameter		Example Value	Description
RecordsPerPage		50	Specifies the number of records per page to be returned. If not provided, the default number (100) of records per page will be used.
Page		1	Specifies the page number of the contact list to retrieve. If not provided, the default (1) behaviour will be followed.

GroupListApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call (not the result of the message)
TotalRecords	int	3	Total number of records
RecordsPerPage	int	100	Return x number of records per request (optional)
PageCount	int	1	Maximum number of pages
Page	int	1	Current location of the result set (optional)
Groups	list[GroupModel]	GroupModel	List of group
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Group Detail - Group Detail via TNZ Python Library

Python

Basic Advanced

Group Detail (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Detail(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Group Detail (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Detail(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to retrieve. (required)

GroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

GroupModel object properties

Property	Type	Example Value	Description
GroupID	str	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Unique identifier for the group (required)
GroupName	str	Test Group	Represents the name of the group.
SubAccount	str	SubAccount01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
Department	str	Department01	Used for reporting, billing and Web Dashboard segmentation. See the TNZ API Structure guide's Cost Tracking & Rebilling section.
ViewEditBy	str	Account	Specifies the permission level required to view/edit the group. Values can be "Account", "SubAccount", "Department" or "No" permission option.
Owner	str	COM\EXAMPLE\TEST	Your UserKey

Create Group - Create Group via TNZ Python Library

Python

Basic Advanced

Create Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Create(
    GroupCode="Test-Group",
    GroupName="Test Group"
)

print(response)            Copy code

Create Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Create(
    GroupCode="Test-Group",
    GroupName="Test Group"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to create. (required)

GroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Update Group - Update Group via TNZ Python Library

Python

Basic Advanced

Update Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Update(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    GroupCode = "Test_Group",
    GroupName = "Test Group 123"
)

print(response)            Copy code

Update Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Update(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    GroupCode = "Test_Group",
    GroupName = "Test Group 123"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to update. (required)

GroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Delete Group - Delete Group via TNZ Python Library

Python

Basic Advanced

Delete Group (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Delete(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
)

print(response)            Copy code

Delete Group (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.Group.Delete(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to delete. (required)

GroupApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

List Group Contact - List Group Contact via TNZ Python Library

Python

Basic Advanced

List Group Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.List(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    Page = 1
)

print(response)            Copy code

List Group Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.List(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    RecordsPerPage = 10,
    Page = 1
)

print(response)
            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to retrieve. (required)

GroupContactListApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
TotalRecords	int	3	Total number of groups associated with this contact
RecordsPerPage	int	100	Return x number of records per request (optional)
PageCount	int	1	Maximum number of pages
Page	int	1	Current location of the result set (optional)
Group	GroupModel	GroupModel object	Group detail
Contacts	list[ContactModel]	ContactModel list	List of contacts associated with this group
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Get Group Contact Detail - Get Group Contact Detail via TNZ Python Library

Python

Basic Advanced

Get Group Contact Detail (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Create(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Get Group Contact Detail (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.ContactGroup.Create(
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD",
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF"
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to retrieve. (required)
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to retrieve. (required)

GroupContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Create Group Contact - Create Group Contact via TNZ Python Library

Python

Basic Advanced

Create Group Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.Create(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"      # Required
)

print(response)            Copy code

Create Group Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.Create(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"      # Required
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to create. (required)
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to create. (required)

GroupContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Delete Group Contact - Delete Group Contact via TNZ Python Library

Python

Basic Advanced

Delete Group Contact (Basic):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.Delete(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"      # Required
)

print(response)            Copy code

Delete Group Contact (Advanced):


from tnzapi import TNZAPI

client = TNZAPI(
    AuthToken="[Your Auth Token]"     # Auth Token
)

response = client.Addressbook.GroupContact.Delete(
    GroupID = "BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF",       # Required
    ContactID = "AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD"      # Required
)

print(response)            Copy code

Required parameters

Parameter	Example Value	Description
AuthToken	eyJhbGciOiJI...adQssw5c	Auth Token value set up in Create a new API Auth token
GroupID	BBBBBBBB-CCCC-DDDD-EEEE-FFFFFFFFFFFF	Specifies the unique identifier of the group to delete. (required)
ContactID	AAAAAAAA-BBBB-BBBB-CCCC-DDDDDDDDDDDD	Specifies the unique identifier of the contact to delete. (required)

GroupContactApiResultDTO object properties

Property	Type	Example Value	Description
Result	str	Success	Result of your API call
Group	GroupModel	GroupModel object	Group detail
Contact	ContactModel	ContactModel object	Contact detail
ErrorMessage	list[str]	Missing Sender	Reason for the API call failure (see a list of possible values: TNZ API Errors)

Versioning

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

Frequently Asked Questions

Can messages be sent internationally?

Yes, full international delivery is supported.

Is there a maximum request size?

The maximum request size supported is 20MB. This is our server side limitation. Your client side limitation may be smaller.

How many Destinations can I specify in one request?

There is no limit to the number of Destinations (in either format), provided you do not breach the maximum request size.

How many Files can I specify in one request?

There is a limit of 10 files specified in a single request. There is no file size limitation, provided you do not breach the maximum request size.

Do you support SPF, DKIM, DMARC, etc, for MessageType=Email?

Yes, we support email security measures. Contact us for further information on setting up your own security measures for whitelabeled messages delivered with the API.

What filetypes are supported for MessageType=Fax?

You can send a wide range of file types, including Microsoft Office® documents (doc, docx, ppt, pptx, xls, xlsx, etc), Openoffice/Libreoffice documents (odt, ods, etc), Adobe® documents (pdf, etc), image file types (jpg, gif, tif, bmp, etc) and more (txt, html, etc).

When I send MessageType=SMS messages, the text is cut off at 160 characters. Why?

SMS messages are sent and charged in blocks of characters. One text message is 160 characters. By default, we will limit your message to three-message-parts in length (459 characters using the GSM character set, or 210 characters using Unicode/UCS-2). This can be increased on request. See the SMS Message Parts and Concatenated SMS guide for further information.

In addition to the Delivery Report methods listed above, am I able to receive a daily or monthly summary?

Yes, we can provide a daily or monthly email report (as an attached CSV file) containing data on messages sent. This can be used for billing (contains costs) or for reporting (doesn’t contain costs).

Is HTTPS, SSL, or TLS supported?

Yes, encrypted submissions are accepted via HTTPS. SSL/TLS is also supported for outbound email messages provided the receiving email server supports this.

Can I set the Caller ID on SMS, Fax, Voice and TextToSpeech messages?

Some networks support customised SMS Caller IDs. This can be configured using your Web Dashboard.
Your Fax Caller ID can be configured using your Web Dashboard.
Your Voice and TextToSpeech Caller ID is specified on a per-message basis using the 'CallerID' parameter.

Select your API Flavour:

Python Library Introduction

Register your account

Create an API user

Understanding the Python Library basics

Download the Library:

Reference the Library:

Send Messages using the Library:

Capture Status & Replies using the Library:

Send Messages - build your application with the Python Library

Sending Email - Send Email via TNZ Python Library

Send Email (Basic):

Send Email (Advanced):

Required parameters

Optional parameters

Sending SMS - Send SMS/TXT via Python

Send SMS (Basic):

Send SMS (Advanced):

Required parameters

Optional parameters

Sending Faxes - Send Fax via Python

Send Fax (Basic):

Send Fax (Advanced):

Required parameters

Optional parameters

Sending Voice (Voicemail) - Send VoiceCast via Python

Send Voice (Basic):

Send Voice (Advanced):

Required parameters

Optional parameters

Sending Voice Text To Speech - Send TTS Calls via Python

Send TextToSpeech (Basic):

Send TextToSpeech (Advanced):

Required parameters

Optional parameters

Sending messages in test mode

Edit Messages - Edit a submitted message

Retry Sending - Resubmit a failed message

Set Resubmit:

Set Resubmit:

ResubmitRequest Required parameters

ResubmitRequestResult object parameters

Reschedule Sending - Adjust the Delayed Sending Date/Time

Set Reschedule:

Set Reschedule:

RescheduleRequest Required parameters

RescheduleRequestResult object parameters

Abort Sending - Cancel/Delete a Message from the Queue

Set Abort:

Set Abort:

AbortRequest Required parameters

AbortRequestResult object parameters

Adjust NumberOfOperators - Change the Voice/Text-to-Speech NumberOfOperators Value

Change NumberOfOperators:

Change NumberOfOperators:

PacingRequest Required parameters

PacingRequestResult object parameters

Status Reporting - Reporting and event tracking

Web Dashboard - Tracking message statuses via the online dashboard

SMTP Email - Receive message statuses via email

Webhook - Message statuses delivered via a webhook

GET Status Poll - Track message statuses using a GET poll

Get Status:

Get Status:

Required parameters

Receive Messages - Track messages received

Web Dashboard - Tracking messages received via the online dashboard

SMTP Email - Track messages received via email

Webhook - Messages received data delivered via a webhook

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

Get SMS Received:

Get SMS Received:

Required parameters

SMSReceivedResult object parameters

SMSReceivedMessage object parameters

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

Get SMS Reply:

Get SMS Reply:

Required parameters

SMSReceivedResult object parameters