淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
merchant_code	String	必须	HM	商家编码
tenant_id	String	必须	1000000	租户ID
request_app_key	String	必须	SKYEYE	视频中心颁发的KEY
bu_code	String	必须	1202	门店code

名称	类型	示例值	描述
action_status	Boolean	true	返回是否成功
data	IpcBaseDTO []	{}	返回数据对象
└ ipc_name String Agent测试-395 返回摄像头名称 └ area_code String 9999 返回code └ state_type_code Number 0 在线状态 └ area_name String 未分类区域摄像头归属区域Code └ ip String 192.143.23.21 摄像头ip └ snapshot_url String https://iot-video-daily.oss-cn-shanghai.aliyuncs.com/snapshot/CSSJ_hz_CSJ_WDKSW_XJTEST052001/d6ae418b-f54c-4979-9bf7-c88d455b8dfd.jpg?x-oss-process=image/resize,w_360 快照地址 └ tenant_id String 10000001 租户ID └ ipc_id String IPC_CSJ_WDKSW_XJ_192.168.12.137 摄像头ID organization OrganizationDTO {} 组织机构对象 └ merchant_code String CSSJ 商家编码 └ subsidiary_name String 杭州子公司子公司名称 └ enable Number 1 是否启用 └ tenant_id String 10000001 租户ID └ bu_code String CSJ_WDKSW_XJTEST052001 门店编码 └ bu_name String 险峻测试商家仓052101 门店名称 └ subsidiary_code String hz 子公司编码 └ merchant_name String 测试盒马商家商家名称 └ thumbnail_url String http://baidu.com 缩略图
res_success	Boolean	true	是否成功
msg_info	String	ok	返回错误消息
msg_code	String	1	返回错误编码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WdkIotVideoQueryIpcBaseGroupByAreaRequest req = new WdkIotVideoQueryIpcBaseGroupByAreaRequest();
req.setMerchantCode("HM");
req.setTenantId("1000000");
req.setRequestAppKey("SKYEYE");
req.setBuCode("1202");
WdkIotVideoQueryIpcBaseGroupByAreaResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdkIotVideoQueryIpcBaseGroupByAreaRequest req = new WdkIotVideoQueryIpcBaseGroupByAreaRequest();
req.MerchantCode = "HM";
req.TenantId = "1000000";
req.RequestAppKey = "SKYEYE";
req.BuCode = "1202";
WdkIotVideoQueryIpcBaseGroupByAreaResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdkIotVideoQueryIpcBaseGroupByAreaRequest;
$req->setMerchantCode("HM");
$req->setTenantId("1000000");
$req->setRequestAppKey("SKYEYE");
$req->setBuCode("1202");
$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=taobao.wdk.iot.video.query.ipc.base.group.by.area' \
-d 'partner_id=apidoc' \
-d 'sign=EC5D7EF93D657E1C26ADB89F0E995B0F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A02%3A20' \
-d 'v=2.0' \
-d 'bu_code=1202' \
-d 'merchant_code=HM' \
-d 'request_app_key=SKYEYE' \
-d 'tenant_id=1000000'

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

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

req.merchant_code="HM"
req.tenant_id="1000000"
req.request_app_key="SKYEYE"
req.bu_code="1202"
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,"taobao.wdk.iot.video.query.ipc.base.group.by.area");
add_param(pRequest,"merchant_code","HM");
add_param(pRequest,"tenant_id","1000000");
add_param(pRequest,"request_app_key","SKYEYE");
add_param(pRequest,"bu_code","1202");
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('taobao.wdk.iot.video.query.ipc.base.group.by.area', {
	'merchant_code':'HM',
	'tenant_id':'1000000',
	'request_app_key':'SKYEYE',
	'bu_code':'1202'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wdk_iot_video_query_ipc_base_group_by_area_response>
    <action_status>true</action_status>
    <data>
        <ipc_base_d_t_o>
            <ipc_name>Agent测试-395</ipc_name>
            <area_code>9999</area_code>
            <state_type_code>0</state_type_code>
            <area_name>未分类区域</area_name>
            <ip>192.143.23.21</ip>
            <snapshot_url>https://iot-video-daily.oss-cn-shanghai.aliyuncs.com/snapshot/CSSJ_hz_CSJ_WDKSW_XJTEST052001/d6ae418b-f54c-4979-9bf7-c88d455b8dfd.jpg?x-oss-process=image/resize,w_360</snapshot_url>
            <tenant_id>10000001</tenant_id>
            <ipc_id>IPC_CSJ_WDKSW_XJ_192.168.12.137</ipc_id>
            <organization>
                <merchant_code>CSSJ</merchant_code>
                <subsidiary_name>杭州子公司</subsidiary_name>
                <enable>1</enable>
                <tenant_id>10000001</tenant_id>
                <bu_code>CSJ_WDKSW_XJTEST052001</bu_code>
                <bu_name>险峻测试商家仓052101</bu_name>
                <subsidiary_code>hz</subsidiary_code>
                <merchant_name>测试盒马商家</merchant_name>
            </organization>
            <thumbnail_url>http://baidu.com</thumbnail_url>
        </ipc_base_d_t_o>
    </data>
    <res_success>true</res_success>
    <msg_info>ok</msg_info>
    <msg_code>1</msg_code>
</wdk_iot_video_query_ipc_base_group_by_area_response>

{
    "wdk_iot_video_query_ipc_base_group_by_area_response":{
        "action_status":true,
        "data":{
            "ipc_base_d_t_o":[
                {
                    "ipc_name":"Agent测试-395",
                    "area_code":"9999",
                    "state_type_code":0,
                    "area_name":"未分类区域",
                    "ip":"192.143.23.21",
                    "snapshot_url":"https:\/\/iot-video-daily.oss-cn-shanghai.aliyuncs.com\/snapshot\/CSSJ_hz_CSJ_WDKSW_XJTEST052001\/d6ae418b-f54c-4979-9bf7-c88d455b8dfd.jpg?x-oss-process=image\/resize,w_360",
                    "tenant_id":"10000001",
                    "ipc_id":"IPC_CSJ_WDKSW_XJ_192.168.12.137",
                    "organization":{
                        "merchant_code":"CSSJ",
                        "subsidiary_name":"杭州子公司",
                        "enable":1,
                        "tenant_id":"10000001",
                        "bu_code":"CSJ_WDKSW_XJTEST052001",
                        "bu_name":"险峻测试商家仓052101",
                        "subsidiary_code":"hz",
                        "merchant_name":"测试盒马商家"
                    },
                    "thumbnail_url":"http:\/\/baidu.com"
                }
            ]
        },
        "res_success":true,
        "msg_info":"ok ",
        "msg_code":"1"
    }
}

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测试工具错误码查询工具 SDK下载

五道口API

taobao.wdk.iot.video.query.ipc.base.group.by.area (查询组织机构下Ipc基础信息，并按区域分组)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ