DevConnect - SDKs

IMPORTANT NOTICE: READ THIS CAREFULLY BEFORE ELECTRONICALLY ACCESSING OR USING THIS PROPRIETARY PRODUCT, WHICH IS SUBJECT TO COPYRIGHT!

BY OPENING, INSTALLING, DOWNLOADING, COPYING OR OTHERWISE USING THE AVAYA SOFTWARE DEVELOPMENT KIT (“SDK”) YOU, INDIVIDUALLY, AND/OR THE LEGAL ENTITY FOR WHOM YOU ARE (COLLECTIVELY, AS REFERENCED HEREIN, “YOU”, “YOUR”, OR “LICENSEE”) ARE AGREEING TO THE AVAYA SDK LICENSE AGREEMENT, FOUND AT HTTP://SUPPORT.AVAYA.COM/LICENSEINFO (OR A SUCCESSOR SITE PROPERLY NOTICED) WHICH MAY BE UPDATED FROM TIME TO TIME AND WILL APPLY PROSPECTIVELY (THE “AGREEMENT”) BETWEEN YOU AND AVAYA LLC OR ANY AVAYA AFFILIATE (COLLECTIVELY, “AVAYA”). IF YOU ARE ACCEPTING THE TERMS AND CONDITIONS OF THE AGREEMENT ON BEHALF OF A LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE FULL LEGAL AUTHORITY TO ACCEPT ON BEHALF OF AND BIND SUCH LEGAL ENTITY TO THIS AGREEMENT. BY OPENING THE MEDIA CONTAINER, BY INSTALLING, DOWNLOADING, COPYING OR OTHERWISE USING THE AVAYA SDK OR AUTHORIZING OTHERS TO DO SO, YOU SIGNIFY THAT YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT HAVE SUCH AUTHORITY OR DO NOT WISH TO BE BOUND BY THE TERMS OF THIS AGREEMENT, DO NOT OPEN, INSTALL, DOWNLOAD, COPY OR OTHERWISE USE THE AVAYA SDKS AND YOU SHALL HAVE NO RIGHT TO USE THE SDK POSTED HEREIN.

• For all Avaya Experience Platform (AXP) API & SDK materials, please see developers.avayacloud.com.

The Web Telephony Interface API Reference .zip download contains JSON files. https://editor-next.swagger.io/ can be used to view this material.

• Web Telephony REST Services API
• Avaya Aura Private Cloud Admin Portal Web Services API

Developer Documentation

• READ ME FIRST – Avaya Client SDK Developer Documentation Local Archive
• Avaya Client SDK Developer Documentation Local Archive

Software Development Kits

• Avaya Client SDK for Android, Release 4.33.0.0
• Avaya Client SDK for iOS, Release 4.33.0.0
• Avaya Client SDK for JavaScript, Release 4.33.0.0
• Avaya Client SDK for macOS, Release 4.33.0.0
• Avaya Client SDK for Windows, Release 4.33.0.0

Other Developer Resources

• Avaya Client SDK Release Notes Release 4.33.0.0
• Avaya Client SDK External Application API, v188
• Authorization Helper APIs for External Clients, Avaya Breeze Release 3.9
• Port Matrix: Avaya Client SDK Release 4.x Communication Services Package
• UC DP Addendum - JavaScript Client SDK 1.0
• UC DP Addendum - Native Client SDK 1.0

MIB Files

• Avaya Aura AES Release 10.2 Dec 2023 - Standard Management Information Base (MIB) files
• Avaya Aura AES Release 10.2 Dec 2023 - Product MIB files

DMCC APIs

• Avaya Aura AES Release 10.2 Dec 2023 DMCC Java SDK - (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 DMCC Java SDK - (Linux)
• Avaya Aura AES Release 10.2 Dec 2023 DMCC XML SDK (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 DMCC XML SDK (Linux)
• Avaya Aura AES Release 10.2 Dec 2023 DMCC .NET SDK
• Recommended Guidance for Avaya Aura AES DMCC Applications Utilizing Call Media

System Management Service

• Avaya Aura AES Release 10.2 Dec 2023 System Management Service (SMS) SDK (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 System Management Service (SMS) SDK (Linux)

Telephony Web Services

• Avaya Aura AES Release 8.1.3 Oct 2020 Web Service - Telephony Services SDK (Windows)
• Avaya Aura AES Release 8.1.3 Oct. 2020 Web Service - Telephony Services SDK (Linux)

Web Telephony Interface

The Web Telephony Interface API Reference .zip downloads contains JSON files. https://editor-next.swagger.io/ can be used to view this material.

• Avaya Aura AES Web Telephony Interface Service REST API Reference, Release 10.2, version 1
• Avaya Aura AES Web Telephony Interface Service WebSocket API Reference, Release 10.2, version 1

JTAPI

• Avaya Aura AES Release 10.2 Dec 2023 JTAPI SDK and Client (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 JTAPI SDK and Client (Linux)

TSAPI

• Avaya Aura AES Release 10.2.0.1 Apr 2024 TSAPI Client Win 32 (Windows)
• Avaya Aura AES Release 10.2.0.1 Apr 2024TSAPI Client 64 Bit (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 TSAPI Client 32 Bit (Linux)
• Avaya Aura AES Release 10.2 Dec 2023 TSAPI Client 64 Bit (Linux)

CVLAN API

• Avaya Aura AES Release 10.2 Dec 2023 CVLAN Client (Windows)
• Avaya Aura AES Release 10.2 Dec 2023 CVLAN Client (Linux)

CDR Interface

• Avaya Aura Session Manager Sample XML and Extended Format CDR Files
• Avaya Aura Session Manager Sample Standard Format CDR Files

Web Services

• Element Manager Web Service SDK, Release 10.2

PPM Web Services

• Avaya Aura Session Manager PPM Interface Specification for Release 10.x.x, Version 2.14
• Avaya Aura Session Manager Personal Profile Manager (PPM) Interface for Release 8.1 - 10.x.x

Web Services

• Avaya Aura System Manager Release 10.x.x User Management Web Services Sample Client SDK
• Avaya Aura System Manager Release 10.2 Dec 2023 Routing Web Services SDK
• Element Manager Web Service SDK, Release 10.2

Configuration Open API

• Avaya SBC Release 10.2.0.1 API Development Kit and Quick Start Guide
• Avaya SBC Release 10.2.0.1 API Quick Start Guide
• Avaya SBC Release 10.2 API Development Kit and Quick Start Guide
• Avaya SBC Release 10.2 API Quick Start Guide

Template Wizard

• Avaya SBC Release 10.1.2 Template Wizard and DAT Configuration Guide
• Avaya SBC Release 10.1.2 DAT Configuration Guide

Developer Resources

• Avaya Experience Portal Release 8.1.1-8.1.2 Automation Web Services Reference Guide, Issue 1.0

• Developers interested in obtaining the Avaya Orchestration Designer Release 8.1.2 (8.1.2.1101 build) ISO image should contact Avaya DevConnect for download instructions.

Contact Control Service

• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK
• Avaya Aura CC & CCS Release 7.1.2.2 Contact Control Service Java SDK
• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK Release Notes & User Guide
• Avaya Aura CC & CCS Release 7.1.2 Contact Control Service Java SDK Release Notes & User Guide

Open Interfaces (SOA Web Services)

• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Networking Web Services SDK
• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Queue Web Services SDK
• Avaya Aura CC Release 7.0 & 7.1.x CCMA Open Interfaces SDK
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Agent Web Services SDK
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Outbound Web Services SDK
• Avaya Aura CC Release 7.0 & 7.1.x Communication Control Toolkit Open Interfaces REST SDK
• Avaya Aura CC Release 7.0 & 7.1.x Communication Control Toolkit Open Interfaces SOAP SDK
• Avaya Aura CC Release 7.0 & 7.1.x Contact Control Toolkit Open Interfaces SDK Release Notes
• Avaya Aura CC Email Open Interfaces Sample Web Service
• Avaya Aura CC Email Open Interfaces – Developing Compliant Web Services

CCMS Programming APIs

• Avaya Aura CC & CCS Release 7.1.1 Real-time Data SDK
• Avaya Aura CC & CCS Release 7.1.1 Real-time Data API Programmer's Guide
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistics Multicast SDK
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistic Multicast Programmer's Guide
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Interface SDK
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Programmer's Guide

Enterprise Web Chat

• Avaya Aura CC Release 7.1.2 Enterprise Web Chat SDK
• Avaya Aura CC Release 7.1.2 Enterprise Web Chat Programming Reference Guide

CCT .Net API

• Avaya Aura CC Release 7.0.1 CCT .Net SDK

Historical Reporting Database

• JDBC, Windows, and UNIX ODBC drivers are available for download from InterSystems Cache.

Headset Interface API

• Note: Using third-party headsets with Agent Desktop in embedded softphone mode requires registering the Headset Interface DLL on the client machine.
• Agent Desktop Headset Support MSI
• Avaya one-X Communicator Headset Integration Guide, Issue 1.1 (December 2010)

Contact Control Service

• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK
• Avaya Aura CC & CCS Release 7.1.2.2 Contact Control Service Java SDK
• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK Release Notes & User Guide
• Avaya Aura CC & CCS Release 7.1.2 Contact Control Service Java SDK Release Notes & User Guide

Open Interfaces (SOA Web Services)

• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Queue Web Services SDK
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Outbound Web Services SDK
• Avaya Aura CC Email Open Interfaces Sample Web Service
• Avaya Aura CC Email Open Interfaces – Developing Compliant Web Services

CCMS Programming APIs

• Avaya Aura CC & CCS Release 7.1.1 Real-time Data SDK
• Avaya Aura CC & CCS Release 7.1.1 Real-time Data API Programmer's Guide
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistics Multicast SDK
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistic Multicast Programmer's Guide
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Interface SDK
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Programmer's Guide

Enterprise Web Chat

• Avaya Aura CC Release 7.1.2 Enterprise Web Chat SDK
• Avaya Aura CC Release 7.1.2 Enterprise Web Chat Programming Reference Guide

CCT .Net API

• Avaya Aura CC Release 7.0.1 CCT .Net SDK

Database Connectivity Drivers

• JDBC and UNIX ODBC drivers are available for download from InterSystems Cache.

Pluggable Data Connector

• Proactive Outreach Manager Release 4.0.2 Pluggable Data Connector Installer

Agent Desktop APIs

• Proactive Outreach Manager Release 4.0.2 Agent Desktop API for .net
• Proactive Outreach Manager Release 4.0.2 Agent Desktop API for Java

Call Recorder API

• Proactive Outreach Manager Release 4.x Call Recorder API Sample Client

Event SDK

• Proactive Outreach Manager Release 4.0.2 Event SDK

Software Development Kits

• Avaya Breeze SDK, Release 3.9
• Avaya Breeze SDK, Release 3.8.1
• Authorization Helper APIs for External Clients, Avaya Breeze Release 3.9
• Authorization Helper APIs for External Clients, Avaya Breeze Release 3.8.1

Developer Resources

• Getting Started with the Avaya Breeze SDK, Release 3.9, Issue 1
• Getting Started with the Avaya Breeze SDK, Release 3.8.1.1, Issue 1
• Avaya Breeze Snap-in Development Guide, Release 3.9, Issue 1
• Avaya Breeze Snap-in Development Guide, Release 3.8.1.1, Issue 1
• Avaya Breeze FAQ and Troubleshooting for Snap-in Developers, Release 3.9, Issue
• Avaya Breeze FAQ and Troubleshooting for Snap-in Developers, Release 3.8, Issue 1

CSDK External Application API

• Avaya Client SDK External Application API, v188

TAPI, DevLink3, & DevLink

• IP Office Platform Devlink3 API Description
• Avaya IP Office DevLink3 Tutorial Guide, Issue 1
• Avaya IP Office DevLink3 Tutorial Sample Code, Issue 1
• TAPI 2 Release 1.0.0.44, TAPI 3 Release 1.0.0.44 and DevLink Release 1.0.0.5 driver installers

SSL VPN Onboarding APIs

• IP Office Release 9.1 SSL VPN Onboarding SDK
• IP Office Release 9.1 SSL VPN Onboarding Developer’s Guide
• IP Office Release 9.1 SSL VPN Onboarding Express SDK
• IP Office Release 9.1 SSL VPN Onboarding Express Developer’s Guide

Location API & Emergency Service Call Alarm

• Description of Location API Introduced in Release 10.0, Revision 1
• IP Office Release 10.0 Location API SDK
• IP Office Release 10.1 Emergency Services Call Alarm Guide
• Making Use of the Emergency Services Access Enhancements in IP Office Release 9.0/9.1 White Paper
• IP Office Emergency Services Call Alarm PCAP Files

SNMP

• IP Office Management Information Base (MIB) Files, Release 12.0

WebRTC SDK API

• IP Office Platform Release 11.1.1 WebRTC SDK - Version 1.21
• IP Office Platform Description of WebRTC SDK API - Issue 1.21

Web Services

• IP Office Release 11.0.4 Centralized CTI Web Services SDK
• IP Office Release 11.0.4 CTI Web Services Programmers' Guide - Issue 1.0.3
• IP Office Release 10.1 Service Monitoring Web Services SDK
• IP Office Platform Service Monitoring Web Services API - Issue 1.02
• IP Office Release 11.1 MTCTI-3 Web Services API SDK Version 1.0

Management API

• IP Office Release 11.0 Management API Developer Reference Guide

Developer Resources

• Avaya Analytics Release 4.1.1-4.3 REST & WebSocket Open Interface Sample Client
• Avaya Analytics Release 4.2-4.3 REST & WebSocket Open Interface API Guide, Issue 1

Assisted Chat Client APIs

• Avaya Oceana Release 3.10 Web-based Assisted Chat Reference Client
• Avaya Oceana Release 3.10 Digital Transcript Filtering Reference Client
• Avaya Oceana Release 3.10 Android Assisted Chat Reference Client
• Avaya Oceana Release 3.10 iOS Assisted Chat Reference Client

Avaya Digital Connector (Messaging) APIs

• Avaya Oceana Release 3.10 Digital Connector (Messaging) SDK (updated May 2024)

Generic Channel APIs

• Avaya Oceana Release 3.10 Generic Channel Reference Client

Developer Resources

• Avaya Oceana Release 3.10 Email Open Interfaces Sample Client
• Avaya Oceana Release 3.10 Email Open Interfaces Developer Guide
• Avaya Oceana Release 3.10 Customer Management Widgets
• Avaya Oceana Release 3.10 Customer Management Widgets Installation Guide

Sample Customer Journey Workflow

• Avaya Oceana Release 3.10 Sample Workflow Definitions and Prompts for Avaya Engagement Designer
• Avaya Oceana Release 3.10 Sample Self Service Application for Avaya Experience Portal
• Avaya Oceana Release 3.10 Sample Self Service Application Source for Avaya Experience Portal

Postman Collections

• Avaya Oceana Work Assignment Postman Collections

Software Development Kits

• Avaya WebRTC Connect Release 4.0.5 SDK for Android
• Avaya WebRTC Connect Release 4.0.6 SDK for Javascript
• Avaya WebRTC Connect Release 4.0.5 SDK for iOS
• Avaya WebRTC Connect Release 4.0.6 Software Development Guide

• 17 June 2024 – Initial SDK set published
• 2 July 2024 – Avaya Client SDK Developer Documentation Local Archive added
• 15 July 2024 - Swagger.io link added to Avaya Aura AES and Avaya Aura Private Cloud; Avaya Enterprise Cloud name change to Avaya Aura Private Cloud
• 16 August 2024 - Avaya Breeze platform SDK and Developer Resources added