CreateOrUpdateContact - Application Real-Time Monitoring Service

Creates or modifies an alert contact.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ContactId	long	No	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
ContactName	string	Yes	The name of the alert contact.	JohnDoe
Phone	string	No	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****
Email	string	No	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
ReissueSendNotice	long	No	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
IsEmailVerify	boolean	No	Specifies whether the email address is verified.	true
DingRobotUrl	string	No	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=69d4e0******
ResourceGroupId	string	No	The resource group ID.	rg-acfmxyexli2****
CorpUserId	string	No	The ID of the alert contact that is shown to the enterprise when the contact is mentioned with the at sign (@) by a third-party instant messaging (IM) tool.	A123221

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
AlertContact	object	The object of the alert contact.
ContactId	float	The ID of the alert contact.	123
ContactName	string	The name of the alert contact.	JohnDoe
Phone	string	The mobile number of the alert contact.	1381111****
Email	string	The email address of the alert contact.	someone@example.com
IsVerify	boolean	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
ReissueSendNotice	long	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
isEmailVerify	boolean	Indicates whether the email address was verified.	true
DingRobotUrl	string	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 time	Summary of changes	Operation
2024-05-09	The request parameters of the API has changed	View Change Details
2024-05-09	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-06-24	The request parameters of the API has changed. The response structure of the API has changed	View Change Details