物联网智能视频服务（消费版）向设备发送在线消息-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（SendOnlineMsg）用于向设备发送在线消息。
注意：
若设备当前不在线,会直接返回错误;
若设备网络出现异常时,消息发送可能超时,超时等待最长时间为3秒.waitresp非0情况下,会导致本接口阻塞3秒。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SendOnlineMsg。
Version	是	String	公共参数，本接口取值：2019-11-26。
Region	是	String	公共参数，详见产品支持的地域列表。
Tid	是	String	设备TID
Wakeup	是	Boolean	如果设备处于休眠状态，是否唤醒设备
WaitResp	是	Integer	等待回应类型 0：不等待设备回应直接响应请求; 1：要求设备确认消息已接收,或等待超时后返回; 2：要求设备进行响应处理,收到设备的响应数据后,将设备响应数据回应给请求方;
MsgTopic	是	String	消息主题
MsgContent	是	String	消息内容，最大长度不超过8k字节

3. 输出参数

参数名称	类型	描述
TaskId	String	若返回此项则表明需要用户用此taskID进行查询请求是否成功(只有waitresp不等于0的情况下才可能会返回该taskID项)
Data	String	设备响应信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 SendOnlineMsg

输入示例

https://iotvideo.tencentcloudapi.com/?Action=SendOnlineMsg
&Tid=031400005e005a3838bd481dbe61db28
&Wakeup=true
&WaitResp=2
&MsgTopic=test
&MsgContent={"test":"test"}
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "af1f328c-5856-4719-b86e-b31420dfc3d6",
        "TaskId": "",
        "Data": "{\"test\":\"test\"}"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.SignatureFailure	签名校验失败。
AuthFailure.TokenFailure	获取token为空。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.PermissionDenied	无相关操作权限。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Tid	tid非法。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
ResourcesSoldOut	资源售罄。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

向设备发送在线消息

本页目录：