ListContacts - 查询联系人-云监控(CMS)-阿里云帮助中心

查询联系人

调试

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

授权信息

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

请求语法

GET /contact HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
pageSize	integer	否	每页大小。默认 100	100
pageNumber	integer	否	页面。默认为 1	1
contactIds	array	否	联系人 ID。
	string	否	联系人 ID。	test
name	string	否	联系人名称	test
phone	string	否	联系人手机号。	15012345678
email	string	否	联系人邮箱地址。	test@aliyun.com
groupId	string	否	联系人所在联系组 ID	group-id-123
queryUngroupedContacts	boolean	否	只查询未分组联系人。	true
workspace	string	否

返回参数

名称	类型	描述	示例值
	object	响应内容结构
contacts	array<object>	联系人列表。
	array<object>	联系人详情。
contactId	string	值班人 ID。	test
email	string	联系人邮箱地址。	test@aliyun.com
emailVerify	boolean	邮箱是否已激活。	true
groupList	array	联系人所在联系组。
	string	联系人所在联系组。	groupId
lang	string	语言。	zh_CN
name	string	联系人名称。	test
phone	string	联系人手机号。	130123456789
phoneVerify	boolean	联系人手机号是否已激活。	true
updateTime	string	更新时间。	2024-10-22 02:21:51
imUserIds	object	IM 用户 ID 映射，支持多种即时通讯工具
	string	IM 用户 ID 映射，支持多种即时通讯工具	{"dingtalk": "abc123", "wechat": "def456"}
workspace	string
pageNumber	integer	页面。默认为 1	1
pageSize	integer	每页大小。默认 100	20
requestId	string	Id of the request	8FDE2569-626B-5176-9844-28877A*****
total	integer	总记录数	56

示例

正常返回示例

JSON格式

{
  "contacts": [
    {
      "contactId": "test",
      "email": "test@aliyun.com",
      "emailVerify": true,
      "groupList": [
        "groupId"
      ],
      "lang": "zh_CN",
      "name": "test",
      "phone": "130123456789",
      "phoneVerify": true,
      "updateTime": "2024-10-22 02:21:51",
      "imUserIds": {
        "key": "{\"dingtalk\": \"abc123\", \"wechat\": \"def456\"}"
      },
      "workspace": ""
    }
  ],
  "pageNumber": 1,
  "pageSize": 20,
  "requestId": "8FDE2569-626B-5176-9844-28877A*****",
  "total": 56
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	%s is missing or invalid.	参数%s缺失或不合法。
500	InternalUnknownError	The request processing has failed due to some unknown error.	服务运行错误。

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

变更历史

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