[文档在讲什么] - [产品名]

获取联系人列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:ListContact

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Keyword	string	否	搜索关键词。例如姓名、邮箱和电话中的关键字。	186
ShowSize	integer	否	分页查询时，设置每页显示联系人的个数。	20
CurrentPage	integer	否	分页，当前页，默认 1。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	31C66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	搜索总数量。	12
ShowSize	integer	分页查询时，设置每页显示证书的数量。默认值为 20。	20
CurrentPage	integer	分页查询时，设置当前页面的页码。默认值为 1。	1
Keyword	string	模糊查询关键词。	186
ContactList	array<object>	联系人列表。
	object	联系人对象。
ContactId	integer	联系人 ID。	519580
Name	string	联系人姓名。	John
Mobile	string	手机号码。	139****8888
MobileStatus	integer	手机号码是否被验证。	1
Email	string	联系人电子邮件地址。	username@example.com
EmailStatus	integer	邮件地址是否被通过验证。	1
Webhooks	string	机器人地址。	[\"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": "John",
      "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\\\"]"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。