Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发
智慧硬件开发第三方应用开发
企业内部开发
智慧硬件开发第三方应用开发
  1. 自定义菜单
  • 快速入门
    • 概述
  • 开发指南
    • 获取access_token
      GET
  • 通讯录管理
    • 成员管理
      • 获取加入企业二维码
      • 获取企业活跃成员数
    • 互联企业
      • 获取应用的可见范围
      • 获取互联企业成员详细信息
      • 获取互联企业部门成员
      • 获取互联企业部门成员详情
      • 获取互联企业部门列表
  • 客户联系
    • 客户管理
      • 客户联系规则组管理
        • 客户联系规则组管理-获取规则组列表
        • 客户联系规则组管理-获取规则组详情
        • 客户联系规则组管理-获取规则组管理范围
        • 客户联系规则组管理-创建新的规则组
        • 客户联系规则组管理-编辑规则组及其管理范围
        • 客户联系规则组管理-删除规则组
    • 客户标签管理
      • 管理企业规则组下的客户标签
        • 管理企业规则组下的客户标签-获取指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-为指定规则组创建企业客户标签
        • 管理企业规则组下的客户标签-编辑指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-删除指定规则组下的企业客户标签
    • 联系我与客户入群方式
      • 客户联系「联系我」管理
        • 更新企业已配置的「联系我」方式
        • 删除企业已配置的「联系我」方式
      • 客户群「加入群聊」管理
        • 配置客户群进群方式
        • 获取客户群进群方式配置
        • 更新客户群进群方式配置
        • 删除客户群进群方式配置
    • 客户朋友圈
      • 客户朋友圈规则组管理
        • 客户朋友圈规则组管理-获取规则组列表
        • 客户朋友圈规则组管理-获取规则组详情
        • 客户朋友圈规则组管理-获取规则组管理范围
        • 客户朋友圈规则组管理-创建新的规则组
        • 客户朋友圈规则组管理-编辑规则组及其管理范围
        • 客户朋友圈规则组管理-删除规则组
  • 微信客服
    • 接待人员管理
      • 添加接待人员_v1
  • 家校沟通
    • 网页授权登录
      • 获取访问用户身份-企业内部开发
  • 应用管理
    • 自定义菜单
      • 创建菜单
        POST
      • 获取菜单
        GET
      • 删除菜单
        GET
    • 设置应用
      POST
  • 消息推送
    • 发送消息到群聊会话
      • 创建群聊会话
      • 修改群聊会话
      • 获取群聊会话
      • 应用推送消息
    • 互联企业消息推送
      • 发送应用消息
  • OA
    • 打卡
      • 获取企业所有打卡规则
      • 录入打卡人员人脸信息
    • 审批
      • 获取审批数据(旧)
    • 汇报
      • 批量获取汇报记录单号
      • 获取汇报记录详情
      • 获取汇报统计数据
    • 会议室
      • 会议室管理-添加会议室
      • 会议室管理-查询会议室
      • 会议室管理-编辑会议室
      • 会议室管理-删除会议室
      • 会议室预定管理 查询会议室的预定信息
      • 会议室预定管理 预定会议室
      • 会议室预定管理 取消预定会议室
    • 紧急通知应用
      • 发起语音电话
      • 获取接听状态
  • 效率工具
    • 微盘
      • 空间管理 新建空间
      • 空间管理 重命名空间
      • 空间管理 解散空间
      • 空间管理 获取空间信息
      • 空间权限 添加成员/部门
      • 空间权限 移除成员/部门
      • 空间权限 权限管理
      • 空间权限 获取邀请链接
      • 文件管理 获取文件列表
      • 文件管理 上传文件
      • 文件管理 下载文件
      • 文件管理 新建文件/微文档
      • 文件管理 重命名文件
      • 文件管理 移动文件
      • 文件管理 删除文件
      • 文件管理 文件信息
      • 文件权限 新增指定人
      • 文件权限 删除指定人
      • 文件权限 分享设置
      • 文件权限 获取分享链接
    • 公费电话
      • 获取公费电话拨打记录
  • 企业支付
    • 企业红包
      • 发放企业红包
      • 查询红包记录
    • 向员工付款
      • 向员工付款
      • 查询付款记录
    • 对外收款
      • 收款商户号管理 新增商户号
      • 收款商户号管理 查询商户号详情
      • 收款商户号管理 删除商户号
      • 收款商户号管理 设置商户号使用范围
  • 上下游
    • 获取上下游信息
      • 获取上下游列表
      • 获取上下游通讯录分组
      • 获取企业上下游通讯录分组下的企业详情列表
    • 获取下级/下游企业的access_token
    • 获取下级/下游企业小程序session
    • 上下游企业应用获取微信用户的external_userid
  • 会话内容存档
    • 获取会话内容
      • 获取会话内容 获取机器人信息
    • 获取会话内容存档开启成员列表
    • 获取会话同意情况 群聊请求
    • 获取会话同意情况 单聊请求
    • 获取会话内容存档内部群信息
  • 家校应用
    • 健康上报
      • 获取健康上报使用统计
      • 获取健康上报任务ID列表
      • 获取健康上报任务详情
      • 获取用户填写答案
    • 复学码
      • 获取老师健康信息
      • 获取学生健康信息
      • 获取师生健康码
  • 政民沟通
    • 配置网格结构
      • 添加网格
      • 编辑网格
      • 删除网格
      • 获取网格列表
      • 获取用户负责及参与的网格列表
    • 配置事件类别
      • 添加事件类别
      • 修改事件类别
      • 删除事件类别
      • 获取事件类别列表
    • 巡查上报
      • 获取配置的网格及网格负责人
      • 获取单位巡查上报数据统计
      • 获取个人巡查上报数据统计
      • 获取上报事件分类统计
      • 获取巡查上报事件列表
      • 获取巡查上报的事件详情信息
    • 居民上报
      • 获取配置的网格及网格负责人
      • 获取单位居民上报数据统计
      • 获取个人居民上报数据统计
      • 获取上报事件分类统计
      • 获取居民上报事件列表
      • 获取居民上报的事件详情信息
  1. 自定义菜单

创建菜单

POST
http://127.0.0.1/cgi-bin/menu/create
企业内部开发/应用管理/自定义菜单
最后修改时间:2022-08-30 03:03:35
责任人:未设置
示例:构造click和view类型的请求包如下
{
   "button":[
       {    
           "type":"click",
           "name":"今日歌曲",
           "key":"V1001_TODAY_MUSIC"
       },
       {
           "name":"菜单",
           "sub_button":[
               {
                   "type":"view",
                   "name":"搜索",
                   "url":"http://www.soso.com/"
               },
               {
                   "type":"click",
                   "name":"赞一下我们",
                   "key":"V1001_GOOD"
               }
           ]
      }
   ]
}
示例:其他新增按钮类型的请求
{
    "button": [
        {
            "name": "扫码", 
            "sub_button": [
                {
                    "type": "scancode_waitmsg", 
                    "name": "扫码带提示", 
                    "key": "rselfmenu_0_0", 
                    "sub_button": [ ]
                }, 
                {
                    "type": "scancode_push", 
                    "name": "扫码推事件", 
                    "key": "rselfmenu_0_1", 
                    "sub_button": [ ]
                },
                {
                    "type":"view_miniprogram",
                    "name":"小程序",
                    "pagepath":"pages/lunar/index",
                    "appid":"wx4389ji4kAAA"
                }
            ]
        }, 
        {
            "name": "发图", 
            "sub_button": [
                {
                    "type": "pic_sysphoto", 
                    "name": "系统拍照发图", 
                    "key": "rselfmenu_1_0", 
                   "sub_button": [ ]
                 }, 
                {
                    "type": "pic_photo_or_album", 
                    "name": "拍照或者相册发图", 
                    "key": "rselfmenu_1_1", 
                    "sub_button": [ ]
                }, 
                {
                    "type": "pic_weixin", 
                    "name": "微信相册发图", 
                    "key": "rselfmenu_1_2", 
                    "sub_button": [ ]
                }
            ]
        }, 
        {
            "name": "发送位置", 
            "type": "location_select", 
            "key": "rselfmenu_2_0"
        }
    ]
}
参数说明:
参数必须说明
access_token是调用接口凭证
agentid是企业应用的id,整型。可在应用的设置页面查看
button是一级菜单数组,个数应为1~3个
sub_button否二级菜单数组,个数应为1~5个
type是菜单的响应动作类型
name是菜单的名字。不能为空,主菜单不能超过16字节,子菜单不能超过40字节。
keyclick等点击类型必须菜单KEY值,用于消息接口推送,不超过128字节
urlview类型必须网页链接,成员点击菜单可打开链接,不超过1024字节。为了提高安全性,建议使用https的url
pagepathview_miniprogram类型必须小程序的页面路径
appidview_miniprogram类型必须小程序的appid(仅与企业绑定的小程序可配置)
权限说明 :
仅企业可调用;第三方不可调用。

请求参数

Query 参数
access_token
string 
调用接口凭证
可选
示例值:
{{accesstoken}}
agentid
string 
可选
企业应用的id,整型。可在应用的设置页面查看
示例值:
{{agentid}}
Body 参数application/json
button
array [object {4}] 
必需
一级菜单数组,个数应为1~3个
type
string 
菜单的响应动作类型
可选
name
string 
必需
菜单的名字。不能为空,主菜单不能超过16字节,子菜单不能超过40字节。
key
string 
可选
click等点击类型必须,菜单KEY值,用于消息接口推送,不超过128字节
sub_button
array [object {4}] 
可选
二级菜单数组,个数应为1~5个
示例
{
  "button": [
    {
      "type": "click",
      "name": "今日歌曲",
      "key": "V1001_TODAY_MUSIC"
    },
    {
      "name": "菜单",
      "sub_button": [
        {
          "type": "view",
          "name": "搜索",
          "url": "http://www.soso.com/"
        },
        {
          "type": "click",
          "name": "赞一下我们",
          "key": "V1001_GOOD"
        }
      ]
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/cgi-bin/menu/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "button": [
        {
            "type": "click",
            "name": "今日歌曲",
            "key": "V1001_TODAY_MUSIC"
        },
        {
            "name": "菜单",
            "sub_button": [
                {
                    "type": "view",
                    "name": "搜索",
                    "url": "http://www.soso.com/"
                },
                {
                    "type": "click",
                    "name": "赞一下我们",
                    "key": "V1001_GOOD"
                }
            ]
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
errcode
integer <int32>
可选
errmsg
string 
可选
示例
{
  "errcode": 0,
  "errmsg": "ok"
}
上一页
获取访问用户身份-企业内部开发
下一页
获取菜单
Built with