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

dingtalk.oapi.workbench.shortcut.getguideuri (获取快捷方式添加到工作台引导页地址)

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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
app_id	String	必须	201911		ISV微应用ID

响应参数

名称	类型	示例值	描述
guide_uri	String	https://h5.dingtalk.com/industry_versatility/addShortcut.html?dd_progress=false&corpId=dingfa81761340c4f44035c2f4657eb6378f&appId=1730	快捷方式添加到工作台引导页地址
errcode	Number	0	服务返回码
errmsg	String	成功	服务返回信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/getguideuri");
OapiWorkbenchShortcutGetguideuriRequest req = new OapiWorkbenchShortcutGetguideuriRequest();
req.setAppId("201911");
OapiWorkbenchShortcutGetguideuriResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/getguideuri");
OapiWorkbenchShortcutGetguideuriRequest req = new OapiWorkbenchShortcutGetguideuriRequest();
req.AppId = "201911";
OapiWorkbenchShortcutGetguideuriResponse 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 OapiWorkbenchShortcutGetguideuriRequest;
$req->setAppId("201911");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/workbench/shortcut/getguideuri");

curl -X POST "https://oapi.dingtalk.com/topapi/workbench/shortcut/getguideuri" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fea34d94-6181-44f1-8624-310e2f213274' \
-d 'app_id=201911'

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

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

req.app_id="201911"
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.getguideuri");
add_param(pRequest,"app_id","201911");
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.getguideuri', {
	'app_id':'201911'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "guide_uri":"https:\/\/h5.dingtalk.com\/industry_versatility\/addShortcut.html?dd_progress=false&corpId=dingfa81761340c4f44035c2f4657eb6378f&appId=1730",
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.workbench.shortcut.getguideuri (获取快捷方式添加到工作台引导页地址)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ