查询客户名单详情(QueryCustomerManagementDetail)

更新时间:
复制为 MD 格式

根据客户名单 ID 查询客户名单详情,包括名单名称、客户总数、有效/无效客户数、上传状态等信息。

前提条件

请求参数

名称

类型

必填

描述

示例值

Action

String

要执行的操作。取值:QueryCustomerManagementDetail

QueryCustomerManagementDetail

Version

String

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

固定为2025-11-27

CustomerListId

Number

客户名单 ID

1001

响应参数

名称

类型

描述

示例值

RequestId

String

请求ID。

xxxx-xxxx-xxxx

Success

Boolean

请求是否成功。

True

Code

String

错误码。请求成功时为空。

None

Message

String

错误信息或成功提示。

操作成功

Data

Object

返回数据,包含CustomerListId, CustomerListName, TotalCustomers, ValidCustomers, InvalidCustomers, Status, FileUrl, 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="QueryCustomerManagementDetail",
        method="POST",
        pathname="/",
        protocol="HTTPS",
        auth_type="AK",
        req_body_type="json",
        body_type="json",
    )

    body = {'CustomerListId': 1001}

    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("QueryCustomerManagementDetail")
            .setMethod("POST")
            .setPathname("/")
            .setProtocol("HTTPS")
            .setAuthType("AK")
            .setReqBodyType("json")
            .setBodyType("json");

        // 构建请求参数
        Map<String, Object> body = new HashMap<>();
        body.put("CustomerListId", 1);

        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": null,
  "Message": "操作成功",
  "RequestId": "xxxx-xxxx-xxxx",
  "Data": {
    "CustomerListId": 1001,
    "CustomerListName": "VIP客户名单",
    "TotalCustomers": 500,
    "ValidCustomers": 490,
    "InvalidCustomers": 10,
    "Status": "SUCCESS",
    "FileUrl": "https://oss.aliyuncs.com/xxx/customers.xlsx",
    "GmtCreate": "2025-01-10 10:00:00",
    "GmtModified": "2025-01-15 14:30:00"
  }
}

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

名称

类型

描述

示例值

CustomerListId

Number

客户名单ID

1001

CustomerListName

String

客户名单名称

VIP客户名单

TotalCustomers

Number

客户总数

500

ValidCustomers

Number

有效客户数

490

InvalidCustomers

Number

无效客户数

10

Status

String

状态:UPLOADING-上传中,SUCCESS-成功,FAILED-失败

SUCCESS

FileUrl

String

文件URL

https://oss.aliyuncs.com/xxx/customers.xlsx

GmtCreate

String

创建时间

2025-01-10 10:00:00

GmtModified

String

修改时间

2025-01-15 14:30:00

错误信息

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