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

dingtalk.oapi.crm.menu.get (导航菜单列表)

获得app的导航栏菜单列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
client_type	String	必须	0		0:PC端导航 1：手机端导航

响应参数

名称	类型	示例值	描述
result	OnlineNavigationModel	0	接口返回model
└ form_uuid String PROC-E513AD70-D13D-498C-8C83-FC967960DC0A 表单id 如果非表单类菜单，可为空 └ parent_id Number 200000 树形结构父菜单id └ name String 客户菜单名称 └ list_order Number 1 菜单排序序号 └ nav_type String sw_form 导航类型：sw_form：表单类到导航 group：分组类 outLinker：链接跳转 └ is_new Number 0 是否新打开页面 0:不打开 1：新打开 └ mobile_hidden Number 手机端隐藏 1:隐藏 0：不隐藏 └ pc_hidden Number pc端隐藏 1:隐藏 0：不隐藏 └ link_url String https://aflow.dingtalk.com/dingtalk/pc/query/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#/crmApp/index 链接地址 └ icon String https://img.alicdn.com/tfs/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png 图标地址 children OnlineNavigationModel [] 子菜单列表子菜单列表 └ parent_id Number 200000 树形结构父菜单id └ name String 客户菜单名称 └ form_uuid String PROC-E513AD70-D13D-498C-8C83-FC967960DC0A 表单id 如果非表单类菜单，可为空 └ list_order Number 1 菜单排序序号 └ nav_type String sw_form 导航类型：sw_form：表单类到导航 group：分组类 outLinker：链接跳转 └ is_new Number 0 是否新打开页面 0:不打开 1：新打开 └ mobile_hidden Number 手机端隐藏 1:隐藏 0：不隐藏 └ pc_hidden Number pc端隐藏 1:隐藏 0：不隐藏 └ link_url String https://aflow.dingtalk.com/dingtalk/pc/query/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#/crmApp/index 链接地址 └ icon String https://img.alicdn.com/tfs/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png 图标地址 children OnlineNavigationModel [] 子菜单列表子菜单列表 └ parent_id Number 200000 树形结构父菜单id └ name String 客户菜单名称 └ form_uuid String PROC-E513AD70-D13D-498C-8C83-FC967960DC0A 表单id 如果非表单类菜单，可为空 └ list_order Number 1 菜单排序序号 └ nav_type String sw_form 导航类型：sw_form：表单类到导航 group：分组类 outLinker：链接跳转 └ is_new Number 0 是否新打开页面 0:不打开 1：新打开 └ mobile_hidden Number 手机端隐藏 1:隐藏 0：不隐藏 └ pc_hidden Number pc端隐藏 1:隐藏 0：不隐藏 └ link_url String https://aflow.dingtalk.com/dingtalk/pc/query/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#/crmApp/index 链接地址 └ icon String https://img.alicdn.com/tfs/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png 图标地址
success	Boolean	true	是否成功
errcode	Number	200	错误码
errmsg	String	系统错误	错误描述

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/crm/menu/get");
OapiCrmMenuGetRequest req = new OapiCrmMenuGetRequest();
req.setClientType("0");
OapiCrmMenuGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/crm/menu/get");
OapiCrmMenuGetRequest req = new OapiCrmMenuGetRequest();
req.ClientType = "0";
OapiCrmMenuGetResponse 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 OapiCrmMenuGetRequest;
$req->setClientType("0");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/crm/menu/get");

curl -X POST "https://oapi.dingtalk.com/topapi/crm/menu/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d8d52c71-fa27-43a1-ba5b-ff0ab12320da' \
-d 'client_type=0'

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

req=dingtalk.api.OapiCrmMenuGetRequest("https://oapi.dingtalk.com/topapi/crm/menu/get")

req.client_type="0"
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.crm.menu.get");
add_param(pRequest,"client_type","0");
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.crm.menu.get', {
	'client_type':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "form_uuid":"PROC-E513AD70-D13D-498C-8C83-FC967960DC0A",
        "parent_id":200000,
        "name":"客户",
        "list_order":1,
        "nav_type":"sw_form",
        "is_new":0,
        "mobile_hidden":手机端隐藏,
        "pc_hidden":pc端隐藏,
        "link_url":"https:\/\/aflow.dingtalk.com\/dingtalk\/pc\/query\/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#\/crmApp\/index",
        "icon":"https:\/\/img.alicdn.com\/tfs\/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png",
        "children":[
            {
                    "parent_id":200000,
                    "name":"客户",
                    "form_uuid":"PROC-E513AD70-D13D-498C-8C83-FC967960DC0A",
                    "list_order":1,
                    "nav_type":"sw_form",
                    "is_new":0,
                    "mobile_hidden":手机端隐藏,
                    "pc_hidden":pc端隐藏,
                    "link_url":"https:\/\/aflow.dingtalk.com\/dingtalk\/pc\/query\/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#\/crmApp\/index",
                    "icon":"https:\/\/img.alicdn.com\/tfs\/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png",
                    "children":[
                        {
                                "parent_id":200000,
                                "name":"客户",
                                "form_uuid":"PROC-E513AD70-D13D-498C-8C83-FC967960DC0A",
                                "list_order":1,
                                "nav_type":"sw_form",
                                "is_new":0,
                                "mobile_hidden":手机端隐藏,
                                "pc_hidden":pc端隐藏,
                                "link_url":"https:\/\/aflow.dingtalk.com\/dingtalk\/pc\/query\/pchomepage.htm?corpid=dinga94e9ffe598e9d5ef2c783f7214b6d69&appUuid=SWAPP-E0D7F3DE72335471#\/crmApp\/index",
                                "icon":"https:\/\/img.alicdn.com\/tfs\/TB1.b8BnuL2gK0jSZFmXXc7iXXa-144-144.png"
                        }
                    ]
            }
        ]
    },
    "success":true,
    "errcode":200,
    "errmsg":"系统错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.crm.menu.get (导航菜单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ