选择应用类型
企业内部应用开发

服务号菜单更新

更新于 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

菜单类型,如果是 一级菜单则不填,代表这是一个父菜单:

  • click:拉取自定义消息

  • view:跳转链接

  • media_id:拉取站内消息,包括消息卡片和图片

    说明

    配合media_id字段使用,填写卡片id或图片id。

  • view_article:跳转站内文章

    说明

    配合media_id字段使用,填写为相应的文章id。

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

按钮类型:

  • click:拉取自定义消息

  • view:跳转链接

  • media_id:拉取站内消息,包括消息卡片和图片

    说明

    配合media_id字段使用,填写卡片id或图片id。

  • view_article:跳转站内文章

    说明

    配合media_id字段使用,填写为相应的文章id。

其中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

是否允许用户输入:

  • true:允许

  • false:不允许

status

Number

0

状态:

  • 0:正常

  • 1:停用

返回参数

名称

类型

示例值

描述

errmsg

String

ok

返回码描述。

errcode

Number

0

返回码。

request_id

String

5c4hvemrzn9u

请求ID。

示例

请求示例(HTTP)

Loading...

请求正文

Loading...

请求示例(JAVA SDK)

Loading...

返回示例

Loading...
这篇文档是否有帮助?
点击纠错