文档中心 > API类目 > 小程序API

alipay.open.app.members.query (应用查询成员列表)

应用查询成员列表,目前只支持小程序类型的应用

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
role String 可选 16 成员的角色类型,DEVELOPER-开发者,EXPERIENCER-体验者 DEVELOPER

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
app_member_info_list AppMemberInfo [] 必填 - 小程序成员模型
  • └ user_id
  • String
  • 必填
  • 16
  • 支付宝用户id
  • 20881234123412341234
  • └ nick_name
  • String
  • 必填
  • 32
  • 昵称
  • 张三
  • └ portrait
  • String
  • 必填
  • 256
  • 头像地址
  • http://imageg.alipay.com/1
  • └ status
  • String
  • 必填
  • 16
  • 成员的状态,VALID-有效,UNCONFIRMED-未确认,TIMEOUT-已经失效,REFUSED-用户拒绝
  • VALID
  • └ gmt_join
  • String
  • 必填
  • 32
  • 加入时间
  • 2017-08-12
  • └ logon_id
  • String
  • 必填
  • 128
  • 支付宝登录账号
  • test@e*****e.com
  • └ gmt_invite
  • String
  • 必填
  • 32
  • 邀请时间
  • 2017-09-08 12:00:00
  • └ role
  • String
  • 必填
  • 16
  • 角色类型
  • DEVELOPER

请求示例

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

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_open_app_members_query_response":{
		"msg":"Success",
		"code":"10000",
		"app_member_info_list":[
			{
				"gmt_invite":"2017-09-08 12:00:00",
				"logon_id":"test@e*****e.com",
				"role":"DEVELOPER",
				"gmt_join":"2017-08-12",
				"user_id":"20881234123412341234",
				"nick_name":"张三",
				"portrait":"http://imageg.alipay.com/1",
				"status":"VALID"
			}
		]
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 请稍后重试,或者联系技术人员解决
INVALID_ROLE 非法的角色类型 请输入合法的角色类型
APPLICATION_TYPE_NOT_MINIAPP 该应用不是小程序类型 请使用小程序类型的应用

公共错误码

返回
顶部