QueryRcsSignMenuByVersion - 指定版本查看5G消息固定菜单详情

更新时间:
复制 MD 格式

指定版本查看5G消息固定菜单详情。

接口说明

前提条件

已通过 UpgradeToRCSSignature 接口将文本短信签名升级为 5G 消息签名,并已通过 AddRcsSignMenu 接口创建固定菜单。

使用说明

仅支持查询最近一次提交的版本,以及处于部分生效或全部生效的版本。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用将会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:QueryRcsSignMenuByVersion

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SignName

string

是

短信签名名称。

阿里云

RcsMenuVersion

string

是

菜单版本。

说明

仅支持查询最近一次提交的版本,以及处于部分生效/全部生效的版本。

RCS_MENU_123410123

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝时返回的详细信息。

None

RequestId

string

本次请求的 ID。

A90E4451-FED7-49D2-87C8-00700A8C4D0D

Message

string

状态码的描述。

OK

Data

object

返回数据,包含MenuContent(菜单内容,JSON 格式)。

{ "MenuContent": "{\n \"menu\": {\n \"entries\": [\n {\n \"reply\": {\n \"displayText\": \"业务咨询\",\n \"postback\": { \"data\": \"e1f2a3b4-c5d6-7890-ef12-345678901234\" }\n }\n },\n {\n \"menu\": {\n \"displayText\": \"更多服务\",\n \"entries\": [\n {\n \"reply\": {\n \"displayText\": \"套餐查询\",\n \"postback\": { \"data\": \"f2a3b4c5-d6e7-8901-f234-567890123456\" }\n }\n }\n ]\n }\n }\n ]\n }\n}" }

Code

string

请求状态码。返回 OK 代表请求成功。

OK

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

MenuContent 返回结构说明

返回的 MenuContent 为 JSON 格式的固定菜单内容,结构与创建时提交的内容一致。菜单最多支持两级嵌套,一级菜单最多 3 项,二级菜单最多 5 项,每一项为 reply 建议回复、action 建议操作或子菜单 menu。完整说明,请参见 AddRcsSignMenu 接口的 MenuContent 固定菜单语法说明 。

返回示例

{
  "Code": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Success": true,
  "Data": {
    "MenuContent": "{\n  \"menu\": {\n    \"entries\": [\n      {\n        \"reply\": {\n          \"displayText\": \"业务咨询\",\n          \"postback\": { \"data\": \"e1f2a3b4-c5d6-7890-ef12-345678901234\" }\n        }\n      },\n      {\n        \"menu\": {\n          \"displayText\": \"更多服务\",\n          \"entries\": [\n            {\n              \"reply\": {\n                \"displayText\": \"套餐查询\",\n                \"postback\": { \"data\": \"f2a3b4c5-d6e7-8901-f234-567890123456\" }\n              }\n            }\n          ]\n        }\n      }\n    ]\n  }\n}"
  }
}

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Data": {
    "MenuContent": "{\n  \"menu\": {\n    \"entries\": [\n      {\n        \"reply\": {\n          \"displayText\": \"业务咨询\",\n          \"postback\": { \"data\": \"e1f2a3b4-c5d6-7890-ef12-345678901234\" }\n        }\n      },\n      {\n        \"menu\": {\n          \"displayText\": \"更多服务\",\n          \"entries\": [\n            {\n              \"reply\": {\n                \"displayText\": \"套餐查询\",\n                \"postback\": { \"data\": \"f2a3b4c5-d6e7-8901-f234-567890123456\" }\n              }\n            }\n          ]\n        }\n      }\n    ]\n  }\n}"
  },
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。