设备自定义消息开发指南

用户7660

用户8810

2025年8月25日修改

概述

本文档介绍使用探鸽平台发送自定义消息API发送自定义消息。​

重要前提

设备必须保持长连接在线

关键: 自定义消息的发送与响应都依赖设备与平台的长连接，如果设备长连接断开(包括设备处于休眠状态)，那么消息是无法下发到设备的。​

确保设备在线的方法：

发送命令前可先通过平台api查询设备在线状态

2.
如果设备处于休眠状态，需要将设备唤醒​

平台简要流程简要说明

common.docs_name - LarkCCM_Docs_Menu_Image

1. 获取API凭证

联系平台管理员获取（如果已经获取了则用获取的凭证）：

•
app_id: app_id​

•
access_key_id: access_key  ​

•
secret_key_id: secret_key​

所有探鸽平台的api调用都是需要加签的，加签算法详见（可参考demo中generateTangeSignature方法），也可参考​账号接入指南及平台签名DEMO​

2. 注册回调URL获取callback_id

整个消息回调流程，如下图所示(示例中仅以获取wifi信息指令为例说明，开发者可以换成其它指令)​

使用注册回调api（见下面API接口说明）：

代码块

curl -X POST http://openapi-cn01.tange365.com/v2/msg/register-callback \​
  -H "Content-Type: application/json" \​
  -H "x-tg-app-id: 你的app_id" \​
  -H "Authorization: 签名" \​
  -d '{"url": "http://你的服务器/callback"}'​

保存返回的callback_id(也可以通过查询回调接口查询callback_url与callback_id对应情况)。

代码块

CALLBACK_ID = "返回的callback_id"

说明：

1，callback_url与callback_id是一一对应的

2，如果你想要多个不同回调，那么你就得注册多次

API接口

设备自定义消息开发指南​

设备自定义消息开发指南