服务号菜单更新
更新于 2023-01-18调用本接口更新服务号的会话菜单。
例如,服务号配置了“菜单1”、“菜单2”,将“菜单2”名称更新为“更新菜单”,调用效果如下图所示。接口可更新的菜单信息,可详细查看本接口参数说明。

权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
企业内部应用 | 是 | 企业内部服务号菜单权限 | |
第三方企业应用 | 否 | — | — |
第三方个人应用 | 否 | — | — |
基本信息
请求方式:POST
请求地址:https://oapi.dingtalk.com/topapi/serviceaccount/menu/update
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
access_token | String | 是 | 30c9a84136943eaxxxx | 调用该接口的应用凭证。
|
Body参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
unionid | String | 是 | jYdrJoCmTo0iE | 服务号的unionid,可通过查询服务号列表接口获取。 |
menu | MenuConfigDTO | 否 | 菜单。 | |
button | MenuButtonDTO[] | 否 | 菜单按钮列表。 | |
name | String | 是 | 今日天气 | 菜单名称。 |
type | String | 否 | view | 菜单类型,如果是 一级菜单则不填,代表这是一个父菜单:
|
key | String | 否 | KEY_WEATHER | 菜单绑定的key值,用于点击菜单拉取自定义消息的场景。 |
url | String | 否 | https://www.taobao.com | 菜单绑定的URL,用于链接跳转。 |
media_id | String | 否 | mvFiiRhuwt5IiE | 素材id,用于拉取站内消息的场景。 说明 如果菜单类型为media_id或view_article类型,则该字符为必填项。 |
sub_button | MenuSubButtonDTO[] | 否 | 子菜单按钮列表。 | |
name | String | 是 | 杭州天气 | 按钮名称。 |
type | String | 是 | click | 按钮类型:
其中media_id类型会在内部转化为click类型,view_article类型会在内部转化为view类型。 |
key | String | 否 | WEATHER_HANGZHOU | 子菜单绑定的key值。 |
url | String | 否 | https://www.taobao.com | 子菜单绑定的URL。 |
media_id | String | 否 | mvFiiRhuwt5IiE | 子菜单素材id。 说明 如果子菜单类型为media_id或view_article类型,则该参数为必填项。 |
enable_input | Boolean | 是 | false | 是否允许用户输入:
|
status | Number | 是 | 0 | 状态:
|
返回参数
名称 | 类型 | 示例值 | 描述 |
errmsg | String | ok | 返回码描述。 |
errcode | Number | 0 | 返回码。 |
request_id | String | 5c4hvemrzn9u | 请求ID。 |
示例
请求示例(HTTP)
请求正文
请求示例(JAVA SDK)
返回示例