调用ListMessageContacts查询联系人列表-阿里云帮助中心

查询联系人列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ContactId	string	否	联系人 ID。	c-qL4HqKONzOM7****
Member	string	否	绑定目标 ID。取值：资源目录 ID。资源夹 ID。成员 ID。	fd-ZDNPiT****
PageNumber	integer	否	页码。	1
PageSize	integer	否	分页时每页显示的数据条数。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	95060F1D-6990-4645-8920-A81D1BBFE992
TotalCount	integer	数据总条数。	20
PageSize	integer	分页时每页显示的数据条数。	10
PageNumber	integer	页码。	1
Contacts	object []	消息联系人列表。
ContactId	string	联系人 ID。	c-qL4HqKONzOM7****
Name	string	联系人的名称。	tom
EmailAddress	string	联系人的邮箱地址。	someone***@example.com
PhoneNumber	string	联系人的手机号码。	86-139****1234
Title	string	联系人的职位。	TechnicalDirector
MessageTypes	array	联系人接收的消息分类。
	string	联系人接收的消息分类。	AccountExpenses
Members	array	绑定目标。
	string	绑定目标。	fd-ZDNPiT****
Status	string	联系人状态。取值： Verifying：待验证。 Active：生效。 Deleting：删除中。	Active
CreateDate	string	添加联系人的时间。	2023-03-27 17:19:21
AssociatedDate	string	绑定联系人的时间。	2023-03-27 17:19:21

示例

正常返回示例

JSON格式

{
  "RequestId": "95060F1D-6990-4645-8920-A81D1BBFE992",
  "TotalCount": 20,
  "PageSize": 10,
  "PageNumber": 1,
  "Contacts": [
    {
      "ContactId": "c-qL4HqKONzOM7****",
      "Name": "tom",
      "EmailAddress": "someone***@example.com",
      "PhoneNumber": "86-139****1234",
      "Title": "TechnicalDirector",
      "MessageTypes": [
        "AccountExpenses"
      ],
      "Members": [
        "fd-ZDNPiT****"
      ],
      "Status": "Active",
      "CreateDate": "2023-03-27 17:19:21",
      "AssociatedDate": "2023-03-27 17:19:21"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.ContactId	The ContactId is invalid.	ContactId无效。
400	InvalidParameter.Member	The Member is invalid.	Member参数无效。
404	EntityNotExists.Contact	This Contact does not exist.	Contact不存在。
404	EntityNotExists.Member	This Member does not exist.	成员对象不存在。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史