查询服务号菜单

调用本接口查询指定服务号的会话菜单。

例如，“测试修改服务号1”服务号配置了菜单1、菜单2，调用本接口可以获取配置的菜单相关信息。

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	企业内部服务号菜单权限	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

基本信息

请求方式：POST

请求地址：https://oapi.dingtalk.com/topapi/serviceaccount/menu/get

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

是

30c9a84136943eaxxxx

调用该接口的应用凭证。

企业内部应用，通过获取企业内部应用的access_token接口获取。

Body参数

名称	类型	是否必填	示例值	描述
unionid	String	是	jYdrJoCmTo0iE	服务号的unionid，可通过查询服务号列表接口获取。

返回参数

名称	类型	示例值	描述
errmsg	String	ok	返回码描述。
errcode	Number	0	返回码。
request_id	String	10c0npg1bgup3	请求ID。
menu	MenuConfigDTO		菜单。
button	MenuButtonDTO[]		菜单按钮列表。
name	String	天气	菜单名称。
type	String	click	菜单类型。说明如果为父菜单，则该字段为空。
key	String	KEY_WEATHER	菜单绑定的key值。
url	String	https://www.taobao.com	菜单绑定的URL。
media_id	String	mvFiiRhuwt5IiE	菜单素材id。
sub_button	MenuSubButtonDTO[]		子菜单按钮列表。
type	String	click	子菜单类型。
name	String	杭州天气	子菜单名称。
key	String	WEATHER_HANGZHOU	子菜单绑定的key值。
url	String	https://www.taobao.com	子菜单绑定的URL。
media_id	String	mvFiiRhuwt5IiE	子菜单素材id。
enable_input	Boolean	false	是否允许用户输入： true：允许 false：不允许
status	Number	0	状态： 0：正常 1：停用

示例

请求示例（HTTP）

POST https://oapi.dingtalk.com/topapi/serviceaccount/menu/get?access_token=ACCESS_TOKEN

请求正文

{
        "unionid":"jYdrJoCmTo0iE"
}

请求示例（JAVA SDK）

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/serviceaccount/menu/get");
OapiServiceaccountMenuGetRequest req = new OapiServiceaccountMenuGetRequest();
req.setUnionid("jYdrJoCmTo0iE");
OapiServiceaccountMenuGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回示例

{
    "errcode":0,
    "request_id":"10c0npg1bgup3",
    "menu": {
        "button": [
            {
                "key": "KEY_WEATHER",
                "media_id": "mvFiiRhuwt5IiE",
                "name": "今日天气",
                "sub_button": [
                    {
                        "key": "WEATHER_HANGZHOU",
                        "media_id": "mvFiiRhuwt5IiE",
                        "name": "杭州天气",
                        "type": "click",
                        "url": "https:\/\/www.taobao.com"
                    }
                ],
                "type": "view",
                "url": "https:\/\/www.taobao.com"
            }
        ],
        "enable_input": false,
        "status": 0
    }
}