1. 接口描述
接口请求域名: wav.tencentcloudapi.com 。
通过接口拉取租户已有潜客客户档案列表信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:QueryCustomerProfileList。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Limit | 是 | Integer | 分页,预期请求的数据量,取值范围 1 ~ 1000 示例值:100 |
BeginTime | 是 | Integer | 查询开始时间, 单位秒 示例值:1647187200 |
EndTime | 是 | Integer | 查询结束时间, 单位秒 示例值:1647273600 |
Cursor | 否 | String | 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填 示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw= |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NextCursor | String | 分页游标,下次调用带上该值,则从当前的位置继续往后拉,以实现增量拉取。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw |
PageData | Array of CustomerProfile | 潜客客户存档信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询潜客客户存档信息
用于查询潜客客户存档信息
输入示例
POST / HTTP/1.1
Host: wav.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryCustomerProfileList
<公共请求参数>
{
"Cursor": "2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=",
"Limit": 100,
"BeginTime": 1647187200,
"EndTime": 1647273600
}
输出示例
{
"Response": {
"NextCursor": "2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=",
"PageData": [
{
"CustomerId": 1234567890,
"DealerCode": "abc",
"UnionId": "ozynqsulJFCZ2z1aYeS8h",
"CreateTime": "2023-01-01 00:00:00",
"UserName": "张三",
"Gender": 1,
"Phone": "123****4567",
"AgeRangeName": "26-30",
"JobTypeName": "abc",
"Address": "地址1",
"LeadsProcessStatus": 0,
"LeadType": 1,
"SourceName": "自然到店",
"LeadsLevelCode": "101",
"VehicleBrandCode": "品牌编号",
"VehicleSeriesCode": "车系编号",
"VehicleTypeCode": "车型编号",
"VehiclePurpose": {
"VehiclePurposeCode": "abc",
"VehiclePurposeName": "abc"
},
"PurchaseConcern": [
{
"Code": "abc",
"Description": "abc"
}
],
"SalesName": "张三",
"SalesPhone": "123****4567",
"RealArrivalTime": 1618322621,
"CompleteTestDriveTime": "2023-01-01 00:00:00",
"OrderTime": 1618322621,
"DeliveryTime": 1618322621,
"InvoiceTime": 1618322621,
"LoseTime": 1618322621,
"CreatedAtTime": 1618322621,
"ImportAtTime": 1618322621,
"DistributeTime": 1618322621,
"LeadCreateTime": 1618322621,
"Nickname": "jack",
"OrgIdList": [
"1"
],
"Introducer": "李四",
"IntroducerPhone": "123****4567",
"FollowTime": 1618322621,
"NextFollowTime": 1618322621,
"EnterpriseTags": [
{
"GroupName": "标签分组名称",
"TagName": "标签名称",
"TagId": "etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"
}
],
"ChannelTags": [
{
"TagName": "abc",
"TagId": "etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"
}
],
"LeadId": 1348080105398452200,
"WxId": "李四_1234",
"Position": "销售",
"IsBindWx": 1,
"IsInvalid": 1,
"InvalidType": "001",
"InvalidTypeName": "无效",
"InvalidTime": 1618322621,
"InvalidRemark": "无效",
"IsLose": 1,
"LoseType": "001",
"LoseTypeName": "战败",
"LoseRemark": "战败"
}
],
"RequestId": "fea177dd-9fa6-4e76-9c8f-67f5a21f20bb"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.InvalidAuthorizationCode | 授权码无效。 |
FailedOperation.OpenPlatformError | 开放平台访问错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
UnknownParameter | 未知参数错误。 |