SDKs & APIs

This section contains links to SDK and API documentation.

SDK documentation

The NDEP Messaging SDK is a set of tools for creating and customizing in-app messages that deliver the ideal online customer service through a chat interface.

The NDEP Messaging SDK documentation provides information about SDKs that are available for Android and iOS. See Nuance Android Messaging SDK and Nuance iOS Messaging SDK.

It also covers the rich media widget engine and describes the configuration required to set up the widgets: see Rich media.

Nuance Web SDK documentation provides an extensive description of the benefits of using the Web SDK over other standard deployment methods. See Nuance Web SDK.

API documentation

API documentation is written for Nuance and client technical developers. APIs contain confidential intellectual property.

  • Nuance Reporting API: Allows customers to access realtime and historical data from NDEP.
  • Customer Engagement API (CEAPI): Used to power third-party messaging channels and native mobile applications on NDEP.
  • Data Collection API (DCAPI): Used to supplement data at the engagement level within NDEP. It can be leveraged for agents while a chat is in-progress or gathered for reporting purposes.

Agent Status API

The Agent Status API is used to check the availability of live agents before transferring from any virtual assistant to ensure timely responses for the consumer.

Chat Events API

The Chat Events API is a JavaScript-based API that allows customers to listen for events fired by NDEP and track that information within third-party web analytic solutions to supplement any existing web reporting with information generated by NDEP.

Invitation API

The Invitation API is used to create and send dynamic messages to seamlessly move consumers to a digital engagement from another channel, such as voice.

User Management API

The Nuance User Management API supports managing user accounts without using the NDEP Portal.