ListContact - Certificate Management Service - Alibaba Cloud Documentation Center

Queries a list of contacts.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:ListContact	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword used in the query. For example, you can specify a keyword in names, email addresses, and mobile phone numbers.	186
ShowSize	integer	No	The number of contacts per page.	20
CurrentPage	integer	No	The page number. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	31C66C7B-671A-4297-9187-2C4477247A74
TotalCount	long	The total number of entries returned.	12
ShowSize	integer	The number of certificates per page. Default value: 20.	20
CurrentPage	integer	The page number. Default value: 1.	1
Keyword	string	The keyword used in the fuzzy search.	186
ContactList	array<object>	The contacts.
	object
ContactId	long	The ID of the contact.	519580
Name	string	The name of the contact.	ty-yaoyue.com
Mobile	string	The phone number.	139****8888
MobileStatus	integer	Indicates whether the phone number was verified.	1
Email	string	The email address of the contact.	username@example.com
EmailStatus	integer	Indicates whether the email address passed the verification.	1
Webhooks	string	The webhook URL of the chatbot.	[\"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\"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 12,
  "ShowSize": 20,
  "CurrentPage": 1,
  "Keyword": "186",
  "ContactList": [
    {
      "ContactId": 519580,
      "Name": "ty-yaoyue.com",
      "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\\\"]"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history