qimen.taobao.xhotel.futurehotel (云上hfc提供的标准未来酒店接口)

云上hfc提供的标准未来酒店接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
methodName String 必须 qimen 方法名
hotelFutureRQ HotelFutureRQ 可选 未来酒店对接请求RQ
  • └ oid
  • Number
  • 可选
  • 123
  • OTA订单id,即第三方系统中的订单id
  • └ ext
  • String
  • 可选
  • {"key":"value"}
  • 特殊透传参数
  • └ checkOut
  • String
  • 可选
  • ""
  • 查询房态时用到的参数,日期参数格式: yyyy-MM-dd
  • └ checkIn
  • String
  • 可选
  • ""
  • 查询房态时用到的参数,日期参数格式: yyyy-MM-dd
  • └ roomTypeID
  • String
  • 可选
  • 1
  • 外部房型ID
  • └ sourceType
  • Number
  • 可选
  • 1
  • sourceType
  • └ reqOutSystem
  • Number
  • 可选
  • 1
  • 请求的外部系统枚举表示(用于请求石基CIA或者智能设备)
  • smartDeviceCtrl
  • SmartDeviceCtrl
  • 可选
  • ""
  • 智能设备控制
  • └ roomNum
  • String
  • 可选
  • 1212
  • 房间号 门锁控制时由对接设置
  • └ ctrlType
  • String
  • 可选
  • 1
  • 操作类型
  • faceScanInfo
  • FaceScanInfo
  • 可选
  • ""
  • 扫脸入住信息
  • guestInfo
  • GuestInfo
  • 可选
  • 客户信息
  • └ guestName
  • String
  • 可选
  • 小红
  • 姓名
  • └ certificateType
  • Number
  • 可选
  • 20
  • 证件类型
  • └ certificateNum
  • String
  • 可选
  • 33100419900321
  • 证件号
  • └ nation
  • String
  • 可选
  • 汉族
  • 民族
  • └ address
  • String
  • 可选
  • 北京
  • 地址
  • └ base64Img
  • String
  • 可选
  • 图片编码
  • 刷脸照片
  • └ deviceId
  • String
  • 可选
  • 1212
  • 设备ID
  • └ birthday
  • String
  • 可选
  • 1990-02-14
  • 生日
  • └ sex
  • String
  • 可选
  • 性别
  • └ signOffice
  • String
  • 可选
  • 余杭公安局
  • 签发机构
  • └ usefulSDate
  • String
  • 可选
  • 2018-10
  • 有效起始时间
  • └ usefulEDate
  • String
  • 可选
  • 2028-10
  • 有效截止时间
  • └ message
  • String
  • 可选
  • 身份证附加消息
  • └ country
  • String
  • 可选
  • 中国
  • 国家
  • └ province
  • String
  • 可选
  • 浙江
  • 省份
  • └ city
  • String
  • 可选
  • 杭州
  • 城市
  • └ phone
  • String
  • 可选
  • 13176854561
  • 电话
  • guestBill
  • Struct
  • 可选
  • ""
  • 查询水单
  • └ roomNum
  • String
  • 可选
  • 1231
  • 房间号
  • └ shortIdNumber
  • String
  • 可选
  • 待定
  • 待启用
  • └ hotelCode
  • String
  • 可选
  • HZ01
  • 酒店编码
  • checkInInfo
  • CheckInInfo
  • 可选
  • ""
  • 自助入住信息
  • └ roomNum
  • String
  • 可选
  • 1211
  • 房间号
  • └ deviceId
  • String
  • 可选
  • 11111111
  • 设备id
  • guestList
  • GuestInfo []
  • 可选
  • 客户信息
  • └ guestName
  • String
  • 可选
  • 小红
  • 姓名
  • └ certificateType
  • Number
  • 可选
  • 20
  • 证件类型
  • └ certificateNum
  • String
  • 可选
  • 33100419900321
  • 证件号
  • └ nation
  • String
  • 可选
  • 汉族
  • 民族
  • └ address
  • String
  • 可选
  • 北京
  • 地址
  • └ base64Img
  • String
  • 可选
  • 图片编码
  • 刷脸照片
  • └ deviceId
  • String
  • 可选
  • 122121
  • 设备ID
  • └ birthday
  • String
  • 可选
  • 1990-02-14
  • 生日
  • └ sex
  • String
  • 可选
  • 性别
  • └ signOffice
  • String
  • 可选
  • 余杭公安局
  • 签发机构
  • └ usefulSDate
  • String
  • 可选
  • 2018-10
  • 有效起始日期
  • └ usefulEDate
  • String
  • 可选
  • 2028-10
  • 有效截止日期
  • └ message
  • String
  • 可选
  • 身份证附加消息
  • └ country
  • String
  • 可选
  • 中国
  • 国家
  • └ province
  • String
  • 可选
  • 浙江
  • 省份
  • └ city
  • String
  • 可选
  • 杭州
  • 城市
  • └ phone
  • String
  • 可选
  • 13587463721
  • 电话
  • roomSelectInfo
  • RoomSelectInfo
  • 可选
  • ""
  • 在线选房参数
  • └ type
  • Number
  • 可选
  • 1
  • 选房操作类型 * 1:选房操作;2: 取消选房;3: 变更选房
  • └ roomTypeID
  • String
  • 可选
  • 1232
  • 订单绑定外部房型ID
  • └ buildingNum
  • String
  • 可选
  • 1
  • 楼号
  • └ floor
  • String
  • 可选
  • 2
  • 楼层
  • └ roomNum
  • String
  • 可选
  • 1221
  • 所选择房间号
  • └ oldRoomNum
  • String
  • 可选
  • 1111
  • 原始房间号(变更选房时候有效)
  • checkOutInfo
  • CheckOutInfo
  • 可选
  • ""
  • 退房信息
  • └ actionTime
  • String
  • 可选
  • 2018-01-11 10:00:00
  • 想要退房时间
  • └ needInvoice
  • Number
  • 可选
  • 1
  • 是否需要开发票 * 0:不需要开发票;1:需要开发票
  • invoiceInfo
  • InvoiceInfo
  • 可选
  • ""
  • 发票信息
  • └ invoiceType
  • Number
  • 可选
  • 1
  • 发票类型(1:普通发票;2:增值税专用发票)
  • └ invoiceTitle
  • String
  • 可选
  • 阿里巴巴
  • 发票抬头
  • └ taxpayerId
  • String
  • 可选
  • 12353433
  • 纳税人识别号:纳税人识别号,一律由15位、18或者20位码(字符型)组成。
  • └ regAddress
  • String
  • 可选
  • 杭州
  • 公司注册地址:抬头公司注册地址
  • └ companyTel
  • String
  • 可选
  • 0571-88836777
  • 公司电话:抬头公司电话,区号-电话号码
  • └ bankName
  • String
  • 可选
  • 高星支行
  • 开户行: 抬头公司银行开户行名称
  • └ bankAccount
  • String
  • 可选
  • 2343533
  • 银行账户:抬头公司银行账号
  • └ postType
  • Number
  • 可选
  • 1
  • 发票领取方式 ( 0:前台自取 1:邮寄 2:电子发票 3: 送至房间 )
  • └ earllyPrepare
  • Number
  • 可选
  • 1
  • 发票是否需要提前准备(目前提前开,咱不考虑此值) (0:不提前开发票 1:需要提前开好发票)
  • └ provider
  • Number
  • 可选
  • 1
  • 邮费承担方 1:酒店承担 2:商家承担 3:去啊平台承担 4:客户自己承担
  • └ receiverName
  • String
  • 可选
  • 小王
  • 收件人姓名
  • └ receiverMobile
  • String
  • 可选
  • 13198768763
  • 收件人手机号
  • └ receiverAddress
  • String
  • 可选
  • 上海
  • 收件地址
  • └ wantTime
  • String
  • 可选
  • 2018-01-11 09:00:00
  • 需要发票时间(格式yyyy-MM-dd HH:mm:ss)
  • └ comment
  • String
  • 可选
  • 备注信息
  • └ attributes
  • String
  • 可选
  • {"a":1,"b":2}
  • 特殊透传对接参数
  • └ displayText
  • String
  • 可选
  • XXXX
  • 建议pms提示文案
  • └ pmsConfig
  • String
  • 可选
  • {"a":1,"b":2}
  • pms配置信息
  • └ pmsAction
  • Number
  • 可选
  • 1
  • pms处理消息的动作
  • └ vendor
  • String
  • 可选
  • taobao
  • vendor
  • └ sellerNick
  • String
  • 可选
  • 淘酒店
  • 卖家名称
  • └ sellerId
  • Number
  • 可选
  • 122222222222
  • 卖家ID
  • └ hid
  • Number
  • 可选
  • 121111
  • 酒店hid
  • └ hotelCode
  • String
  • 可选
  • hhhf-ff
  • 外部酒店code编码
  • └ outOrderId
  • String
  • 可选
  • 32222222222
  • 外部订单ID
  • └ tid
  • Number
  • 可选
  • 11111111122
  • 淘宝订单ID
  • └ operateType
  • Number
  • 可选
  • 1
  • 操作类型
  • └ requestId
  • String
  • 可选
  • 123122232000jjd0jf
  • 唯一请求ID,需要在结果中返回
  • queryOrderInfo
  • QueryOrderInfo
  • 可选
  • 查询订单请求
  • └ guestName
  • String
  • 可选
  • 小红
  • 客户名称
  • └ certificateNum
  • String
  • 可选
  • 124232
  • 证件号,目前支持身份证
  • └ phone
  • String
  • 可选
  • 13114533467
  • 手机号码
  • └ deviceId
  • String
  • 可选
  • 1223
  • 设备号
  • └ appName
  • String
  • 可选
  • xxx
  • 应用名
  • └ appVersion
  • String
  • 可选
  • 1.1
  • 应用版本

响应参数

名称 类型 示例值 描述
result Result 未来酒店奇门接口返回对象
  • └ success
  • Boolean
  • false
  • 是否成功
  • └ errMsg
  • String
  • 业务错误
  • 错误信息
  • └ code
  • String
  • 1
  • 错误码
  • └ responseMsg
  • String
  • {}
  • 结果上下文,根据类型不同,具体联系技术支持
  • └ flag
  • String
  • failure
  • 表示请求是否成功
  • └ outCode
  • String
  • 13
  • 外部错误码
  • └ outMsg
  • String
  • 参数异常
  • 外部错误信息
  • └ processStatus
  • Number
  • 1
  • 请求的处理状态

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoXhotelFuturehotelRequest req = new TaobaoXhotelFuturehotelRequest();
req.setMethodName("qimen");
TaobaoXhotelFuturehotelRequest.HotelFutureRQ obj1 = new TaobaoXhotelFuturehotelRequest.HotelFutureRQ();
obj1.setOid(123L);
obj1.setExt("{\"key\":\"value\"}");
obj1.setCheckOut("\"\"");
obj1.setCheckIn("\"\"");
obj1.setRoomTypeID("1");
obj1.setSourceType(1L);
obj1.setReqOutSystem(1L);
TaobaoXhotelFuturehotelRequest.SmartDeviceCtrl obj2 = new TaobaoXhotelFuturehotelRequest.SmartDeviceCtrl();
obj2.setRoomNum("1212");
obj2.setCtrlType("1");
obj1.setSmartDeviceCtrl(obj2);
TaobaoXhotelFuturehotelRequest.FaceScanInfo obj3 = new TaobaoXhotelFuturehotelRequest.FaceScanInfo();
TaobaoXhotelFuturehotelRequest.GuestInfo obj4 = new TaobaoXhotelFuturehotelRequest.GuestInfo();
obj4.setGuestName("小红");
obj4.setCertificateType(20L);
obj4.setCertificateNum("33100419900321");
obj4.setNation("汉族");
obj4.setAddress("北京");
obj4.setBase64Img("图片编码");
obj4.setDeviceId("1212");
obj4.setBirthday("1990-02-14");
obj4.setSex("男");
obj4.setSignOffice("余杭公安局");
obj4.setUsefulSDate("2018-10");
obj4.setUsefulEDate("2028-10");
obj4.setMessage("无");
obj4.setCountry("中国");
obj4.setProvince("浙江");
obj4.setCity("杭州");
obj4.setPhone("13176854561");
obj3.setGuestInfo(obj4);
obj1.setFaceScanInfo(obj3);
TaobaoXhotelFuturehotelRequest.Struct obj5 = new TaobaoXhotelFuturehotelRequest.Struct();
obj5.setRoomNum("1231");
obj5.setShortIdNumber("待定");
obj5.setHotelCode("HZ01");
obj1.setGuestBill(obj5);
TaobaoXhotelFuturehotelRequest.CheckInInfo obj6 = new TaobaoXhotelFuturehotelRequest.CheckInInfo();
obj6.setRoomNum("1211");
obj6.setDeviceId("11111111");
List<TaobaoXhotelFuturehotelRequest.GuestInfo> list8 = new ArrayList<TaobaoXhotelFuturehotelRequest.GuestInfo>();
TaobaoXhotelFuturehotelRequest.GuestInfo obj9 = new TaobaoXhotelFuturehotelRequest.GuestInfo();
list8.add(obj9);
obj9.setGuestName("小红");
obj9.setCertificateType(20L);
obj9.setCertificateNum("33100419900321");
obj9.setNation("汉族");
obj9.setAddress("北京");
obj9.setBase64Img("图片编码");
obj9.setDeviceId("122121");
obj9.setBirthday("1990-02-14");
obj9.setSex("男");
obj9.setSignOffice("余杭公安局");
obj9.setUsefulSDate("2018-10");
obj9.setUsefulEDate("2028-10");
obj9.setMessage("无");
obj9.setCountry("中国");
obj9.setProvince("浙江");
obj9.setCity("杭州");
obj9.setPhone("13587463721");
obj6.setGuestList(list8);
obj1.setCheckInInfo(obj6);
TaobaoXhotelFuturehotelRequest.RoomSelectInfo obj10 = new TaobaoXhotelFuturehotelRequest.RoomSelectInfo();
obj10.setType(1L);
obj10.setRoomTypeID("1232");
obj10.setBuildingNum("1");
obj10.setFloor("2");
obj10.setRoomNum("1221");
obj10.setOldRoomNum("1111");
obj1.setRoomSelectInfo(obj10);
TaobaoXhotelFuturehotelRequest.CheckOutInfo obj11 = new TaobaoXhotelFuturehotelRequest.CheckOutInfo();
obj11.setActionTime("2018-01-11 10:00:00");
obj11.setNeedInvoice(1L);
obj1.setCheckOutInfo(obj11);
TaobaoXhotelFuturehotelRequest.InvoiceInfo obj12 = new TaobaoXhotelFuturehotelRequest.InvoiceInfo();
obj12.setInvoiceType(1L);
obj12.setInvoiceTitle("阿里巴巴");
obj12.setTaxpayerId("12353433");
obj12.setRegAddress("杭州");
obj12.setCompanyTel("0571-88836777");
obj12.setBankName("高星支行");
obj12.setBankAccount("2343533");
obj12.setPostType(1L);
obj12.setEarllyPrepare(1L);
obj12.setProvider(1L);
obj12.setReceiverName("小王");
obj12.setReceiverMobile("13198768763");
obj12.setReceiverAddress("上海");
obj12.setWantTime("2018-01-11 09:00:00");
obj12.setComment("无");
obj1.setInvoiceInfo(obj12);
obj1.setAttributes("{\"a\":1,\"b\":2}");
obj1.setDisplayText("XXXX");
obj1.setPmsConfig("{\"a\":1,\"b\":2}");
obj1.setPmsAction(1L);
obj1.setVendor("taobao");
obj1.setSellerNick("淘酒店");
obj1.setSellerId(122222222222L);
obj1.setHid(121111L);
obj1.setHotelCode("hhhf-ff");
obj1.setOutOrderId("32222222222");
obj1.setTid(11111111122L);
obj1.setOperateType(1L);
obj1.setRequestId("123122232000jjd0jf");
TaobaoXhotelFuturehotelRequest.QueryOrderInfo obj13 = new TaobaoXhotelFuturehotelRequest.QueryOrderInfo();
obj13.setGuestName("小红");
obj13.setCertificateNum("124232");
obj13.setPhone("13114533467");
obj13.setDeviceId("1223");
obj13.setAppName("xxx");
obj13.setAppVersion("1.1");
obj1.setQueryOrderInfo(obj13);
req.setHotelFutureRQ(obj1);
TaobaoXhotelFuturehotelResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<result>
    <success>false</success>
    <errMsg>业务错误</errMsg>
    <code>1</code>
    <responseMsg>{}</responseMsg>
    <flag>failure</flag>
    <outCode>13</outCode>
    <outMsg>参数异常</outMsg>
    <processStatus>1</processStatus>
</result>

异常示例

  • 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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部