alipay.open.public.group.batchquery(查询用户分组列表) 在线调试(沙箱环境)

使用该接口查询分组列表,并配合其它分组管理接口使用

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.group.batchquery
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值

响应参数

参数 类型 是否必填 最大长度 描述 示例值
groups QueryGroup 必填 用户分组列表,包含每个分组的id、name、以及规则模型
id String 必填 30 分组id 100
name String 必填 30 用户分组名称 测试分组
label_rule QueryComplexLabelRule[] 必填 10 分组中的圈人规则
label_id String 必填 30 标签id 10000
label_name String 必填 30 标签名 职业
operator String 必填 10 运算符 EQ
label_value String 必填 120 当有多个取值时用英文","分隔,不允许传入下划线"_"、竖线"|"或者空格" " 程序员

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicGroupBatchqueryRequest request = new AlipayOpenPublicGroupBatchqueryRequest();
AlipayOpenPublicGroupBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_group_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "groups": [
            {
                "id": "100",
                "name": "测试分组",
                "label_rule": [
                    {
                        "label_id": "10000",
                        "label_name": "职业",
                        "operator": "EQ",
                        "label_value": "程序员"
                    }
                ]
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 重试
onlineServer