文档

ListContact - 获取联系人列表

更新时间:

获取联系人列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Keywordstring

搜索关键词。例如姓名、邮箱和电话中的关键字。

186
ShowSizeinteger

分页查询时,设置每页显示联系人的个数。

20
CurrentPageinteger

分页,当前页,默认 1。

1

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

31C66C7B-671A-4297-9187-2C4477247A74
TotalCountlong

搜索总数量。

12
ShowSizeinteger

分页查询时,设置每页显示证书的数量。默认值为 20

20
CurrentPageinteger

分页查询时,设置当前页面的页码。默认值为 1

1
Keywordstring

模糊查询关键词。

186
ContactListarray<object>

联系人列表。

object

联系人对象。

ContactIdlong

联系人 ID。

519580
Namestring

联系人姓名。

张三
Mobilestring

手机号码。

139****8888
MobileStatusinteger

手机号码是否被验证。

1
Emailstring

联系人电子邮件地址。

username@example.com
EmailStatusinteger

邮件地址是否被通过验证。

1
Webhooksstring

机器人地址。

[\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\",\"https://oapi.dingtalk.com/robot/send?access_token=XXX\",\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\"]

示例

正常返回示例

JSON格式

{
  "RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 12,
  "ShowSize": 20,
  "CurrentPage": 1,
  "Keyword": "186",
  "ContactList": [
    {
      "ContactId": 519580,
      "Name": "张三",
      "Mobile": "139****8888",
      "MobileStatus": 1,
      "Email": "username@example.com",
      "EmailStatus": 1,
      "Webhooks": "[\\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\\",\\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\\",\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\\"]"
    }
  ]
}

错误码

访问错误中心查看更多错误码。