AddUserContact

Last updated: 2021-03-08 18:51:17

1. API Description

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

This API is used to add the contact name and email.. The return value is the successfully added contact ID. Select Guangzhou for Region.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: AddUserContact.
Version Yes String Common parameter. The value used for this API: 2019-10-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Name Yes String Contact name, which needs to be unique and can contain 2-60 characters, supporting uppercase and lowercase letters, numbers, and underline “_”. It cannot start with “_”.
ContactInfo Yes String Email address, which can contain uppercase and lowercase letters, numbers, and underline “_”, and cannot start with “_”.
Product Yes String Service type, which is fixed to “mysql”.

3. Output Parameters

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

4. Example

Example1 Adding the contact information for receiving email

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 CAM signature/authentication error
FailedOperation Operation failed.
InternalError An internal error occurred.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
RequestLimitExceeded Request exceeded the frequency limit
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help