淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
device_register_param	DeviceRegisterParam	可选			1
└ device_type Number 可选 1 设备类型 └ app_version String 可选 1 app版本 └ os Number 可选 1 操作系统 └ utd_id Number 可选 1 utd_id └ device_id String 必须 1 设备ID └ device_name String 必须 1 设备名称 └ mac String 必须 1 设备Mac └ is_mqtt_credential Boolean 可选 false 是否走MQTT凭证链路 false 走原有逻辑 true 走MQTT凭证链路

名称	类型	示例值	描述
result	Result		结果
└ error_code Number 0 参数errorCode └ error_code_str String foo 参数errorCodeStr └ error_msg String foo 参数errorMsg model DeviceRegisterDto 参数model └ device_alias String foo deviceAlias └ device_id String foo deviceId └ device_secret String foo deviceSecret └ product_key String foo productKey └ is_mqtt_credential Boolean false 是否走MQTT凭证链路 true mqtt链路，false则执行老逻辑，默认为false └ client_id String GID_MEV_LIVE_CENTER@@@d6_maixiaozhi_351384157 设备唯一，isMqttCredential=true返回 └ user_name String Te+FYWnwPHfLd7TA9Sfyp3mVJp3t2mLGNg+J2ozScNIQS2Xb6bZyD9Dc 设备名称(RSA加密) ，isMqttCredential=true返回 └ pass_word String password 设备密码(RSA加密) ，isMqttCredential=true返回 └ instance_id String post-cn-2104i4gtk01 mqtt实例ID └ end_point String onsmqtt.cn-zhangjiakou.aliyuncs.com mqtt实例的接入点域名 └ success Boolean false 参数success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiMevMaideskDeviceregisterRequest req = new AlibabaDamaiMevMaideskDeviceregisterRequest();
AlibabaDamaiMevMaideskDeviceregisterRequest.DeviceRegisterParam obj1 = new AlibabaDamaiMevMaideskDeviceregisterRequest.DeviceRegisterParam();
obj1.setDeviceType(1L);
obj1.setAppVersion("1");
obj1.setOs(1L);
obj1.setUtdId(1L);
obj1.setDeviceId("1");
obj1.setDeviceName("1");
obj1.setMac("1");
obj1.setIsMqttCredential(false);
req.setDeviceRegisterParam(obj1);
AlibabaDamaiMevMaideskDeviceregisterResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiMevMaideskDeviceregisterRequest req = new AlibabaDamaiMevMaideskDeviceregisterRequest();
AlibabaDamaiMevMaideskDeviceregisterRequest.DeviceRegisterParamDomain obj1 = new AlibabaDamaiMevMaideskDeviceregisterRequest.DeviceRegisterParamDomain();
obj1.DeviceType = 1L;
obj1.AppVersion = "1";
obj1.Os = 1L;
obj1.UtdId = 1L;
obj1.DeviceId = "1";
obj1.DeviceName = "1";
obj1.Mac = "1";
obj1.IsMqttCredential = false;
req.DeviceRegisterParam_ = obj1;
AlibabaDamaiMevMaideskDeviceregisterResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiMevMaideskDeviceregisterRequest;
$device_register_param = new DeviceRegisterParam;
$device_register_param->device_type="1";
$device_register_param->app_version="1";
$device_register_param->os="1";
$device_register_param->utd_id="1";
$device_register_param->device_id="1";
$device_register_param->device_name="1";
$device_register_param->mac="1";
$device_register_param->is_mqtt_credential="false";
$req->setDeviceRegisterParam(json_encode($device_register_param));
$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=alibaba.damai.mev.maidesk.deviceregister' \
-d 'partner_id=apidoc' \
-d 'sign=210B4C28EE9DB3302D8CA18A65ECA957' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-17+03%3A50%3A45' \
-d 'v=2.0' \
-d 'device_register_param=null'

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

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

req.device_register_param="数据结构示例JSON格式"
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,"alibaba.damai.mev.maidesk.deviceregister");
add_param(pRequest,"device_register_param","数据结构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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.damai.mev.maidesk.deviceregister', {
	'device_register_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_mev_maidesk_deviceregister_response>
    <result>
        <error_code>0</error_code>
        <error_code_str>foo</error_code_str>
        <error_msg>foo</error_msg>
        <model>
            <device_alias>foo</device_alias>
            <device_id>foo</device_id>
            <device_secret>foo</device_secret>
            <product_key>foo</product_key>
            <is_mqtt_credential>false</is_mqtt_credential>
            <client_id>GID_MEV_LIVE_CENTER@@@d6_maixiaozhi_351384157</client_id>
            <user_name>Te+FYWnwPHfLd7TA9Sfyp3mVJp3t2mLGNg+J2ozScNIQS2Xb6bZyD9Dc</user_name>
            <pass_word>password</pass_word>
            <instance_id>post-cn-2104i4gtk01</instance_id>
            <end_point>onsmqtt.cn-zhangjiakou.aliyuncs.com</end_point>
        </model>
        <success>false</success>
    </result>
</alibaba_damai_mev_maidesk_deviceregister_response>

{
    "alibaba_damai_mev_maidesk_deviceregister_response":{
        "result":{
            "error_code":0,
            "error_code_str":"foo",
            "error_msg":"foo",
            "model":{
                "device_alias":"foo",
                "device_id":"foo",
                "device_secret":"foo",
                "product_key":"foo",
                "is_mqtt_credential":false,
                "client_id":"GID_MEV_LIVE_CENTER@@@d6_maixiaozhi_351384157",
                "user_name":"Te+FYWnwPHfLd7TA9Sfyp3mVJp3t2mLGNg+J2ozScNIQS2Xb6bZyD9Dc",
                "pass_word":"password",
                "instance_id":"post-cn-2104i4gtk01",
                "end_point":"onsmqtt.cn-zhangjiakou.aliyuncs.com"
            },
            "success":false
        }
    }
}

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

alibaba.damai.mev.maidesk.deviceregister (千里目远程设备注册)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ