文档

ListContact - 获取联系人列表

更新时间:

获取联系人列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cert:ListContactList
  • acs:yundun-cert:*:{#accountId}:*

请求参数

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

搜索关键词。

186
ShowSizeinteger

分页查询时,设置每页包含已被吊销证书的数量。默认值为 20

20
CurrentPageinteger

分页,当前页,默认 1。

1

返回参数

名称类型描述示例值
object
RequestIdstring

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

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

搜索总数量。

12
ShowSizeinteger

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

20
CurrentPageinteger

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

1
Keywordstring

模糊查询关键词。

186
ContactListobject []

联系人列表。

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\\\"]"
    }
  ]
}

错误码

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

  • 本页导读 (1)