chatbot固定菜单配置

1、概述

类似于微信小程序里可点击的菜单,固定菜单、悬浮菜单、建议菜单的区分如图:


固定菜单、悬浮菜单、建议菜单

接口上传固定菜单成功后,可以在web端“企业号管理”-“固定菜单”查看。


固定菜单的查看

固定菜单、悬浮菜单、建议菜单绑定点击事件

2、接口地址

POST https://rcsapi.hanwg.com/chatbot/config/menu/{{chatbotId}}

3、请求参数

3.1、请求路径参数

全局参数

3.2、请求头参数

接口权限校验

3.3、请求体参数

固定菜单有两级,第一级菜单最少1项,最多3项,第二级菜单最少0项,最多5项。


固定菜单数据结构

3.3.1、菜单参数

名称 数据类型 是否必有 描述
menu string 第一级菜单对象
entries array[entry] 第一级菜单项的集合

3.3.2、第一级菜单项entry

第一级菜单项entry有两种类型:上拉项(上拉第二级菜单),动作项(点击事件)。

3.3.2.1、上拉项
名称 数据类型 是否必有 描述
menu string 第二级菜单对象
displayText string 第一级菜单项的名称
entries array[entry] 第二级菜单项的集合
3.3.2.2、动作项

点击事件,动作项的名称是点击事件对象中的字段displayText。

3.3.3、第二级菜单项entry

第二级菜单项entry只有一种:动作项(见点击事件)。

4、请求示例

{
  "menu": {
    "entries": [
      {
        "menu": {
          "displayText": "信息",
          "entries": [
            {
              "action": {
                "dialerAction": {
                  "dialPhoneNumber": {
                    "phoneNumber": "15766666666"
                  }
                },
                "displayText": "拨打电话",
                "postback": {
                  "data": "DHGD_回执操作"
                }
              }
            },
            {
              "action": {
                "displayText": "当前位置",
                "mapAction": {
                  "showLocation": {
                    "location": {
                      "label": "上海",
                      "latitude": 31.235929,
                      "longitude": 121.48054
                    }
                  }
                },
                "postback": {
                  "data": "DHGD_回执操作"
                }
              }
            },
            {
              "action": {
                "calendarAction": {
                  "createCalendarEvent": {
                    "description": "全体公司会议",
                    "endTime": "2023-02-16 08:00:00",
                    "startTime": "2023-02-15 08:00:00",
                    "title": "公司会议"
                  }
                },
                "displayText": "添加日程",
                "postback": {
                  "data": "DHGD_回执操作"
                }
              }
            }
          ]
        }
      },
      {
        "menu": {
          "displayText": "链接",
          "entries": [
            {
              "reply": {
                "displayText": "打开官网",
                "postback": {
                  "data": "DHGD_回执操作"
                }
              }
            }
          ]
        }
      },
      {
        "reply": {
          "displayText": "关注",
          "postback": {
            "data": "DHGD_回执操作"
          }
        }
      }
    ]
  }
}

5、响应参数

名称 数据类型 是否必有 描述
code int 响应状态码
desc string 请求响应描述
result bool 处理结果

6、响应示例

{
    "code": 0,
    "desc": "请求成功",
    "result": true
}
文档更新时间: 2025-12-17 09:34   作者:王超