淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
add_owner_param	AddOwnerParam	可选			添加房东信息的对象
└ avatar_url String 必须 http://test.com/1.jpg 房东头像地址，大小不超过3M，格式格式限制"png", "jpg", "jpeg" └ avg_confirm_time Number 可选 30 订单平均确认时长（单位分钟，要求大于0） └ birthday Date 可选 2008-08-08 00:00:00 房东的生日（年-月-日 00:00:00） └ city Number 可选 530100 房东所在城市编码。参见：http://hotel.alitrip.com/area.htm，domestic为false时，输入对应国家的海外城市编码，可调用海外城市查询接口获取； └ confirm_rate Number 可选 90 订单接单率 0-100，百分比分子 └ constellation Number 可选 10 星座 -1:错误，未知, 0:白羊,1:金牛,2:双子,3:巨蟹,4:狮子,5:处女,6:天秤,7:天蝎,8:射手,9:摩羯,10:水瓶,11:双鱼 └ country String 可选 China 国内固定传"China"；国外必须传定义的海外国家编码值。参见：http://hotel.alitrip.com/area.htm └ description String 可选小明做民宿房东已经5年，深受房客认可和喜欢房东介绍，长度限制2048个字符 └ email String 可选 1234@qq.com 邮箱 └ gender String 可选 M 性别，M-男性,F-女性，U-未知 └ hobbies String 可选游泳,爬山爱好，用英文逗号分割如"游泳,爬山" └ id_number String 可选 110105200910234516 身份证号 └ labels String 可选超赞,好房东房东标签，英文逗号分割，如"超赞,有爱" └ level Number 可选 60 房东等级评分，0-100，房东等级越高越优秀 └ license_name String 可选张三经营资质执照类型对应的名称，执照类型1（身份证）：身份证姓名；执照类型2（护照）：护照姓名；执照类型3（营业执照）：企业名称 └ license_no String 可选 110105200910234516 经营资质执照类型对应的编码，执照类型1（身份证）：身份证号；执照类型2（护照）：护照号；执照类型3（营业执照）：营业执照编号 └ license_type Number 必须 1 经营资质执照类型，1 身份证(默认)、2 护照、3 营业执照 └ mobile_phone String 可选 +86-13510050815 移动电话号码。移动电话号码与固定电话号码二者必须填一个 └ nick_name String 必须小明房东昵称 └ outer_id String 必须 1234 房东Id，供货商自己库中的房东Id └ owner_type Number 必须 1 房东类型，枚举 1.个人房东；2.商户经营；3.其他 └ positive_feedback Number 可选 80 好评率，0-100，百分比分子，数字越大好评率越高 └ profession String 可选教师职业 └ province Number 可选 110000 省份编码。选填，不填入的时候已city字段为准.参见：http://hotel.alitrip.com/area.htm └ qualification Number 可选 4 学历 1:小学,2:初中,3:高中,4:本科,5:硕士,6:博士,7:博士后,0:其他 └ real_contact String 必须 13510050815 房东的真实联系方式，不能填第三方转接号码 └ real_name String 可选张三实名认证姓名 └ response_rate Number 可选 70 回复率，0-100，百分比分子，数字越大回复率越高 └ story String 可选 {"pics":["http://test.com/1.jpg"],"content":"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢"} 房东故事，json串，可以传图片和文本： {"pics":[""],"content":""} └ telephone String 可选 010-85279666 固定电话。移动电话号码与固定电话号码二者必须填一个 └ validate Number 必须 1 实名验证方式，认证情况:1:身份验证,2:头像验证,4:手机验证,8:邮箱验证,可以二进制叠加,二进制各位代表含义 └ vendor String 可选 taobao 对接系统商名称：可为空不要乱填，需要申请后使用

名称	类型	示例值	描述
result	ResultSet		查询结果集
first_result AddOwnerParam firstResult └ avatar_url String http://test.com/1.jpg 房东头像地址 └ avg_confirm_time Number 30 订单平均确认时长（单位分钟，要求大于0） └ birthday Date 2008-08-08 00:00:00 房东的生日（年-月-日 00:00:00） └ blood_type Number 1 房东血型，0:未知,1:A型,2:B型,3:AB型,4:O型 └ city Number 530100 房东所在城市编码。参见：http://hotel.alitrip.com/area.htm，domestic为false时，输入对应国家的海外城市编码，可调用海外城市查询接口获取； └ confirm_rate Number 90 订单接单率 0-100，百分比分子 └ constellation Number 10 星座 -1:错误，未知, 0:白羊,1:金牛,2:双子,3:巨蟹,4:狮子,5:处女,6:天秤,7:天蝎,8:射手,9:摩羯,10:水瓶,11:双鱼 └ country String China 国内固定传"China"；国外必须传定义的海外国家编码值。参见：http://hotel.alitrip.com/area.htm └ description String 小明做民宿房东已经5年，深受房客认可和喜欢房东介绍，长度限制2048个字符 └ email String 1234@qq.com 邮箱 └ gender String M 性别，M-男性,F-女性，U-未知 └ hobbies String 游泳,爬山爱好，用英文逗号分割如"游泳,爬山" └ id_number String 110105200910234516 身份证号 └ labels String 超赞,好房东房东标签，英文逗号分割，如"超赞,有爱" └ level Number 60 房东等级评分，0-100，房东等级越高越优秀 └ license_name String 张三经营资质执照类型对应的名称，执照类型1（身份证）：身份证姓名；执照类型2（护照）：护照姓名；执照类型3（营业执照）：企业名称 └ license_no String 110105200910234516 经营资质执照类型对应的编码，执照类型1（身份证）：身份证号；执照类型2（护照）：护照号；执照类型3（营业执照）：营业执照编号 └ license_type Number 1 经营资质执照类型，1 身份证(默认)、2 护照、3 营业执照 └ mobile_phone String +86-13510050815 移动电话 └ nick_name String 小明昵称 └ outer_id String 1234 房东Id，供货商自己库中的房东Id └ owner_type Number 1 房东类型，枚举 1.个人房东；2.商户经营；3.其他 └ positive_feedback Number 80 好评率，0-100，百分比分子，数字越大好评率越高 └ profession String 教师职业 └ province Number 110000 省份编码。选填，不填入的时候已city字段为准.参见：http://hotel.alitrip.com/area.htm └ qualification Number 4 学历 1:小学,2:初中,3:高中,4:本科,5:硕士,6:博士,7:博士后,0:其他 └ real_contact String 13510050815 房东的真实联系方式，不能填第三方转接号码 └ real_name String 张三实名认证姓名 └ response_rate Number 70 回复率，0-100，百分比分子，数字越大回复率越高 └ story String {"pics":["http://test.com/1.jpg"],"content":"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢"} 房东故事 └ telephone String 010-85279666 固定电话 └ validate Number 1 实名验证方式，认证情况:1:身份验证,2:头像验证,4:手机验证,8:邮箱验证,可以二进制叠加,二进制各位代表含义 └ vendor String taobao 对接系统商名称：可为空不要乱填，需要申请后使用

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelBnbownerAddRequest req = new XhotelBnbownerAddRequest();
XhotelBnbownerAddRequest.AddOwnerParam obj1 = new XhotelBnbownerAddRequest.AddOwnerParam();
obj1.setAvatarUrl("http://test.com/1.jpg");
obj1.setAvgConfirmTime(30L);
obj1.setBirthday(StringUtils.parseDateTime("2008-08-08 00:00:00"));
obj1.setCity(530100L);
obj1.setConfirmRate(90L);
obj1.setConstellation(10L);
obj1.setCountry("China");
obj1.setDescription("小明做民宿房东已经5年，深受房客认可和喜欢");
obj1.setEmail("1234@qq.com");
obj1.setGender("M");
obj1.setHobbies("游泳,爬山");
obj1.setIdNumber("110105200910234516");
obj1.setLabels("超赞,好房东");
obj1.setLevel(60L);
obj1.setLicenseName("张三");
obj1.setLicenseNo("110105200910234516");
obj1.setLicenseType(1L);
obj1.setMobilePhone("+86-13510050815");
obj1.setNickName("小明");
obj1.setOuterId("1234");
obj1.setOwnerType(1L);
obj1.setPositiveFeedback(80L);
obj1.setProfession("教师");
obj1.setProvince(110000L);
obj1.setQualification(4L);
obj1.setRealContact("13510050815");
obj1.setRealName("张三");
obj1.setResponseRate(70L);
obj1.setStory("{\"pics\":[\"http://test.com/1.jpg\"],\"content\":\"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢\"}");
obj1.setTelephone("010-85279666");
obj1.setValidate(1L);
obj1.setVendor("taobao");
req.setAddOwnerParam(obj1);
XhotelBnbownerAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelBnbownerAddRequest req = new XhotelBnbownerAddRequest();
XhotelBnbownerAddRequest.AddOwnerParamDomain obj1 = new XhotelBnbownerAddRequest.AddOwnerParamDomain();
obj1.AvatarUrl = "http://test.com/1.jpg";
obj1.AvgConfirmTime = 30L;
obj1.Birthday = DateTime.Parse(2008-08-08 00:00:00");
obj1.City = 530100L;
obj1.ConfirmRate = 90L;
obj1.Constellation = 10L;
obj1.Country = "China";
obj1.Description = "小明做民宿房东已经5年，深受房客认可和喜欢";
obj1.Email = "1234@qq.com";
obj1.Gender = "M";
obj1.Hobbies = "游泳,爬山";
obj1.IdNumber = "110105200910234516";
obj1.Labels = "超赞,好房东";
obj1.Level = 60L;
obj1.LicenseName = "张三";
obj1.LicenseNo = "110105200910234516";
obj1.LicenseType = 1L;
obj1.MobilePhone = "+86-13510050815";
obj1.NickName = "小明";
obj1.OuterId = "1234";
obj1.OwnerType = 1L;
obj1.PositiveFeedback = 80L;
obj1.Profession = "教师";
obj1.Province = 110000L;
obj1.Qualification = 4L;
obj1.RealContact = "13510050815";
obj1.RealName = "张三";
obj1.ResponseRate = 70L;
obj1.Story = "{\"pics\":[\"http://test.com/1.jpg\"],\"content\":\"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢\"}";
obj1.Telephone = "010-85279666";
obj1.Validate = 1L;
obj1.Vendor = "taobao";
req.AddOwnerParam_ = obj1;
XhotelBnbownerAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelBnbownerAddRequest;
$add_owner_param = new AddOwnerParam;
$add_owner_param->avatar_url="http://test.com/1.jpg";
$add_owner_param->avg_confirm_time="30";
$add_owner_param->birthday="2008-08-08 00:00:00";
$add_owner_param->city="530100";
$add_owner_param->confirm_rate="90";
$add_owner_param->constellation="10";
$add_owner_param->country="China";
$add_owner_param->description="小明做民宿房东已经5年，深受房客认可和喜欢";
$add_owner_param->email="1234@qq.com";
$add_owner_param->gender="M";
$add_owner_param->hobbies="游泳,爬山";
$add_owner_param->id_number="110105200910234516";
$add_owner_param->labels="超赞,好房东";
$add_owner_param->level="60";
$add_owner_param->license_name="张三";
$add_owner_param->license_no="110105200910234516";
$add_owner_param->license_type="1";
$add_owner_param->mobile_phone="+86-13510050815";
$add_owner_param->nick_name="小明";
$add_owner_param->outer_id="1234";
$add_owner_param->owner_type="1";
$add_owner_param->positive_feedback="80";
$add_owner_param->profession="教师";
$add_owner_param->province="110000";
$add_owner_param->qualification="4";
$add_owner_param->real_contact="13510050815";
$add_owner_param->real_name="张三";
$add_owner_param->response_rate="70";
$add_owner_param->story="{\"pics\":[\"http://test.com/1.jpg\"],\"content\":\"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢\"}";
$add_owner_param->telephone="010-85279666";
$add_owner_param->validate="1";
$add_owner_param->vendor="taobao";
$req->setAddOwnerParam(json_encode($add_owner_param));
$resp = $c->execute($req, $sessionKey);

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.xhotel.bnbowner.add' \
-d 'partner_id=apidoc' \
-d 'session=2586e70c-5179-45d1-9be6-8f445e045bd7' \
-d 'sign=5BA06516E75101E7A5F5BC2BF45C394B' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-12-04+01%3A55%3A06' \
-d 'v=2.0' \
-d 'add_owner_param=null'

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

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

req.add_owner_param=""
try:
	resp= req.getResponse(sessionkey)
	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.xhotel.bnbowner.add");
add_param(pRequest,"add_owner_param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.xhotel.bnbowner.add', {
	'add_owner_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_bnbowner_add_response>
    <result>
        <first_result>
            <avatar_url>http://test.com/1.jpg</avatar_url>
            <avg_confirm_time>30</avg_confirm_time>
            <birthday>2008-08-08 00:00:00</birthday>
            <blood_type>1</blood_type>
            <city>530100</city>
            <confirm_rate>90</confirm_rate>
            <constellation>10</constellation>
            <country>China</country>
            <description>小明做民宿房东已经5年，深受房客认可和喜欢</description>
            <email>1234@qq.com</email>
            <gender>M</gender>
            <hobbies>游泳,爬山</hobbies>
            <id_number>110105200910234516</id_number>
            <labels>超赞,好房东</labels>
            <level>60</level>
            <license_name>张三</license_name>
            <license_no>110105200910234516</license_no>
            <license_type>1</license_type>
            <mobile_phone>+86-13510050815</mobile_phone>
            <nick_name>小明</nick_name>
            <outer_id>1234</outer_id>
            <owner_type>1</owner_type>
            <positive_feedback>80</positive_feedback>
            <profession>教师</profession>
            <province>110000</province>
            <qualification>4</qualification>
            <real_contact>13510050815</real_contact>
            <real_name>张三</real_name>
            <response_rate>70</response_rate>
            <story>{&quot;pics&quot;:[&quot;http://test.com/1.jpg&quot;],&quot;content&quot;:&quot;我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢&quot;}</story>
            <telephone>010-85279666</telephone>
            <validate>1</validate>
            <vendor>taobao</vendor>
        </first_result>
    </result>
</xhotel_bnbowner_add_response>

{
    "xhotel_bnbowner_add_response":{
        "result":{
            "first_result":{
                "avatar_url":"http:\/\/test.com\/1.jpg",
                "avg_confirm_time":30,
                "birthday":"2008-08-08 00:00:00",
                "blood_type":1,
                "city":530100,
                "confirm_rate":90,
                "constellation":10,
                "country":"China",
                "description":"小明做民宿房东已经5年，深受房客认可和喜欢",
                "email":"1234@qq.com",
                "gender":"M",
                "hobbies":"游泳,爬山",
                "id_number":"110105200910234516",
                "labels":"超赞,好房东",
                "level":60,
                "license_name":"张三",
                "license_no":"110105200910234516",
                "license_type":1,
                "mobile_phone":"+86-13510050815",
                "nick_name":"小明",
                "outer_id":"1234",
                "owner_type":1,
                "positive_feedback":80,
                "profession":"教师",
                "province":110000,
                "qualification":4,
                "real_contact":"13510050815",
                "real_name":"张三",
                "response_rate":70,
                "story":"{\"pics\":[\"http:\/\/test.com\/1.jpg\"],\"content\":\"我是一名文艺青年，做民宿房东已经5年，深受房客认可和喜欢\"}",
                "telephone":"010-85279666",
                "validate":1,
                "vendor":"taobao"
            }
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:CHOICE_ERROR	mobilePhone，telephone都为空	房东必传

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

开放平台

酒店商品API

taobao.xhotel.bnbowner.add (民宿房东信息添加)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ