探鸽开放平台API文档
  1. 消息模块
探鸽开放平台API文档
  • 服务器API文档
    • 开放API V2
      • API For Server
        • 账户模块
          • 开发者内部 UserID登录
          • 注销账号
          • 查询用户基础信息
          • 查询用户登录信息
          • 批量查询用户Id
        • 增值服务
          • 查询套餐列表
          • 查询套餐详情
          • 查询设备开通的套餐列表
          • 提前生效套餐
          • 套餐升级/降级
          • 转移套餐
          • 清空设备的增值服务
          • 清空物联网卡的增值服务
          • 更新已开通服务的能力
          • 查询套餐转移历史记录
          • 查询增值服务产品
          • 重置设备的增值服务
          • 查询物联网卡开通的套餐
          • 对已通开套餐的生效顺序排序
        • 订单模块
          • 购买套餐(创建并完成订单)
          • 创建订单
          • 完成订单
          • 取消已完成的订单
          • 查询订单列表
          • 查询订单状态
          • 查询订单流水
        • 支付模块
          • 申请退款
          • 保存字典
        • 低功耗设备
          • 唤醒低功耗设备
        • 设备模块
          • 查询设备信息
          • 查询设备封面
          • 查询设备在线信息
          • 查询设备连接信息
          • 查询设备所有绑定关系
          • 查询设备的用户列表
          • 查询用户的设备列表
          • 查询设备产品信息
          • 查询设备产品信息 (废弃)
          • 查询设备联网卡号信息
          • 查询设备在线信息
          • 查询设备产品
          • 查询卡关联所有设备信息
          • 添加海外绑卡设备
          • 查询海外添加绑卡设备
          • 删除设备
        • 消息模块
          • 向设备发送预定义指令
            POST
          • 向设备发送消息
            POST
          • 向APP发送消息
            POST
          • 向设备发送消息-订阅消息回调通知
            POST
          • 向设备发送消息 - 取消订阅消息通知
            DELETE
          • 向设备发送指令 - 查询已订阅的消息通知
            GET
        • 推送模块
          • 向用户APP推送
          • 批量向用户APP推送
        • sim卡模块
          • 查询SIM卡信息
          • 查询SIM卡状态
          • 停用SIM卡(异步)
          • 恢复SIM卡(异步)
          • 查询SIM卡日用量
          • 查询套餐内4G卡流量使用情况
          • 查询SIM卡状态(废弃)
          • 停用SIM卡(异步)(废弃)
          • 恢复SIM卡(异步)(废弃)
          • 查询SIM卡日用量(废弃)
          • 查询4G卡基本信息
          • 查询4G是否锁定
          • 4G卡解锁
        • 呼叫微信小程序
          • 查询设备已授权呼叫微信小程序的用户列表
          • 微信呼叫事件通知回调
          • 查询用户已授权呼叫微信小程序的设备列表
        • 转移设备模块
          • 向UserID 转移设备
          • 向账号转移设备
          • 向开发者内部UserID 转移设备
        • 数据统计
          • 查询设备电量历史记录
          • 查询设备网络信号强度历史记录
          • 查询告警事件统计
          • 查询SD卡上报记录
          • 查询设备上下线历史记录
        • 配置模块
          • 开发者的应用配置
        • 云资源模块
          • 上报设备告警事件
          • 查询设备日志
          • 查询设备某天的云事件
          • 查询设备某天的云录像
          • 查询设备某天的云录像丢失记录
          • 统计设备云录像的录像文件
          • 查询设备应用日志
        • AI应用
          • 修改设备AI摘要配置
          • 修改设备AI检索配置
        • 物模型
          • 查询设备物模型
          • 删除设备物模型属性
          • 更新物模型
      • API For Client
        • 访问授权
          • 查询登录令牌信息
        • 账户模块
          • 注册账号
          • 绑定已有账号
          • 绑定新账号
          • 查询已绑定的第三方登录账号列表
          • 取消第三方登录
          • 登录账号
          • 验证码登录
          • 修改密码
          • 重置密码
          • 修改昵称
          • 查询账号详情
          • 苹果登录
          • Facebook登录
          • Google登录
          • LINE登录
          • 微信登录
          • 微信小程序登录
          • 注销账号
          • 退出登录
          • 刷新登录令牌
          • 一键认证注册
          • 一键重置密码
        • 配置模块
          • 开发者的自定义配置
          • 查询开发者支持的超级能力集合
          • 开发者的应用配置
        • 设备模块
          • 预添加设备
          • 添加设备
          • 查询设备列表
          • 查询设备时区
          • 设置设备时区
          • 查询设备封面
          • 查询设备连接信息
          • 修改设备名称
          • 解除绑定
          • 查询设备在线状态
          • 查询预添加设备结果
          • 门锁开锁.预授权
          • 门锁.设置开锁密码
          • 查询设备基础信息
          • 查询设备物联网卡号
          • 查询设备视频密码
          • 查询设备是否可升级
          • 发送设备固件升级指令
          • 查询设备固件升级结果
          • 查询设备固件版本升级结果
          • 签发设备令牌
        • 录像、事件模块
          • 查询云录像
          • 查询云事件
          • 按ID查询云事件
          • 按ID删除云事件
          • 按时间删除云事件
          • 查询事件推送开关
          • 更新事件推送开关
          • 查询事件标签列表
          • 查询设备截图
          • 获取设备的OSS访问令牌
          • 查询设备某天的云录像
          • 查询设备某天的云事件
          • 查询单台设备N天的云事件
          • 查询云事件摘要
        • 消息模块
          • 向设备发送预定义指令
          • 获取验证码
          • 校验验证码
          • APP向设备发送消息
        • 推送模块
          • 上报手机推送ID
        • WebRTC代理
          • 获取webRTC服务器的SDP
          • 获取打洞服务器的地址
        • 统计模块
          • 查询设备SD卡信息
          • 查询设备电量
          • 查询设备时间区间内的电量记录
          • 查询设备电量记录
          • 查询设备SD 卡使用记录
          • 上报云录像下载记录
        • 分享设备模块
          • 主人.向指定账号分享设备
          • 主人.取消分享
          • 主人.查询分享列表
          • 主人.获取分享码
          • 查询分享码信息
          • 客人.使用分享码
          • 客人.退出分享
          • 客人.申请共享设备
          • 主人.拒绝共享设备
          • 主人.同意共享设备
          • 主人.向指定用户ID分享设备
          • 主人.向指定用户ID分享设备
        • 增值服务-套餐
          • 查询服务商的套餐列表
          • 查询已购买服务
          • 查询指定订单的套餐
          • 提前生效套餐
        • 增值服务-订单
          • demo服务API
            • 小程序查询套餐的支付方式
            • 获取小程序支付跳转参数
            • 微信小程序code换openid
            • 获取支付小程序服务端token
          • 生成套餐订单
          • 拉取订单列表
          • 查询订单信息
          • 查询简要订单信息
          • 查询兑换码
          • 使用兑换码
        • 支付模块
          • 申请支付
          • 查询支付结果
          • 查询字典
          • 申请解约
        • AI识别
          • 图片识别
        • 广告模块
          • 获取广告配置
        • 呼叫微信小程序
          • 查询已授权呼叫微信小程序的设备列表
          • 授权微信小程序呼叫设备
          • 获取设备票据
          • 查询设备是否支持呼叫小程序
          • 微信小程序创建房间
        • SIM卡模块
          • 查询SIM卡信息
        • 物模型
          • 查询设备物模型
          • 更新物模型
          • 删除设备物模型属性
        • AI应用
          • AI事件检索
      • API For DeviceToken
        • 设备模块
          • 查询设备连接信息
      • 基础服务调度接口
        POST
  1. 消息模块

向设备发送预定义指令

将废弃
POST
/v2/msg/server/directive/device/{device_id}
设备上报日志,传参:{"directive": "log"}
设备上传封面图,传参:{"directive":"save_video","data":{"res":"low"}}
启用/禁用设备事件,传参:{"direcitive":"event_control","data":{"action":"enable/disable","event_set":["body"]}
发送 base64指令,传参:{"directive": "p2pcmd/base64","data":{}}

请求参数

Path 参数
device_id
string 
必需
Header 参数
X-Tg-App-Id
string 
必需
开发者帐号的APPID
默认值:
{{app-id}}
Accept-Language
string 
必需
请求端的本地语言(zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar)
默认值:
{{language}}
示例值:
zh-cnzh-twen-usjakoviesptrutrdeitfrplthar
Authorization
string 
必需
服务端接口时传入签名计算后的字符串。客户端APP传入用户登陆态数据access_token。两者不要混用。
默认值:
{{access_token}}
X-Tg-Signed-Headers
string 
必需
参与计算签名的header字段。POST等请求传入content-length;content-type;x-tg-app-id;x-tg-date,GET请求传入x-tg-app-id;x-tg-date
默认值:
x-tg-app-id;x-tg-date
示例值:
content-length;content-type;x-tg-app-id;x-tg-date
X-Tg-Date
string 
必需
当前请求的UTC+0时间(注意时区,不是本地时区)
默认值:
20060102T150405Z
X-Tg-Content-Sha256
string 
必需
将BODY数据进行SHA256计算后的值
X-Tg-Algorithm
string 
必需
目前服务端接口使用的签名算法的版本号和哈希算法
默认值:
TGV1-HMAC-SHA256
Content-Type
string 
必需
默认值:
application/json
Content-Length
string 
必需
Body的字符串长度
Body 参数application/json
directive
string 
指令名称
必需
data
string 
指令内容
必需
示例
{
    "directive": "string",
    "data": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/msg/server/directive/device/' \
--header 'X-Tg-App-Id;' \
--header 'Accept-Language;' \
--header 'Authorization;' \
--header 'X-Tg-Signed-Headers;' \
--header 'X-Tg-Date;' \
--header 'X-Tg-Content-Sha256;' \
--header 'X-Tg-Algorithm;' \
--header 'Content-Length;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "directive": "string",
    "data": "string"
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
🟠400错误
🟠401请登录
🟠403禁止访问
🟠404资源不存在
🔴500服务器内部错误
修改于 2025-05-23 08:41:57
上一页
删除设备
下一页
向设备发送消息
Built with