DingTalk JSAPI

DingTalk offers a wide range of JSAPI capabilities, such as native dialogs, device information, and QR code scanning. YiDA developers can leverage these native APIs to deliver a better User experience.

DingTalk JSAPI Feature List
For DingTalk developer fundamentals, see Basic Concepts.

Keep the following in mind when calling DingTalk JSAPI:

In YiDA apps, window.dd is not guaranteed to exist (currently, only the mobile client loads a legacy resource). Load it manually.
In YiDA apps, you can call APIs that require Authentication even without configuring dd.config. Use these APIs with caution.
Retrieve the corpId parameter required for JSAPI calls with const { corpId } = window.pageConfig || {};.

Usage Guide

Step 1: Asynchronously Load the DingTalk JSAPI Resource

Because window.dd is not guaranteed to exist in YiDA pages, load the DingTalk JSAPI script manually in the didMount lifecycle hook:

export function didMount() {
  this.utils.loadScript('https://g.alicdn.com/dingding/dingtalk-jsapi/3.0.25/dingtalk.open.js');
}

Once the resource is loaded, call JSAPI features via window.dd.

Step 2: Call DingTalk JSAPI

After the DingTalk JSAPI is loaded, call DingTalk APIs via window.dd from the action panel:

export function isDingTalk() {
  return window.navigator && /dingtalk/i.test(window.navigator.userAgent)
}

export function dingAlert() {
  if (window.dd && this.isDingTalk()) {
    window.dd.device.notification.alert({
      message: "Test",
      title: "Tips", // can be empty
      buttonName: "Got it",
      onSuccess: function () {
      },
      onFail: function (err) { }
    });
  }
}

Many DingTalk JSAPI methods must be called from within the app. Verify that the user is inside the DingTalk client before calling them:

export function isDingTalk() {
  return window.navigator && /dingtalk/i.test(window.navigator.userAgent)
}

API List

For the full list of supported APIs, see the DingTalk Open Platform Documentation.

Getting Started

Developer Guide

API

Tutorials

Components

Usage Guide

Step 1: Asynchronously Load the DingTalk JSAPI Resource

Step 2: Call DingTalk JSAPI

API List

​Usage Guide

​Step 1: Asynchronously Load the DingTalk JSAPI Resource

​Step 2: Call DingTalk JSAPI

​API List

Usage Guide

Step 1: Asynchronously Load the DingTalk JSAPI Resource

Step 2: Call DingTalk JSAPI

API List