帮你快速理解、总结文档立即下载
文档中心>API 中心>消息队列 MQTT 版>客户端相关接口>查询客户端遗嘱消息

查询客户端遗嘱消息

最近更新时间：2026-07-29 02:44:21

我的收藏

本页目录：

1. 接口描述

接口请求域名： mqtt.tencentcloudapi.com 。

遗嘱消息查询

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeWillMessage。
Version 是 String 公共参数，本接口取值：2024-05-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String

实例ID，从 DescribeInstanceList接口或控制台获得。


示例值：mqtt-xxxx
ClientId 是 String

客户端id


示例值：client-1

3. 输出参数

参数名称 类型 描述
Topic String

保留消息Topic


示例值：home/room
Qos Integer

消息服务质量


示例值：1
Retained Boolean

是否保留消息


示例值：false
Payload String

消息负载(Base64编码)


示例值：this is payload
CreateTime Integer

创建时间，毫秒级时间戳 。


示例值：1713164969433
UpdateTime Integer

更新时间，毫秒级时间戳 。


示例值：1713164969433
WillDelayInterval Integer

遗嘱消息延迟时间，单位秒


示例值：10
ContentType String

响应内容类型


示例值：application/json
ResponseTopic String

响应主题


示例值：home/room
CorrelationData String

关联数据（Base64编码）


示例值：data
MessageExpiryInterval Integer

消息过期时间，单位秒


示例值：10
PayloadFormatIndicator Integer

负载格式指示器 1:UTF-8文本


示例值：1
UserProperties Array of UserProperty

用户属性
PublishAfter Integer

遗嘱消息发布时间


示例值：1784219154574
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 客户端没有遗嘱消息

当前查询的客户端没有遗嘱消息

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWillMessage
<公共请求参数>

{
    "InstanceId": "mqtt-mwe5jvvr",
    "ClientId": "client1"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "f7ab1f26-b6d6-4a75-9909-36fad448e3c3"
    }
}

示例2 示例

示例

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWillMessage
<公共请求参数>

{
    "InstanceId": "mqtt-mwe5jvvr",
    "ClientId": "test_device_custom_791394"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "ContentType": "application/json",
        "CorrelationData": "MTIz",
        "CreateTime": 1764918589000,
        "MessageExpiryInterval": 100,
        "Payload": "dGhpcyBpcyB3aWxsIG1lc3NhZ2U=",
        "PayloadFormatIndicator": 1,
        "Qos": 1,
        "RequestId": "30aa2d8e-433b-441b-8350-9d06d72eafdc",
        "ResponseTopic": "/home/resp/1",
        "Retained": true,
        "Topic": "home/will",
        "UpdateTime": 1764918589720,
        "WillDelayInterval": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.InstanceNotReady FailedOperation.InstanceNotReady
ResourceNotFound 资源不存在。
中国站