文档中心 > 芝麻开放文档测试

dingtalk.oapi.serviceaccount.menu.get (查询服务号菜单)

查询服务号菜单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
unionid String 必须 jYdrJoCmTo0iE 服务号的unionid

响应参数

名称 类型 示例值 描述
errmsg String ok 错误信息
errcode Number 0 错误码
menu MenuConfigDTO 菜单
  • button
  • MenuButtonDTO []
  • 菜单按钮列表
  • └ name
  • String
  • 天气
  • 名称
  • └ type
  • String
  • 类型
  • └ key
  • String
  • 菜单绑定的key值
  • └ url
  • String
  • 菜单绑定的URL
  • sub_button
  • MenuSubButtonDTO []
  • 子菜单按钮列表
  • └ type
  • String
  • click
  • 类型
  • └ name
  • String
  • 杭州天气
  • 名称
  • └ key
  • String
  • WEATHER_HANGZHOU
  • 菜单绑定的key值
  • └ url
  • String
  • 菜单绑定的URL
  • └ media_id
  • String
  • 素材id
  • └ media_id
  • String
  • 素材id
  • └ enable_input
  • Boolean
  • false
  • 是否允许用户输入
  • └ status
  • Number
  • 0
  • 状态,0-正常,1-停用

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
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());

响应示例

  • JSON示例
{
    "errmsg":"ok",
    "errcode":0,
    "menu":{
        "button":[
            {
                    "name":"天气",
                    "type":"",
                    "key":"",
                    "url":"",
                    "sub_button":[
                        {
                                "type":"click",
                                "name":"杭州天气",
                                "key":"WEATHER_HANGZHOU",
                                "url":"",
                                "media_id":""
                        }
                    ],
                    "media_id":""
            }
        ],
        "enable_input":false,
        "status":0
    }
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部