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

alipay.eco.cplife.community.details.query (查询单个物业小区信息)

开发者查询自己帮助物业创建的指定小区详细信息

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.community.details.query
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
community_id String 必须 32 支付宝社区小区统一编号,必须在物业账号名下存在。 AJ5OFJC124403

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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_status String 必填 64 小区当前状态,状态值:
PENDING_ONLINE 待上线
ONLINE - 上线
MAINTAIN - 维护中
OFFLINE - 下线

新创建的小区为PENDING_ONLINE待上线状态,需要尽快初始化基础服务,完成开发和验证,并提交服务上线申请。由支付宝小二审核通过后完成服务和小区上线。
ONLINE
next_action String 选填 64 若从小区当前状态到下一状态需要完成下一步条件代码,则返回该字段,否则不返回。

操作主体有:
INVOKER - 接口调用方
MERCHANT - 物业公司
AUDITOR - 平台审核方

条件代码包括但不限于:
WAIT_SERVICE_PROVISION - 等待基础服务初始化
WAIT_PROD_VERIFICATION - 等待在生产环境通过自测
WAIT_ONLINE_APPLICATION - 等待提起上线申请
WAIT_OFFLINE_APPLICATION - 等待提起下线申请
WAIT_CONFIRMATION - 等待相关方确认
WAIT_AUDITING - 等待审核
WAIT_PROD_VERIFICATION|MERCHANT
audit_status String 选填 64 小区审核状态,小区审核状态关联小区主服务的审核状态:
AUDITING:审核中;
AUDIT_FAILED:审核驳回;
AUDIT_SUCCESS:审核通过。
AUDITING
out_community_id String 选填 32 小区在物业系统中的唯一编号,若开发者传入过,则返回。 12345
merchant_pid String 必填 32 小区对应的物业公司支付宝账号PID(合作伙伴partner id)。 2088501624560333
merchant_firm_name String 选填 256 小区关联的物业公司名称 锦绣物业管理有限公司
community_name String 必填 32 小区名称。 金海湾花园
community_address String 必填 128 小区主要详细地址,不需要包含省市区名称。 福荣路46号
district_code String 必填 10 区县编码,国标码,详见国家统计局数据 点此下载 440304
city_code String 必填 10 地级市编码,国标码,详见国家统计局数据 点此下载 440300
province_code String 必填 10 省份编码,国标码,详见国家统计局数据 点此下载 440000
community_locations String [] 必填 150 小区所在的经纬度列表(注:需要是高德坐标系),每对经纬度用"|"分隔,经度在前,纬度在后。

注:若新建的小区覆盖多个片区,最多包含5组经纬度,其中第一组作为主经纬度。
114.032395|22.519725,114.032469|22.519336
associated_pois String [] 选填 160 开发者关联的高德地图中住宅、住宿或地名地址等小区相关类型的POI(地图兴趣点)ID列表和POI名称,中间用"|"分隔。 B02F37VVFP|金海湾花园一期,B0FFFQB4Y4|金海湾花园二期
hotline String 必填 20 物业服务热线或联系电话,便于用户在需要时联系物业。 0571-87654321
isv_pid String 选填 32 若开发者和支付宝签署了相关协议,会返回开发者的PID(Partner ID)。 2088123456781234
qr_code_image String 选填 512 若小区上线后,返回小区主页推广二维码图片链接 https://test.cloud.alipay.com/test/QR***QhXXhBe
community_services CPCommServices [] 选填 - 小区已初始化的服务列表
  • └ service_type
  • String
  • 必填
  • 32
  • 服务类型
  • PROPERTY_PAY_BILL_MODE
  • └ category_name
  • String
  • 选填
  • 64
  • 服务对应的前台类目名称
  • 物业缴费
  • └ external_invoke_address
  • String
  • 必填
  • 512
  • 由开发者系统提供的,支付宝根据基础服务类型在特定业务环节调用的外部系统服务地址。
  • https://example.com/gateway.do
  • └ external_address_scan_result
  • String
  • 选填
  • 256
  • 该字段可选,若对于外部调用地址巡检失败,会返回失败状态。
  • FAILURE|Error Message:SSL Certificate Error.
  • └ account_type
  • String
  • 选填
  • 32
  • 若当前服务涉及收费,则返回收款帐号类型。
  • ALIPAY_LOGON_ID
  • └ account
  • String
  • 选填
  • 64
  • 对于涉及收费类型的服务,返回收款帐号,若开发者没有为当前服务传入过物业收款帐号,则默认为授权物业的签约账号。
  • 2088501624560333
  • └ status
  • String
  • 必填
  • 64
  • 服务当前状态
  • OFFLINE
  • └ next_action
  • String
  • 选填
  • 64
  • 若从当前状态到下一状态需要完成下一步条件代码,则返回该字段,否则不返回。
  • WAIT_PROD_VERIFICATION|MERCHANT
  • └ audit_status
  • String
  • 选填
  • 64
  • 服务审核状态。
  • AUDITING
  • └ audit_desc
  • String
  • 选填
  • 256
  • 服务审核状态描述,如果审核驳回则有相关的驳回理由。
  • 提供服务的主体与实际情况不符。
  • └ service_expires
  • Date
  • 选填
  • 20
  • 本服务预计过期时间(如在物业服务合同中约定),按标准时间格式:yyyy-MM-dd HH:mm:ss返回。
  • 2017-12-31 23:59:59
  • └ qr_code_image
  • String
  • 选填
  • 512
  • 为满足特定的服务类型在上线前后的不同阶段需要进行测试验证等目的,选择性返回能直达具体服务的二维码图片链接。用支付宝手机客户端扫一扫该链接,完成验证工作。
  • https://test.cloud.alipay.com/test/QR***QhXXhBe
  • └ qr_code_type
  • String
  • 选填
  • 32
  • 若返回qr_code_image,则同时返回对应的类型,类型值为:
    TEST - 用于上线前验证的临时二维码;
    FORMAL - 上线后可用于推广的正式二维码(仅针对部分服务类型);
  • TEST
  • └ qr_code_expires
  • Date
  • 选填
  • 20
  • 若qr_code_image二维码存在有效期,则返回。
  • 2017-12-31 23:59:59
  • └ gmt_created
  • Date
  • 必填
  • 32
  • 服务初始化时间
  • 2016-12-15 16:56:45
  • └ gmt_modified
  • Date
  • 必填
  • 32
  • 服务最近修改时间(包括状态变更)。
  • 2016-12-15 19:21:11
gmt_created Date 必填 32 小区创建时间 2016-12-15 16:56:45
gmt_modified Date 必填 32 小区最近修改时间(包括状态变更)。 2016-12-15 19:21:11

请求示例

  • 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");
AlipayEcoCplifeCommunityDetailsQueryRequest request = new AlipayEcoCplifeCommunityDetailsQueryRequest();
request.setBizContent("{" +
"\"community_id\":\"AJ5OFJC124403\"" +
"  }");
AlipayEcoCplifeCommunityDetailsQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_community_details_query_response":{
		"msg":"Success",
		"code":"10000",
		"qr_code_image":"https://test.cloud.alipay.com/test/QR***QhXXhBe",
		"community_services":[
			{
				"account_type":"ALIPAY_LOGON_ID",
				"category_name":"物业缴费",
				"qr_code_image":"https://test.cloud.alipay.com/test/QR***QhXXhBe",
				"external_address_scan_result":"FAILURE|Error Message:SSL Certificate Error.",
				"audit_status":"AUDITING",
				"service_expires":"2017-12-31 23:59:59",
				"gmt_modified":"2016-12-15 19:21:11",
				"audit_desc":"提供服务的主体与实际情况不符。",
				"qr_code_expires":"2017-12-31 23:59:59",
				"service_type":"PROPERTY_PAY_BILL_MODE",
				"external_invoke_address":"https://example.com/gateway.do",
				"next_action":"WAIT_PROD_VERIFICATION|MERCHANT",
				"qr_code_type":"TEST",
				"account":"2088501624560333",
				"gmt_created":"2016-12-15 16:56:45",
				"status":"OFFLINE"
			}
		],
		"community_name":"金海湾花园",
		"hotline":"0571-87654321",
		"community_address":"福荣路46号",
		"city_code":"440300",
		"community_locations":[
			"114.032395|22.519725",
			"114.032469|22.519336"
		],
		"audit_status":"AUDITING",
		"out_community_id":"12345",
		"province_code":"440000",
		"gmt_modified":"2016-12-15 19:21:11",
		"merchant_firm_name":"锦绣物业管理有限公司",
		"community_status":"ONLINE",
		"isv_pid":"2088123456781234",
		"merchant_pid":"2088501624560333",
		"associated_pois":[
			"B02F37VVFP|金海湾花园一期",
			"B0FFFQB4Y4|金海湾花园二期"
		],
		"district_code":"440304",
		"next_action":"WAIT_PROD_VERIFICATION|MERCHANT",
		"gmt_created":"2016-12-15 16:56:45"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 稍后重试。
COMMUNITY_NOT_EXISTING 请求的小区编号在当前物业账号名下不存在。 请通过批量查询支付宝小区编号接口确认授权物业公司账号名下是否存在该小区编号,修改并重试。

公共错误码

返回
顶部