服务号菜单更新

POST

http://127.0.0.1/topapi/serviceaccount/menu/update

服务端API/专属钉钉/互动服务窗/菜单管理

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口更新服务号的会话菜单。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。

示例值:

30c9a84136943eaxxxx

Body 参数application/json

unionid

string

必需

服务号的unionid，可以通过查询服务号列表接口获取。

object

菜单。

可选

button

array [object {6}]

菜单按钮列表。

可选

enable_input

boolean

必需

是否允许用户输入：true：允许false：不允许

status

number

必需

状态：0：正常1：停用

示例

{
  "unionid": "IlrIsTHaiSYXluZP61h0zxgiEiE",
  "menu": {
    "button": [
      {
        "key": "KEY_WEATHER",
        "media_id": "mvFiiRhuwt5IiE",
        "name": "今日天气",
        "sub_button": [
          {
            "key": "WEATHER_HANGZHOU",
            "media_id": "mvFiiRhuwt5IiE",
            "name": "杭州天气",
            "type": "click",
            "url": "https://www.taobao.com"
          }
        ],
        "type": "view",
        "url": "https://www.taobao.com"
      }
    ],
    "enable_input": false,
    "status": 0
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/serviceaccount/menu/update?access_token=30c9a84136943eaxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "unionid": "IlrIsTHaiSYXluZP61h0zxgiEiE",
    "menu": {
        "button": [
            {
                "key": "KEY_WEATHER",
                "media_id": "mvFiiRhuwt5IiE",
                "name": "今日天气",
                "sub_button": [
                    {
                        "key": "WEATHER_HANGZHOU",
                        "media_id": "mvFiiRhuwt5IiE",
                        "name": "杭州天气",
                        "type": "click",
                        "url": "https://www.taobao.com"
                    }
                ],
                "type": "view",
                "url": "https://www.taobao.com"
            }
        ],
        "enable_input": false,
        "status": 0
    }
}'

返回响应

🟢200成功

application/json

Body

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

string

请求ID。

可选

示例

{
  "errmsg": "string",
  "errcode": 0,
  "": "string"
}

修改于 2022-08-30 09:19:24

消息群发

查询服务号菜单

服务号菜单更新

说明#

权限#

请求参数

示例代码

返回响应

说明

权限