Create an alerting contact.

Request descriptions

Volcengine Managed Service for Prometheus has been deployed in multiple regions worldwide, aiming to provide you with an experience of higher stability and lower latency. You can choose an optimal access point for your service region by referring to the Service addresses topic.

Request method: POST

Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=CreateContact&Version=2021-03-03

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	CreateContact	The name of the API. The API name is CreateContact.
Version	String	Yes	2021-03-03	The API version. The API version is 2021-03-03.
Name	String	Yes	user-demo	The name of the contact. It can only contain uppercase and lowercase letters, Chinese characters, digits, hyphens (-), and underscores (_). The name cannot start with a digit, a hyphen (-), an underscore (_), or other special characters. It must be fewer than 128 characters in length. It needs to be unique under the same account.
Email	String	No	user-demo@example.com	The email address of the contact, which needs to be a valid email address.
Webhook	Object of Webhook	No	-	The generic webhook of the contact.
ContactGroupIds	Array of String	No	["e28ae750-bbb8-4ff4-abf4***"]	The ID of the contact group to which the contact belongs.
LarkBotWebhook	Object of LarkBotWebhook	No	-	The webhook of Larkbot.
DingTalkBotWebhook	Object of DingTalkBotWebhook	No	-	The webhook of the DingTalk robot.
WeComBotWebhook	Object of WeComBotWebhook	No	-	The webhook of the WeCom robot.

Webhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://www.bytedance.com/	The generic webhook address.
Token	String	No	3KSxxx	The token for the generic webhook. It needs to be used together with the generic webhook address.

LarkBotWebhook

Parameters	Type	Required	Sample value	Description
Address	String	Yes	https://open.feishu.cn/open-apis/bot/v2/hook/***	The webhook address of Larkbot. See User guide for details.
SecretKey	String	No	6KKxxx	The webhook secret key of Larkbot. It needs to be used together with the webhook address of Larkbot.

DingTalkBotWebhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://oapi.dingtalk.com/robot/send?access_token=***	The webhoot address of the DingTalk bot. See User Guide for details.
SecretKey	String	No	SECxxx	The webhook secret key of the DingTalk robot. It needs to be used together with the webhook address of the DingTalk robot.
AtMobiles	Array of String	No	["133********"]	The phone number of the user who is about to be @mentioned in the group.
AtUserIds	Array of String	No	["********"]	The ID of the user who is about to be @mentioned in the group.

WeComBotWebhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=***	The webhook address of the WeCom robot. See User guide for details.
AtUserIds	Array of String	No	["********"]	The ID of the user who is about to be @mentioned in the group.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4***	The contact ID.
SendStatus	String	MessageSucceed.Email	The status code returned when verification emails were being sent. Valid values: AlreadyActive.Email: The email address has already been activated. MessageFailed.Email: The verification email failed to be sent. LimitExceeded.Email: The email is sent too frequently. MessageSucceed.Email: The verification email has been sent.
Message	String	The same email address should not be validated more than once in 1 minute, please try it later.	The reason for the error occurred when verification emails were being sent. This parameter has a value if the value of the SendStatus parameter is not MessageSucceed.Email.

Sample responses

Error codes

The following table lists the error codes of the API. For public error codes, see Public error codes.

HTTP status code	Error code	Error message	Description
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	An invalid parameter was found. For example, an invalid workspace name was included in requests.
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	A required parameter is missing.
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service.	The account has not subscribed to the VMP service.
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	The specified name has already been used by an existing resource.