The below table will be updated with changes to the TNZ REST API.
| Version | Section | Field | Description of Changes | |
|---|---|---|---|---|
Version 2.04: | ||||
| 2.04 | Send Messages | ContactID | Added [Destinations][ContactID] to support sending to Address Book Contacts | |
| 2.04 | Send Messages | GroupID | Added [Destinations][GroupID] to support sending to Address Book Groups | |
| 2.04 | Send Messages | GroupCode | Added [Destinations][GroupCode] to support sending to Address Book Groups | |
| 2.04 | Send Messages | Send Voice & Text-to-Speech | AnswerPhoneMode | Added AnswerPhoneMode function for control over Answer Phone rules | |
| 2.04 | Send Messages | Send Voice & Text-to-Speech | KeypadOptionRequired | Removed KeypadOptionRequired beta status | |
| 2.04 | Send Messages | Send Voice & Text-to-Speech | RetryAttempts | Improved RetryAttempts to support '0' as a valid value | |
| 2.04 | Status Reporting & Receive Messages | Webhook | Version | Added API Version to the webhook for simpler version management | |
| 2.04 | Status Reporting & Receive Messages | Webhook | RESPONSEMODE | Removed Response Mode from the webhook | |
| 2.04 | Status Reporting & Receive Messages | Webhook | ContactID | Added ContactID value to the webhook which displays the Address Book Contact ID (if available) | |
| 2.04 | Status Reporting & Receive Messages | Webhook & GET Poll | ReceivedID | Added ReceivedID value to the webhook and polls which displays a unique Received ID for Inbound and Reply SMS messages (if available) | |
| 2.04 | Status Reporting & Receive Messages | Webhook & GET Poll | SentTimeLocal | Renamed SentTime to SentTimeLocal, displaying the time in the user's local timezone in ISO 8601 date format (2023-02-01 23:04:39) | |
| 2.04 | Status Reporting & Receive Messages | Webhook & GET Poll | SentTimeUTC | Added SentTimeUTC to display the time in UTC in ISO 8601 date format (2023-02-01 23:04:39) | |
| 2.04 | Status Reporting & Receive Messages | Webhook & GET Poll | SentTimeUTC_RFC3339 | Added SentTimeUTC-RFC3339 to display the time in UTC in RFC 3339 format (2024-02-01T02:11:12.123Z) | |
| 2.04 | Status Reporting | Webhook | VoiceRemoteID | Added RemoteID value to Voice and Text-to-Speech webhooks, specifying the actual number that received the call (if Alt Phones are used) | |
| 2.04 | Status Reporting | Webhook | VoiceTotalCallTime | Added TotalCallTime value to Voice and Text-to-Speech webhooks, specifying the total call time for the last call in the sequence, including call set-up and ring time | |
| 2.04 | Status Reporting | Webhook | VoiceSeconds | Renamed "VoiceMinutes" to "VoiceSeconds" for clarity (value is specified in seconds) | |
| 2.04 | Receive Messages | SMS Received Webhook | InputToNumber | Added InputToNumber value to SMS Reply webhook which displays 'Destination' in the format supplied when sending the outbound message | |
Version 2.03: | ||||
| 2.03 | Send Messages & Edit Messages | SendTime Format | Updated SendTime values to use ISO 8601 date format (2023-04-25T23:04:39+00:00) | |
| 2.03 | Send Messages | Send Email | Email CCEmail | Added CCEmail value (adds a CC to the email) | |
| 2.03 | Send Messages | Voice & Text-to-Speech | Keypad PlaySection | Voice & Text-To-Speech - Added new "PlaySection" Keypad function (listener can press a keypad option to replay the Main or AnswerPhone message) | |
| 2.03 | Send Messages | Voice & Text-to-Speech | KeypadOptionRequired | Voice & Text-To-Speech - Added KeypadOptionRequired function in BETA status | |
| 2.03 | All | C# Samples | Updated C# sample codes to work on .NET 6 and above | |
| 2.03 | Status Reporting | All | Reformatted Responses | |
| 2.03 | Status Reporting | All | Simplified Response format - Removed Nested properties wherever possible | |
| 2.03 | Status Reporting & Receive Messages | GET Poll | Dates/Time Formatting | Updated GET Poll 'Date' to use ISO 8601 date format (2023-04-25T23:04:39+00:00) | |
| 2.03 | Status Reporting | GET Poll | CreatedUTC & DelayedUTC | Added 'CreatedUTC' and 'DelayedUTC' values to GET Poll | |
| 2.03 | Receive Messages | Receive Messages DateUTC | Added 'DateUTC' value to GET Poll | |
| 2.03 | Edit Messages | All | Simplified Response format - Removed Nested properties wherever possible | |
| 2.03 | Addressbook | Group Contacts | Added Addressbook API - List/Create/Delete for AddressBook group contacts | |
| 2.03 | Addressbook | Groups | Added Addressbook API - List/Detail/Create/Update/Delete for AddressBook groups | |
| 2.03 | Addressbook | Contact Groups | Added Addressbook API - List/Create/Delete for AddressBook contact groups | |
| 2.03 | Addressbook | Contacts | Added Addressbook API - List/Detail/Create/Update/Delete for AddressBook contacts | |
Version 2.02: | ||||
| 2.02 | Authentication | Auth | Added support for Authorization Headers (JWT Tokens) | |
| 2.02 | Edit Messages | All | Added Support for PATCH methods | |
| 2.02 | Receive Messages | GET SMS Received Poll | Parameterized options | |
| 2.02 | Receive Messages | GET SMS Received Poll | Added pagination | |
| 2.02 | Receive Messages | GET SMS Received Poll & GET SMS Reply Poll | Added support for GET methods | |
Version 2.01: | ||||
| 2.01 | Send Messages | Send Voice & Text-to-Speech | Options | Added Options features for Send Voice and Send TTS ('VoiceMinutes') | |
| 2.01 | Receive Messages | SMS Received Webhook | Added 'Type=SMSInbound' if the received SMS is not a reply | |
Version 2.00: | ||||
| 2.00 | All | All | Moved to dedicated API subdomain api.tnz.co.nz | |
| 2.00 | All | All | Significantly improved API throughput | |
| 2.00 | Send Messages | WebhookCallbackURL | Added WebhookCallbackURL to Send function | |
| 2.00 | Send Messages | WebhookCallbackFormat | Added WebhookCallbackFormat to Send function | |
| 2.00 | Status Reporting & Receive Messages | Webhook | Added SubAccount, Department and RESPONSEMODE to Status and Reply Webhook | |
| 2.00 | Status Reporting & Receive Messages | Webhook | Updated Expire rules for Status and Reply functions | |
Version 1.05: | ||||
| 1.05 | URL Shortener | Added URL Shortener feature to Send SMS | ||
| 1.05 | Reply Link | Added Reply Link feature to Send SMS | ||
| 1.05 | Webhook Retries | Added information on webhook retries | ||
| 1.05 | First Name | Added First Name option to Send Messages | ||
| 1.05 | Last Name | Added Last Name option to Send Messages | ||
| 1.05 | Keypad.Play | Added Keypad.Play option on MessageType=Voice | ||
| 1.05 | ReportTo | Added ReportTo option on MessageType=TextToSpeech & Voice | ||
Version 1.04: | ||||
| 1.04 | Resubmit | Added Retry Sending (Resubmit) controls to the Edit Messages section | ||
| 1.04 | Reschedule | Added Reschedule Sending controls to the Edit Messages section | ||
| 1.04 | Abort | Added Abort Sending controls to the Edit Messages section | ||
| 1.04 | NumberOfOperators | Added Adjust NumberOfOperators controls to the Edit Messages section | ||
Version 1.03: | ||||
| 1.03 | Files | Added field on 'SMS Send' module for MessageLink attachments | ||
| 1.03 | InboundSMS | Added Get InboundSMS Poll option (displays all SMS received in a timeframe) | ||
Version 1.02: | ||||
| 1.02 | FromNumber | Added field on 'SMS Send' module | ||
| 1.02 | New Module | Added 'Get Status' module | ||
| 1.02 | SMTPFrom | Added field | ||
| 1.02 | FromEmail | Added field | ||
| 1.02 | ReplyTo | Added field | ||
| 1.02 | ReplyTo | Added field | ||
Version 1.01: | ||||
| 1.01 | MessageID | Moved MessageID field from MessageType to Base API | ||
| 1.01 | MessageID | Added UUID value response if MessageID is not supplied or blank | ||
| 1.01 | MessageID | Increased allowed MessageID length to 50 characters | ||