查询外部联系人列表接口

最近更新时间：2024-03-12 02:05:14

我的收藏

本页目录：

1. 接口描述

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

企业可通过此接口基于外部联系人获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员，所添加的外部联系人将不会作为客户返回。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 查询外部联系人列表

输入示例

https://wav.tencentcloudapi.com/?Action=QueryExternalContactList
&Cursor=sHmJbhJZhCwwMYmSot50dl2Hs9qQvbP+pCUVxlm/oLU=
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "NextCursor": "sHmJbhJZhCwwMYmSot50dl2Hs9qQvbP+pCUVxlm/oLU=",
        "PageData": [
            {
                "SalesName": "杨过",
                "UserId": "YangGuo",
                "ExternalUserId": "wmpqy2CAAATGwpQTxuU1IUfoiOFH2cXA",
                "DepartmentIdList": [
                    0,
                    1
                ]
            }
        ],
        "RequestId": "b1a024bf-4d74-4b5d-a5bd-bbec330520e8"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.InvalidAuthorizationCode	授权码无效。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。

上一篇: 查询外部联系人详情接口下一篇: 查询外部联系人事件明细列表接口