消息队列 MQTT 版发布 MQTT 消息-集群相关接口-API 中心-腾讯云

1. 接口描述

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

发布 MQTT 消息到消息主题或客户端

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：PublishMessage。
Version	是	String	公共参数，本接口取值：2024-05-16。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：rocketmq-xxxx
Payload	是	String	消息 payload，需要按 encoding 指定的编码方式进行编码示例值：Hello MQTT!
TargetTopic	否	String	消息目的主题，该参数与 TargetClientId 二选一示例值：test/a/b
TargetClientId	否	String	消息目的客户端 ID，该参数与 TargetTopic 二选一示例值：myclient0001
Encoding	否	String	消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）示例值：plain
Qos	否	Integer	消息的服务质量等级，默认为 1 示例值：1
Retain	否	Boolean	是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true 示例值：false

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发布消息到主题

输入示例

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

{
    "InstanceId": "mqtt-xxx",
    "TargetTopic": "test/a/b",
    "Payload": "Hello MQTT!",
    "Encoding": "plain",
    "Qos": 1,
    "Retain": false
}

输出示例

{
    "Response": {
        "RequestId": "416510a6-f614-487d-bbca-e7fdbf72fc29"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

发布 MQTT 消息

本页目录：