Docs

Cloud Monitor

Alerting contacts

CreateContacts

Create contacts.

Usage notes

Limits

A single account can create at most 100 contacts.

Request descriptions

Request method: POST

Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateContacts&Version=2018-01-01

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	CreateContacts	The name of the API. The current API name is CreateContacts.
Version	String	Yes	2018-01-01	The API version. The current API version is 2018-01-01.
Name	String	Yes	user-demo	The name of the contact. It cannot start with a digit or hyphen. It can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-). The name must be 1 to 128 characters in length.
Email	String	Yes	user-demo@example.com	The alert email address. Cloud Monitor will send a verification email to the provided email address. You need to click the verification link in the email to complete verification. Once verified, this email address will be activated to receive alert notifications.
Phone	String	No	186117****	The alert phone number. Cloud Monitor will send a verification SMS to the provided phone number. You need to tap the verification link in the SMS to complete verification. Once verified, this phone number will be activated to receive alert notifications.

Sample request

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateContacts&Version=2018-01-01​
Content-Type: application/json​
{​
    "Name": "user-demo",​
    "Email": "user-demo@example.com",​
    "Phone": "186117****"​
}​

Response parameters

Parameter	Type	Sample value	Description
Data	Array of String	["157255269369******"]	Alert contact ID.

Sample response

{​
    "ResponseMetadata": {​
        "Action": "CreateContacts",​
        "Region": "cn-beijing",​
        "Service": "cloudmonitor",​
        "Version": "2018-01-01",​
        "RequestId": "20230604110420****100232280022D31"​
    },​
    "Result": {​
        "Data": [​
            "157255269369******"​
        ]​
    }​
}​

Error codes

There are no error codes specific to this API. For more information, see Error codes.

Last updated: 2026.07.10 14:02:24