发布消息

最近更新时间:2019-07-24 15:21:29

1. 接口描述

接口请求域名: iotcloud.tencentcloudapi.com 。

本接口(PublishMessage)用于向某个主题发消息。

默认接口请求频率限制:100次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PublishMessage
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
Topic String 消息发往的主题。命名规则:${ProductId}/${DeviceName}/[a-zA-Z0-9:_-]{1,128}
Payload String 消息内容
ProductId String 产品ID
DeviceName String 设备名称
Qos Integer 服务质量等级,取值为0或1

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发布消息

输入示例

https://iotcloud.tencentcloudapi.com/?Action=PublishMessage
&Topic=ABCDE12345/test_device/data
&Payload=hahaha
&ProductId=ABCDE12345
&DeviceName=test_device
&Qos=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "be69a7a3-7315-40a7-9532-3316e4a3e97e"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InvalidMsgLen 消息长度非法。
FailedOperation.InvalidTopicName 消息topic非法。
InternalError 内部错误
InvalidParameterValue 参数取值错误
LimitExceeded.OfflineMessageExceedLimit qos为1的离线消息超过数量限制。
ResourceNotFound.ProductOrDeviceNotExist 用户不存在此产品或设备。