Query message contacts by using ListMessageContacts - Resource Management - Alibaba Cloud - Resource Management

Queries 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

resourcemanager:ListMessageContacts

list

*MessageContact

acs:resourcemanager:*:{#accountId}:messagecontact/*

None

Request parameters

Parameter	Type	Required	Description	Example
ContactId	string	No	The contact ID.	c-qL4HqKONzOM7****
Member	string	No	The ID of the binding target. Valid values: Resource directory ID. Resource folder ID. Member ID.	fd-ZDNPiT****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	95060F1D-6990-4645-8920-A81D1BBFE992
TotalCount	integer	The total number of entries.	20
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Contacts	array<object>	The list of message contacts.
	object	The list of message contacts.
ContactId	string	The contact ID.	c-qL4HqKONzOM7****
Name	string	The name of the contact.	tom
EmailAddress	string	The email address of the contact.	someone***@example.com
PhoneNumber	string	The phone number of the contact.	86-139****1234
Title	string	The job title of the contact.	TechnicalDirector
MessageTypes	array	The message categories that the contact receives.
	string	The message categories that the contact receives.	AccountExpenses
Members	array	The binding targets.
	string	The binding targets.	fd-ZDNPiT****
Status	string	The contact status. Valid values: Verifying: Pending verification. Active: Active. Deleting: Being deleted.	Active
CreateDate	string	The time when the contact was added. The time is in the YYYY-MM-DD HH:mm:ss format and does not include a time zone identifier.	2023-03-27 17:19:21
AssociatedDate	string	The time when the contact was bound. The time is in the YYYY-MM-DD HH:mm:ss format and does not include a time zone identifier.	2023-03-27 17:19:21

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ContactId	The ContactId is invalid.	The value of the ContactId parameter is invalid.
400	InvalidParameter.Member	The Member is invalid.	The value of the Member parameter is invalid.
404	EntityNotExists.Contact	This Contact does not exist.	The specified contact does not exist.
404	EntityNotExists.Member	This Member does not exist.	The specified member does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.