查询客户名单列表(QueryCustomerManagementList)

更新时间:
复制为 MD 格式

分页查询客户名单列表,支持按名单名称模糊搜索,按创建时间倒序返回。

前提条件

请求参数

名称

类型

必填

描述

示例值

Action

String

要执行的操作。取值:QueryCustomerManagementList

QueryCustomerManagementList

Version

String

API版本号。格式为:YYYY-MM-DD。取值:2025-11-27

固定为2025-11-27

CustomerListName

String

客户名单名称,支持模糊搜索。

VIP客户

Current

Number

当前页码,默认1。

1

Size

Number

每页条数,默认10。

10

响应参数

名称

类型

描述

示例值

RequestId

String

请求ID。

xxxx-xxxx-xxxx

Success

Boolean

请求是否成功。

True

Code

String

错误码。请求成功时取值为SUCCESS。

SUCCESS

Message

String

错误信息或成功提示。

操作成功

Total

Long

总记录数。

2

Current

Long

当前页码。

1

Size

Long

每页条数。

10

Records

Array

返回数据,包含Id, CustomerListName, CustomerListCount, IsUsed, GmtCreate, GmtModified等字段,具体说明请参见下方返回参数说明。

使用示例

Python

import json
import os
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_util import models as util_models
from alibabacloud_openapi_util.client import Client as OpenApiUtilClient


def main():
    config = open_api_models.Config(
        access_key_id=os.getenv("ACCESS_KEY_ID"),
        access_key_secret=os.getenv("ACCESS_KEY_SECRET"),
    )
    config.endpoint = "thirdswaicall.aliyuncs.com"
    config.protocol = "HTTPS"
    client = OpenApiClient(config)

    params = open_api_models.Params(
        style="RPC",
        version="2025-11-27",
        action="QueryCustomerManagementList",
        method="POST",
        pathname="/",
        protocol="HTTPS",
        auth_type="AK",
        req_body_type="json",
        body_type="json",
    )

    body = {'Current': 1, 'Size': 10}
    # body['CustomerListName'] = 'VIP客户'  # 可选

    request = open_api_models.OpenApiRequest(query=OpenApiUtilClient.query(body))
    runtime = util_models.RuntimeOptions(autoretry=True, max_attempts=3)
    try:
        resp = client.call_api(params, request, runtime)
        print(json.dumps(resp.get("body", {}), ensure_ascii=False, indent=2))
    except Exception as e:
        print(f"调用失败: {e}")


if __name__ == "__main__":
    main()

Java

import com.aliyun.teaopenapi.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teaopenapi.models.OpenApiRequest;
import com.aliyun.teaopenapi.models.Params;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;

import java.util.HashMap;
import java.util.Map;

public class Demo {
    public static void main(String[] args) throws Exception {
        // 初始化配置
        Config config = new Config()
            .setAccessKeyId(System.getenv("ACCESS_KEY_ID"))
            .setAccessKeySecret(System.getenv("ACCESS_KEY_SECRET"))
            .setEndpoint("thirdswaicall.aliyuncs.com")
            .setProtocol("HTTPS");

        Client client = new Client(config);

        // 设置 API 参数
        Params params = new Params()
            .setStyle("RPC")
            .setVersion("2025-11-27")
            .setAction("QueryCustomerManagementList")
            .setMethod("POST")
            .setPathname("/")
            .setProtocol("HTTPS")
            .setAuthType("AK")
            .setReqBodyType("json")
            .setBodyType("json");

        // 构建请求参数
        Map<String, Object> body = new HashMap<>();
        body.put("Current", 1);
        body.put("Size", 10);
        // body.put("CustomerListName", "VIP客户");  // 可选

        OpenApiRequest request = new OpenApiRequest()
            .setQuery(com.aliyun.openapiutil.Client.query(body));

        // 设置运行时选项(自动重试)
        RuntimeOptions runtime = new RuntimeOptions()
            .setAutoretry(true)
            .setMaxAttempts(3);

        try {
            // 调用 API
            Map<String, ?> response = client.callApi(params, request, runtime);
            Gson gson = new Gson();
            System.out.println(gson.toJson(response.get("body")));
        } catch (Exception e) {
            System.err.println("调用失败: " + e.getMessage());
        }
    }
}

返回示例

{
  "Success": true,
  "Code": "SUCCESS",
  "Message": "操作成功",
  "RequestId": "xxxx-xxxx-xxxx",
  "Total": 2,
  "Current": 1,
  "Size": 10,
  "Records": [
    {
      "Id": 1001,
      "CustomerListName": "VIP客户名单",
      "CustomerListCount": 500,
      "IsUsed": "1",
      "GmtCreate": "2025-12-01 10:00:00",
      "GmtModified": "2025-12-01 10:05:00"
    },
    {
      "Id": 1002,
      "CustomerListName": "春节促销名单",
      "CustomerListCount": 1200,
      "IsUsed": "0",
      "GmtCreate": "2025-12-15 14:30:00",
      "GmtModified": "2025-12-15 14:30:00"
    }
  ]
}

具体的处理结果在Records节点中,以下为Records节点的参数说明。

名称

类型

描述

示例值

Id

Number

客户名单ID。

1001

CustomerListName

String

客户名单名称。

VIP客户名单

CustomerListCount

Number

名单中的号码数量。

500

IsUsed

String

是否被外呼任务使用。0:未使用,1:已被使用。

1

GmtCreate

String

创建时间。

2025-12-01 10:00:00

GmtModified

String

最后修改时间。

2025-12-15 14:30:00

错误信息

如果执行报错,请参考错误信息进行解决。