文档中心 > API类目 > 钉钉API

dingtalk.iotevent.push (IOT数据上报接口)

IOT报警数据的上送接口

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
event	PushEventRequest	必须			请求的对象
└ iot_id String 必须 ipc123 设备标识符 event_param Eventparam 可选事件的扩展参数 └ img_url String 可选 www.taobao.com 截图地址 └ iot_instance_id String 可选 Q7uOhVRdZRRlDnTLv****00100 设备所属实例id，仅企业版实例需要传入 └ event_status Number 必须 0 0:事件持续中，1:正常解决导致结束，2:误判导致结束 └ occurrence_time Number 必须 123456789 事件触发时间 └ platform String 必须 ALIYUN_IOT 设备所属平台 └ aliyun_pk String 可选 123456789 阿里云用户标识 └ alarm_id String 必须 test121212 告警id └ algorithm_name String 必须 regionalInvasion 告警算法类型名称 └ algorithm_id Number 可选 11001 告警算法类型id └ pic_id String 可选 YTlhZkZoaXFrSWFyMkxaYTNqdzdfSDh4YzJQYkhOUHh1SUdxa2hRWGMycy9kYzM4OWUyM2NiMDU0OTMwOGIyOGM0YzA2Y2E0M2E5MV8xNjE3Nzc4ODM0NTY2 图片id └ tenant_id String 可选 test001 阿里云租户id

响应参数

名称	类型	示例值	描述
error_ctx	Json	{"imgUrl":"missing"}"}	错误扩展消息
content	PushEventResponse		业务结果对象
└ event_id String abc123456 和入参的事件id对应
error_level	String	info	错误级别

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
DingtalkIoteventPushRequest req = new DingtalkIoteventPushRequest();
DingtalkIoteventPushRequest.PushEventRequest obj1 = new DingtalkIoteventPushRequest.PushEventRequest();
obj1.setIotId("ipc123");
DingtalkIoteventPushRequest.Eventparam obj2 = new DingtalkIoteventPushRequest.Eventparam();
obj2.setImgUrl("www.taobao.com");
obj1.setEventParam(obj2);
obj1.setIotInstanceId("Q7uOhVRdZRRlDnTLv****00100");
obj1.setEventStatus(0L);
obj1.setOccurrenceTime(123456789L);
obj1.setPlatform("ALIYUN_IOT");
obj1.setAliyunPk("123456789");
obj1.setAlarmId("test121212");
obj1.setAlgorithmName("regionalInvasion");
obj1.setAlgorithmId(11001L);
obj1.setPicId("YTlhZkZoaXFrSWFyMkxaYTNqdzdfSDh4YzJQYkhOUHh1SUdxa2hRWGMycy9kYzM4OWUyM2NiMDU0OTMwOGIyOGM0YzA2Y2E0M2E5MV8xNjE3Nzc4ODM0NTY2");
obj1.setTenantId("test001");
req.setEvent(obj1);
DingtalkIoteventPushResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
DingtalkIoteventPushRequest req = new DingtalkIoteventPushRequest();
DingtalkIoteventPushRequest.PushEventRequestDomain obj1 = new DingtalkIoteventPushRequest.PushEventRequestDomain();
obj1.IotId = "ipc123";
DingtalkIoteventPushRequest.EventparamDomain obj2 = new DingtalkIoteventPushRequest.EventparamDomain();
obj2.ImgUrl = "www.taobao.com";
obj1.EventParam= obj2;
obj1.IotInstanceId = "Q7uOhVRdZRRlDnTLv****00100";
obj1.EventStatus = 0L;
obj1.OccurrenceTime = 123456789L;
obj1.Platform = "ALIYUN_IOT";
obj1.AliyunPk = "123456789";
obj1.AlarmId = "test121212";
obj1.AlgorithmName = "regionalInvasion";
obj1.AlgorithmId = 11001L;
obj1.PicId = "YTlhZkZoaXFrSWFyMkxaYTNqdzdfSDh4YzJQYkhOUHh1SUdxa2hRWGMycy9kYzM4OWUyM2NiMDU0OTMwOGIyOGM0YzA2Y2E0M2E5MV8xNjE3Nzc4ODM0NTY2";
obj1.TenantId = "test001";
req.Event_ = obj1;
DingtalkIoteventPushResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new DingtalkIoteventPushRequest;
$event = new PushEventRequest;
$event->iot_id="ipc123";
$event_param = new Eventparam;
$event_param->img_url="www.taobao.com";
$event->event_param = $event_param;
$event->iot_instance_id="Q7uOhVRdZRRlDnTLv****00100";
$event->event_status="0";
$event->occurrence_time="123456789";
$event->platform="ALIYUN_IOT";
$event->aliyun_pk="123456789";
$event->alarm_id="test121212";
$event->algorithm_name="regionalInvasion";
$event->algorithm_id="11001";
$event->pic_id="YTlhZkZoaXFrSWFyMkxaYTNqdzdfSDh4YzJQYkhOUHh1SUdxa2hRWGMycy9kYzM4OWUyM2NiMDU0OTMwOGIyOGM0YzA2Y2E0M2E5MV8xNjE3Nzc4ODM0NTY2";
$event->tenant_id="test001";
$req->setEvent(json_encode($event));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=dingtalk.iotevent.push' \
-d 'partner_id=apidoc' \
-d 'sign=CF170D18D900111B125B4C29779CD3CF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+21%3A36%3A56' \
-d 'v=2.0' \
-d 'event=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.DingtalkIoteventPushRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.event=""
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.iotevent.push");
add_param(pRequest,"event","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.iotevent.push', {
	'event':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_iotevent_push_response>
    <error_ctx>{&quot;imgUrl&quot;:&quot;missing&quot;}&quot;}</error_ctx>
    <content>
        <event_id>abc123456</event_id>
    </content>
    <error_level>info</error_level>
</dingtalk_iotevent_push_response>

{
    "dingtalk_iotevent_push_response":{
        "error_ctx":"{\"imgUrl\":\"missing\"}\"}",
        "content":{
            "event_id":"abc123456"
        },
        "error_level":"info"
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.iotevent.push (IOT数据上报接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ