tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for DBbrainHealth Report Email Sending APIsAddUserContact
AddUserContact
Last updated: 2023-10-17 10:51:58
AddUserContact
Last updated: 2023-10-17 10:51:58

1. API Description

Domain name for API request: dbbrain.tencentcloudapi.com.

This API is used to add the recipient name and email. The returned value is the ID of the successfully added recipient.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: AddUserContact.
Version Yes String Common Params. The value used for this API: 2021-05-27.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Recipient name, which can contain up to 20 letters, digits, spaces, and symbols !@#$%^&*()_+-=() and cannot begin with an underscore.
ContactInfo Yes String Email address, which can contain letters, digits, underscores, and the @ symbol, cannot begin with an underscore, and must be unique.
Product Yes String Service type, which is fixed to mysql.

3. Output Parameters

Parameter Name Type Description
Id Integer ID of the successfully added recipient.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding an email recipient

Input Example

https://dbbrain.tencentcloudapi.com/?Action=AddUserContact
&Name=John Smith
&ContactInfo=test@qq.com
&Product=mysql
&<Common request parameters>

Output Example

{
    "Response": {
        "Id": 1,
        "RequestId": "77db16d7-bbe8-48a7-868b-ed776a96f1ab"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support