文档中心 > API类目 > 钉钉API

dingtalk.oapi.workbench.shortcut.add (给开通应用企业添加快捷方式)

ISV给开通其应用的企业添加快捷方式

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
shortcut_uri	String	必须	https://test.dingtalk.com/Mobile?corpid=$CORPID$	移动端快捷方式跳转地址(默认地址)
icon	String	必须	https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png	图标Url
app_id	String	必须	20191231	微应用ID
name	String	必须	测试应用快捷方式	快捷方式名称
biz_no	String	必须	20190411123	系统交互唯一业务号,ISV企业下唯一
pc_shortcut_uri	String	可选	https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png	PC端快捷方式跳转地址

响应参数

名称	类型	示例值	描述
result	IsvOrgShortcutStatusDto		系统自动生成
└ biz_no String 2019040113213 唯一流水号-系统交互唯一识别码
errcode	Number	0	服务返回码
errmsg	String	成功	服务返回信息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/add");
OapiWorkbenchShortcutAddRequest req = new OapiWorkbenchShortcutAddRequest();
req.setShortcutUri("https://test.dingtalk.com/Mobile?corpid=$CORPID$");
req.setIcon("https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
req.setAppId("20191231");
req.setName("测试应用快捷方式");
req.setBizNo("20190411123");
req.setPcShortcutUri("https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
OapiWorkbenchShortcutAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/add");
OapiWorkbenchShortcutAddRequest req = new OapiWorkbenchShortcutAddRequest();
req.ShortcutUri = "https://test.dingtalk.com/Mobile?corpid=$CORPID$";
req.Icon = "https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png";
req.AppId = "20191231";
req.Name = "测试应用快捷方式";
req.BizNo = "20190411123";
req.PcShortcutUri = "https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png";
OapiWorkbenchShortcutAddResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiWorkbenchShortcutAddRequest;
$req->setShortcutUri("https://test.dingtalk.com/Mobile?corpid=$CORPID$");
$req->setIcon("https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
$req->setAppId("20191231");
$req->setName("测试应用快捷方式");
$req->setBizNo("20190411123");
$req->setPcShortcutUri("https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/workbench/shortcut/add");

curl -X POST "https://oapi.dingtalk.com/topapi/workbench/shortcut/add" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=089e7f08-5255-4297-abaa-392b6881ffcd' \
-d 'app_id=20191231' \
-d 'biz_no=20190411123' \
-d 'icon=https%3A%2F%2Fstatic.dingtalk.com%2Fmedia%2FlALOAAGjBcyWzJY_150_150.png' \
-d 'name=%E6%B5%8B%E8%AF%95%E5%BA%94%E7%94%A8%E5%BF%AB%E6%8D%B7%E6%96%B9%E5%BC%8F' \
-d 'pc_shortcut_uri=https%3A%2F%2Fstatic.dingtalk.com%2Fmedia%2FlALOAAGjBcyWzJY_150_150.png' \
-d 'shortcut_uri=https%3A%2F%2Ftest.dingtalk.com%2FMobile%3Fcorpid%3D%24CORPID%24'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiWorkbenchShortcutAddRequest("https://oapi.dingtalk.com/topapi/workbench/shortcut/add")

req.shortcut_uri="https://test.dingtalk.com/Mobile?corpid=$CORPID$"
req.icon="https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png"
req.app_id="20191231"
req.name="测试应用快捷方式"
req.biz_no="20190411123"
req.pc_shortcut_uri="https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.workbench.shortcut.add");
add_param(pRequest,"shortcut_uri","https://test.dingtalk.com/Mobile?corpid=$CORPID$");
add_param(pRequest,"icon","https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
add_param(pRequest,"app_id","20191231");
add_param(pRequest,"name","测试应用快捷方式");
add_param(pRequest,"biz_no","20190411123");
add_param(pRequest,"pc_shortcut_uri","https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.workbench.shortcut.add', {
	'shortcut_uri':'https://test.dingtalk.com/Mobile?corpid=$CORPID$',
	'icon':'https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png',
	'app_id':'20191231',
	'name':'测试应用快捷方式',
	'biz_no':'20190411123',
	'pc_shortcut_uri':'https://static.dingtalk.com/media/lALOAAGjBcyWzJY_150_150.png'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "biz_no":"2019040113213"
    },
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.workbench.shortcut.add (给开通应用企业添加快捷方式)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ