Configure the shortcut entry (group plugin) URL

​

Redirect to a page

dingtalk://dingtalkclient/page/link?dd_mode=present&pc_slide=true&url=https%3A%2F%2Fwww.dingtalk.io

​

Redirect to a web app (H5 micro app)

dingtalk://dingtalkclient/action/openapp?corpid=$CORPID$&container_type=work_platform&app_id=0_1234&redirect_type=jump&redirect_url=https%3A%2F%2Fwww.dingtalk.io

​

Redirect to a mini program

1. Parameters supported when ddMode=float (floating window)

   Parameter	Required	Description
   panelHeight	No	The floating window height. Can be a screen-Percent value or a fixed height. - percent50 means 50% of the screen. The number must be between (0, 100]. Values beyond the boundaries are clamped to the boundary. - 1000 means a fixed height of 1000 pt (not px). - If not set or set to 0, the floating window is displayed in full screen.
   containerType	No	Two additional values are available in this scenario: - miniApp (default): Mini program. - online: Online H5.
   miniAppId	Determined by containerType	The mini program appId.
   page	Determined by containerType	The URL-encoded page address. For mini programs, this is the mini program page. For online H5, this is the URL address.
   coverVisible	No. Displayed by default. Set to false to hide.	- true (default): Show the overlay layer. - false: Hide the overlay layer. Displayed by default.

​

Parameters supported when ddMode=pop (pop-up layer)

2. Open app scheme (dedicated scheme for enterprise mini programs) Scheme: dingtalk://dingtalkclient/action/open_micro_app The basic parameters are the same as the general parameter list. The gradual rollout control logic should be placed in the handler of this scheme.

   Parameter	Required	Description
   corpId	Yes	The organization ID. Important This has higher priority and overrides the corpId in the query.
   appId	Either appId or agent_id is required. If both are provided, appid takes priority.	The Micro app ID. Note that this is not the mini program ID. Use this ID for ISV apps.
   agentId	Either app_id or agent_id is required.	The agent_id of the internal app.
   fallbackUrl	No. Not required for micro apps that do not support H5. Required during the H5-to-mini-program gradual rollout phase.	The H5 address. For micro apps that do not support the mini program, this address is used directly.
   ddFocus	No	When set to true, the container prevents internal elements from getting focus during initialization. Default is false.
   ddForceAsync	No	Whether to force asynchronous launch. When forced to launch asynchronously, if a local offline package exists, synchronous updates are not triggered. Asynchronous updates are forced (to resolve launch issues in offline environments).

   Test cases for PC:
   • Open the URL in the side panel without a title.
     dingtalk://dingtalkclient/action/open_micro_app?corpId=11233&app_id=123&fallback_url=https%3A%2F%2Fwww.dingtalk.io&container_type=slide_panel
     
   • Open the URL in the side panel without a title.
     dingtalk://dingtalkclient/action/open_micro_app?corpId=11233&app_id=123&fallback_url=https%3A%2F%2Fwww.dingtalk.io
     
   • Open the URL in the browser.
     dingtalk://dingtalkclient/action/open_micro_app?corpId=11233&app_id=123&fallback_url=https%3A%2F%2Fwww.dingtalk.io&container_type=browser
     
   • Open the URL in the side panel with a title.
     https://www.dingtalk.io?micro_app_scheme=dingtalk%3A%2F%2Fdingtalkclient%2Faction%2Fopen_micro_app%3F%0AcorpId%3D11233%26app_id%3D123%26container_type%3Dslide_panel%26title%3Dtest_title
     
   • Open the URL in the browser.
     https://www.dingtalk.io?micro_app_scheme=dingtalk%3A%2F%2Fdingtalkclient%2Faction%2Fopen_micro_app%3F%0AcorpId%3D11233%26app_id%3D123%26container_type%3Dbrowser%26title%3Dtest_title
     
3. Open mini program scheme (dedicated scheme for personal mini programs) Scheme: dingtalk://dingtalkclient/action/open_mini_app The basic parameters are the same as the general parameter list.

   Parameter	Required	Description
   miniAppId	Yes	The mini program ID.

4. Mini program debug scheme Scheme: dingtalk://dingtalkclient/action/dev_mini_app Mainly used for debugging mini programs and for appx framework development. Mini programs opened in this way launch the main document directly via the URL. They do not enter the package management process and do not trigger the keep-alive logic. miniAppId is used only for API verification and similar purposes.

​

Important

​

Retrieve source group information via the link

• Specify a special opening method. A shortcut entry (group plugin) is a dingtalk Link with business capabilities. Developers need to assemble a group plugin Link based on the actual scenario of their Micro app and the specific needs of users in the group. The plugin name supports up to 4 characters. The Link offers extensive capabilities, but developers must compose them through Link parameters. For example, the opening method on mobile (push page, pop-up page, etc.) and the page redirect logic on PC (open a new container or use the slide panel) are all implemented through Link parameter configuration. The following uses the shortcut entry of a project group as an example to explain in detail how a shortcut entry Link is assembled. dingtalk://dingtalkclient/page/link?url=https%3a%2f%2fding-doc.dingtalk.io%2fdoc%23%2fpqkq0u%2feluagw%2f$CORPID$%2f$DOUBLE_ENCCID$
  • Developer’s target page address: https%3a%2f%2fding-doc.dingtalk.io%2fdoc%23%2fpqkq0u%2feluagw
    • When you use the DingTalk unified redirect protocol, this part is passed as an input parameter to the “DingTalk unified redirect protocol” address and therefore must be URL-encoded.
    • When you do not use the DingTalk unified redirect protocol, you can use the original URL directly as the shortcut entry address. URL encoding is not required.
  • DingTalk unified redirect protocol (optional): dingtalk://dingtalkclient/page/link?url=
    • This part determines how the specified page is opened. Currently supported options include “Open in browser” and “Open in side panel”. The path of the unified redirect protocol differs for each option.
    • Some unified redirect protocol paths are only available on certain platforms. For example, “Open in side panel” is only available on PC and Mac.
  • Shortcut entry address dynamic parameters (optional): $CORPID$ $DOUBLE_ENCCID$
    • When dynamic parameters are set, this part of the URL is replaced with group Context information (such as corpId and openConversationId) when the user clicks the shortcut entry to access the developer’s address. Currently supported dynamic parameters are as follows:

      The following dynamic parameters are only recognized when opened via a shortcut entry (group plugin).

      Parameter	Description
      $CORPID$	Dynamically replaced with the Organization ID (corpId).
      $ENCCID$	Dynamically replaced with the open conversation ID (openConversationId). Use this dynamic parameter only when the DingTalk unified redirect protocol is not used.
      $DOUBLE_ENCCID$	Dynamically replaced with the open conversation ID (openConversationId). The difference is that it is URL-encoded twice, used for URL decoding across multiple protocol pass-through redirects. Use this dynamic parameter only when the DingTalk unified redirect protocol is used.

      $DOUBLE_ENCCID$ is URL-encoded and decoded twice because DingTalk has an internal protocol layer starting with dingtalk://, which requires one round of encoding when parsing. The business HTTPS protocol passed through the URL parameter to the downstream container also requires one round of encoding and decoding. Since the consumer requires two rounds of parsing, two rounds of encoding are required when generating the URL. Example of URL generation: urlencode(DingTalk URL?xxx=xxx & url = urlencode(business URL)) Example of URL parsing: a. urldecode(DingTalk URL) -> Get the business URL; b. urldecode(business URL) -> Get the usable parameters.