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

dingtalk.oapi.workbench.shortcut.listbypaging (企业下快捷方式分页查询)

分页查询企业下已添加且有效的快捷方式列表

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
page_size	Number	可选	5		每页记录数
page_index	Number	可选	1		当前页码

响应参数

名称	类型	示例值	描述
result	IsvOrgShortcutListDTO		返回结果
shortcut_list IsvOrgShortcutDTO [] 企业下指定应用已添加快捷方式列表 └ shortcut_uri String https://test.dingtalk.com/Mobile?corpid=$CORPID$ 移动端快捷方式地址(默认地址) └ icon String https://gw.alicdn.com/tps/TB1zXtqOpXXXXa6XXXXXXXXXXXX-102-102.png 快捷方式图标 └ name String 测试CRM快捷方式快捷方式名称 └ biz_no String 2019041911123 业务单号,系统间交互唯一流水号 └ pc_shortcut_uri String https://test.dingtalk.com/Mobile?corpid=$CORPID$ PC端快捷方式地址
errcode	Number	0	服务结果码
errmsg	String	成功	服务结果描述

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/listbypaging");
OapiWorkbenchShortcutListbypagingRequest req = new OapiWorkbenchShortcutListbypagingRequest();
req.setPageSize(5L);
req.setPageIndex(1L);
OapiWorkbenchShortcutListbypagingResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workbench/shortcut/listbypaging");
OapiWorkbenchShortcutListbypagingRequest req = new OapiWorkbenchShortcutListbypagingRequest();
req.PageSize = 5L;
req.PageIndex = 1L;
OapiWorkbenchShortcutListbypagingResponse 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 OapiWorkbenchShortcutListbypagingRequest;
$req->setPageSize("5");
$req->setPageIndex("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/workbench/shortcut/listbypaging");

curl -X POST "https://oapi.dingtalk.com/topapi/workbench/shortcut/listbypaging" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fa6e3583-f62b-4ba4-aed9-3971287042fd' \
-d 'page_index=1' \
-d 'page_size=5'

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

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

req.page_size=5
req.page_index=1
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.listbypaging");
add_param(pRequest,"page_size","5");
add_param(pRequest,"page_index","1");
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.listbypaging', {
	'page_size':'5',
	'page_index':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "shortcut_list":[
            {
                    "shortcut_uri":"https:\/\/test.dingtalk.com\/Mobile?corpid=$CORPID$",
                    "icon":"https:\/\/gw.alicdn.com\/tps\/TB1zXtqOpXXXXa6XXXXXXXXXXXX-102-102.png",
                    "name":"测试CRM快捷方式",
                    "biz_no":"2019041911123",
                    "pc_shortcut_uri":"https:\/\/test.dingtalk.com\/Mobile?corpid=$CORPID$"
            }
        ]
    },
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.workbench.shortcut.listbypaging (企业下快捷方式分页查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ