Query contacts by calling ListContact - Certificate Management Service - Alibaba Cloud - Certificate Management Service

Retrieves the list of contacts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:ListContact

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The search keyword. For example, a keyword in the name, email address, or phone number.	186
ShowSize	integer	No	The number of contacts to display per page in a paged query.	20
CurrentPage	integer	No	The current page number for pagination. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.	31C66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	The total number of search results.	12
ShowSize	integer	The number of certificates displayed per page in a paged query. Default value: 20.	20
CurrentPage	integer	The current page number in a paged query. Default value: 1.	1
Keyword	string	The fuzzy match keyword.	186
ContactList	array<object>	The contact list.
	object	The contact object.
ContactId	integer	The contact ID.	519580
Name	string	The contact name.	John
Mobile	string	The mobile phone number.	139****8888
MobileStatus	integer	Indicates whether the mobile phone number is verified.	1
Email	string	The email address of the contact.	username@example.com
EmailStatus	integer	Indicates whether the email address is verified.	1
Webhooks	string	The webhook URL.	[\"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\"]
WebhookList	array	The webhook URL.
	string	The webhook URL.	https://open.feishu.cn/open-apis/bot/v2/hook/XXX

Examples

Success response

JSON format

{
  "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\\\"]",
      "WebhookList": [
        "https://open.feishu.cn/open-apis/bot/v2/hook/XXX"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.