文档中心 > API类目 > 社区物业API

alipay.eco.cplife.roominfo.upload (上传物业小区内部房屋信息.)

物业公司使用该接口将小区内的房屋列表上传至支付宝平台,以便物业缴费,业主认证等场景中,用户能够正常选择所属的房号。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.roominfo.upload
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
batch_id String 必须 64 请求批次号,由商户自定义,在商户系统内唯一标示一次业务请求。 201609201730123754
community_id String 必须 32 业主所在物业小区ID(支付宝平台唯一小区ID标示) AJ5OFJC443301
room_info_set CplifeRoomInfo [] 必须 - 待上传的房屋信息列表,单次上传不超过200条.
  • └ out_room_id
  • String
  • 必填
  • 64
  • 商户系统小区房屋唯一ID标示.
  • 20160427110001006778440713
  • └ group
  • String
  • 可选
  • 32
  • 房屋所在的组团名称。例如“一期”,“东区”,“香桂苑”等
  • 一期
  • └ building
  • String
  • 必填
  • 32
  • 房屋所在楼栋名称。例如“1栋”,“1幢”等
  • 1栋
  • └ unit
  • String
  • 可选
  • 32
  • 房屋所在单元名称。例如“一单元”,“二单元”等
  • 1单元
  • └ room
  • String
  • 必填
  • 64
  • 房屋所在房号。例如“1101室”,“11B室”等
  • 1101室
  • └ address
  • String
  • 必填
  • 128
  • 房间的完整门牌地址
  • 一期1栋2单元2202室

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
community_id String 必填 32 业主所在物业小区ID(支付宝平台唯一小区ID标示) AJ5OFJC443301
room_info_set CplifeRoomInfoResp [] 必填 - 已经成功上传的房屋信息列表.
  • └ out_room_id
  • String
  • 必填
  • 64
  • 商户系统小区房屋唯一ID标示.
  • 20160427110001006778440713
  • └ room_id
  • String
  • 必填
  • 64
  • 支付宝系统房间唯一标示.
  • APCN4644RON5113220100102

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoCplifeRoominfoUploadRequest request = new AlipayEcoCplifeRoominfoUploadRequest();
request.setBizContent("{" +
"\"batch_id\":\"201609201730123754\"," +
"\"community_id\":\"AJ5OFJC443301\"," +
"      \"room_info_set\":[{" +
"        \"out_room_id\":\"20160427110001006778440713\"," +
"\"group\":\"一期\"," +
"\"building\":\"1栋\"," +
"\"unit\":\"1单元\"," +
"\"room\":\"1101室\"," +
"\"address\":\"一期1栋2单元2202室\"" +
"        }]" +
"  }");
AlipayEcoCplifeRoominfoUploadResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_roominfo_upload_response":{
		"msg":"Success",
		"community_id":"AJ5OFJC443301",
		"code":"10000",
		"room_info_set":[
			{
				"room_id":"APCN4644RON5113220100102",
				"out_room_id":"20160427110001006778440713"
			}
		]
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"alipay_eco_cplife_roominfo_upload_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 根据接口文档校验并修改参数后重新请求
SYSTEM_ERROR 系统繁忙 系统可能还在处理中,请稍后调用查询小区房屋信息列表接口确认房间是否上传成功。若未成功,请稍后重试。
ITEM_UNIQUENESS_VIOLATION 请求数据不满足业务唯一性约束 请检查物业系统端房屋编号参数是否满足唯一性要求,修改并重试。
COMMUNITY_NOT_EXISTING 请求的小区在社区物业平台该商户名下不存在 请至社区物业平台小区管理列表中检查该商户下是否有对应ID的小区。
EXCEED_MAXIMUM_BATCH_SIZE 上传用户数超出系统限制 一次仅允许上传不超过200条房屋信息,请修改参数后重新提交.

公共错误码

返回
顶部