Register Alert Contacts with AddMessageContact API - Resource Management - Alibaba Cloud - Resource Management

Adds a message notification contact.

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:AddMessageContact

create

*MessageContact

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

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the contact. The contact name must be unique within the resource directory. Format: 2 to 12 characters in length, which can contain letters and Chinese characters.	tom
EmailAddress	string	Yes	The email address of the contact. After you add an email address, you must call SendEmailVerificationForMessageContact to send a verification message to the email address. The email address of the contact takes effect only after the verification is passed.	someone***@example.com
PhoneNumber	string	No	The phone number of the contact. Format: `<Country code>-<Phone number>`. Note Only phone numbers in the Chinese mainland in the format `86-<Phone number>` are supported. After you add a phone number, you must invoke SendPhoneVerificationForMessageContact to send a verification message to the phone number. The phone number of the contact takes effect only after you authenticate it.	86-139****1234
Title	string	Yes	The job title of the contact. Valid values: FinanceDirector : Finance director. TechnicalDirector : Technical director. MaintenanceDirector : O&M director. CEO : CEO ProjectDirector : Project director. Other : Other.	TechnicalDirector
MessageTypes	array	Yes	The message types that the contact receives.
	string	No	The message types that the contact receives. Valid values: ServiceMessage : Service message. FaultMessage : Fault message. AccountExpenses : Account expenses message. SecurityMessage : Security message. ActivityMessage : Activity message. ProductMessage : Product message.	AccountExpenses

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2DFCE4C9-04A9-4C83-BB14-FE791275EC53
Contact	object	The contact information.
ContactId	string	The contact ID.	c-qL4HqKONzOM7****
CreateDate	string	The time when the contact was created. The time is in the YYYY-MM-DD HH:mm:ss format and does not contain a time zone identifier.	2023-03-27 17:19:21

Examples

Success response

JSON format

{
  "RequestId": "2DFCE4C9-04A9-4C83-BB14-FE791275EC53",
  "Contact": {
    "ContactId": "c-qL4HqKONzOM7****",
    "CreateDate": "2023-03-27 17:19:21"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.Name	You must specify Name.	You must specify Name.
400	InvalidParameter.Name	The Name is invalid.	The value of the Name parameter is invalid. The value can contain only letters.
400	InvalidParameter.Name.Length	The Name exceeds the length limit.	The length of the value specified for the Name parameter exceeds the upper limit. The value must be 2 to 12 characters in length and can contain only letters.
400	InvalidParameter.Name.AlreadyUsed	The Name already exists. Please change to another name.	The contact name already exists in the resource directory. Use another name.
400	MissingParameter.EmailAddress	You must specify EmailAddress.	The EmailAddress parameter is not configured.
400	InvalidParameter.EmailAddress	The EmailAddress is invalid.	The value of the EmailAddress parameter is invalid.
400	MissingParameter.PhoneNumber	You must specify PhoneNumber.	The PhoneNumber parameter is not configured.
400	InvalidParameter.PhoneNumber	The PhoneNumber is invalid.	The value of the PhoneNumber parameter is invalid.
400	MissingParameter.Title	You must specify Title.	The Title parameter is not configured.
400	InvalidParameter.Title	The Title is invalid.	The value of the Title parameter is invalid.
400	MissingParameter.MessageTypes	You must specify MessageTypes.	The MessageTypes parameter is not configured.
400	InvalidParameter.MessageTypes	The MessageTypes is invalid.	The value of the MessageTypes parameter is invalid.
400	LimitExceeded.Contacts	The maximum number of contacts in a resource directory exceeds the limit.	The number of contacts exceeds the upper limit.
400	InvalidParameter.MobileCountryCode	The current site does not support the country code.
400	InvalidParameter.EmailAddress.Length	The EmailAddress exceeds the length limit.	The length of the value specified for the EmailAddress parameter exceeds the upper limit.
429	ConcurrentCallNotSupported	The operation conflicts with other operations. Please try again later.	The operation conflicts with other operations. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.