All Products
Search
Document Center

Application Real-Time Monitoring Service:CreateOrUpdateContact

Last Updated:May 09, 2024

Creates or modifies an alert contact.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:CreateContactWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ContactIdlongNo

The ID of the alert contact.

  • If you do not specify this parameter, a new alert contact is created.
  • If you specify this parameter, the specified alert contact is modified.
123
ContactNamestringYes

The name of the alert contact.

JohnDoe
PhonestringNo

The mobile number of the alert contact.

Note You must specify at least one of the Phone and Email parameters. Each mobile number or email address can be used for only one alert contact.
1381111****
EmailstringNo

The email address of the alert contact.

Note You must specify at least one of the Phone and Email parameters. Each mobile number or email address can be used for only one alert contact.
someone@example.com
ReissueSendNoticelongNo

The operation that you want to perform if phone calls fail to be answered. Valid values:

  • 0: No operation is performed.
  • 1: A phone call is made again.
  • 2: A text message is sent.
  • 3 (default value): The global default value is used.
3
IsEmailVerifybooleanNo

Specifies whether the email address is verified.

true
DingRobotUrlstringNo

The webhook URL of the DingTalk chatbot.

https://oapi.dingtalk.com/robot/send?access_token=69d4e0******
ResourceGroupIdstringNo

The resource group ID.

rg-acfmxyexli2****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
AlertContactobject

The object of the alert contact.

ContactIdfloat

The ID of the alert contact.

123
ContactNamestring

The name of the alert contact.

JohnDoe
Phonestring

The mobile number of the alert contact.

1381111****
Emailstring

The email address of the alert contact.

someone@example.com
IsVerifyboolean

Indicates whether the mobile number was verified. Valid values:

  • false (default value): No
  • true: Yes

You can call the SendTTSVerifyLink operation to verify the mobile number of an alert contact. Only verified mobile numbers can be specified in a notification policy to receive phone calls.

false
ReissueSendNoticelong

The operation that you want to perform if phone calls fail to be answered. Valid values: 0: No operation is performed. 1: A phone call is made again. 2: A text message is sent. 3 (default value): The global default value is used.

3
isEmailVerifyboolean

Indicates whether the email address was verified.

true
DingRobotUrlstring

The webhook URL of the DingTalk chatbot.

https://test1.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "AlertContact": {
    "ContactId": 123,
    "ContactName": "JohnDoe",
    "Phone": "1381111****",
    "Email": "someone@example.com",
    "IsVerify": false,
    "ReissueSendNotice": 3,
    "isEmailVerify": true,
    "DingRobotUrl": "https://test1.com"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-09The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CorpUserId
2024-05-09The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-06-24The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ReissueSendNotice
Output ParametersThe response structure of the API has changed.