有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

接口请求域名: wav.tencentcloudapi.com 。

企业可通过传入起始和结束时间,获取该时间段的外部联系人详情列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryExternalContactDetailByDate。
Version String 公共参数,本接口取值:2021-01-29。
Region String 公共参数,详见产品支持的 地域列表
BeginTime Integer 查询结束时间, 单位秒
示例值:1672502400
EndTime Integer 查询结束时间, 单位秒
示例值:1672588800
Cursor String 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填
示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=
Limit Integer 返回的最大记录数,整型,最大值100,默认值50,超过最大值时取最大值
示例值:100

3. 输出参数

参数名称 类型 描述
NextCursor String 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空
注意:此字段可能返回 null,表示取不到有效值。
示例值:2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=
PageData Array of ExternalContactDetailPro 外部联系人详细信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指定时间内外部联系人详情

通过时间段查询外部联系人详情

输入示例

POST / HTTP/1.1
Host: wav.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryExternalContactDetailByDate
<公共请求参数>

{
    "Cursor": "2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=",
    "Limit": 100,
    "BeginTime": 1647187200,
    "EndTime": 1647273600
}

输出示例

{
    "Response": {
        "NextCursor": "2Kgdu51quLaeNJSlwb79im883bftBE9d9Emju5I2MVw=",
        "PageData": [
            {
                "Customer": {
                    "ExternalUserId": "wmQIM2CwAAE-JSOVGMzsRayI3ow5kGzQ",
                    "Gender": 1,
                    "Name": "文",
                    "Type": 1,
                    "UnionId": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
                    "Phone": "134****3232"
                },
                "FollowUser": [
                    {
                        "UserId": "rocky",
                        "Remark": "备注",
                        "Description": "描述",
                        "CreateTime": 1618322621,
                        "AddWay": 0,
                        "OperUserId": "wmQIM2CwAAE-JSOVGMzsRayI3ow5kGzQ",
                        "Tags": [
                            {
                                "GroupName": "标签分组名称",
                                "TagName": "标签名称",
                                "Type": 1,
                                "TagId": "etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"
                            }
                        ],
                        "SalesName": "张三",
                        "DepartmentIdList": [
                            0
                        ]
                    }
                ]
            }
        ],
        "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.InvalidAuthorizationCode 授权码无效。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。


http://www.vxiaotou.com