1. API Description
Domain name for API request: sms.tencentcloudapi.com.
- This API is used to add an SMS signature. You need to read the Tencent Cloud SMS Signature Review Standards before starting an application.
- ⚠️ Note: individual users cannot use this API to apply for SMS signatures. For more information, see Identity Verification Overview. If your account identity is individual, you can log in to the console to apply for SMS signatures.
- Note: because of the improved security of TencentCloud API 3.0, API authentication is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK.
- You can run this API directly in API 3.0 Explorer, which eliminates the signature calculation steps. After it is executed successfully, API Explorer can automatically generate SDK code samples.
A maximum of 1 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: AddSmsSign. |
| Version | Yes | String | Common Params. The value used for this API: 2021-01-11. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SignName | Yes | String | Signature name. Note: you cannot apply for an approved or pending signature again. |
| SignType | Yes | Integer | Signature type. Each of these types is followed by their DocumentType (identity certificate type) option:0: company. Valid values of DocumentType include 0 and 1.1: app. Valid values of DocumentType include 0, 1, 2, 3, and 4.2: website. Valid values of DocumentType include 0, 1, 2, 3, and 5.3: WeChat Official Account. Valid values of DocumentType include 0, 1, 2, 3, and 8.4: trademark. Valid values of DocumentType include 7.5: government/public institution/other. Valid values of DocumentType include 2 and 3.6: WeChat Mini Program. Valid values of DocumentType include 0, 1, 2, 3, and 6.Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail. |
| DocumentType | Yes | Integer | Identity certificate type: 0: three-in-one licence. 1: business license. 2: organization code certificate. 3: social credit code certificate. 4: screenshot of application backend management (for personal app). 5: screenshot of website ICP filing backend (for personal website). 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program). 7: trademark registration certificate. 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account). |
| International | Yes | Integer | Whether it is Global SMS: 0: Mainland China SMS. 1: Global SMS. |
| SignPurpose | Yes | Integer | Signature purpose: 0: for personal use. 1: for others. |
| ProofImage | Yes | String | You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. |
| CommissionImage | No | String | Power of attorney, which should be submitted if SignPurpose is for use by others.You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.Note: this field will take effect only when SignPurpose is 1 (for user by others). |
| Remark | No | String | Signature application remarks. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| AddSignStatus | AddSignStatus | Signature addition response |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddSmsSign
<Common request parameters>
{
"Remark": "xxxx",
"SignPurpose": 1,
"SignType": 0,
"CommissionImage": "xxxx",
"SignName": "Tencent Cloud",
"DocumentType": 1,
"International": 0,
"ProofImage": "xxxx"
}
Output Example
{
"Response": {
"AddSignStatus": {
"SignId": 1110
},
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| FailedOperation.FailResolvePacket | Failed to parse the request packet. Usually, this is because that the API specification was not followed. Please see Detailed Explanation of Request Body Parsing Error 1004. |
| FailedOperation.JsonParseFail | Failed to parse the request body. |
| FailedOperation.NotEnterpriseCertification | Individual users cannot use the APIs related to signatures and templates. You can change your account identity type to enterprise as instructed here. The change will take effect in about one hour. |
| FailedOperation.OtherError | Other error. Usually, this is because that the carried parameter is non-compliant. For more information, see the API description. If necessary, you can contact SMS Helper for assistance. |
| FailedOperation.ParametersOtherError | Unknown error. If necessary, you can contact SMS Helper for assistance. |
| FailedOperation.SignNumberLimit | The number of signatures has reached the maximum value. |
| FailedOperation.TemplateIdNotExist | The template ID does not exist. |
| InternalError.RequestTimeException | The request was initiated in an exceptional time. Usually, this is because that the difference between your server time and Tencent Cloud server time exceeds 10 minutes. Please check whether the server time and the time field in the API are correct. |
| InternalError.RestApiInterfaceNotExist | This RESTful API does not exist. Please check the RESTful API description. |
| InternalError.SigFieldMissing | The request body in the backend body does not have a Sig field or the Sig field is empty. |
| InternalError.SigVerificationFail | Backend check of Sig failed. |
| InternalError.Timeout | The request to deliver an SMS message timed out. Please see Detailed Explanation of Error 60008. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameter.AppidAndBizId | The account does not match the application ID. |
| InvalidParameterValue.ImageInvalid | The format of the uploaded transcoded image is incorrect. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.InvalidDocumentType | DocumentType field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.InvalidInternational | International field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.InvalidUsedMethod | UsedMethod field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.SdkAppIdNotExist | The SdkAppId does not exist. |
| InvalidParameterValue.SignAlreadyPassedCheck | This signature has been approved and cannot be modified again. |
| InvalidParameterValue.SignExistAndUnapproved | The same signature pending review already exists. |
| InvalidParameterValue.SignNameLengthTooLong | Too much signature content |
| MissingParameter | Missing parameters. Please check and try again. |
| UnauthorizedOperation.RequestIpNotInWhitelist | The requesting IP is not in the allowlist. You have configured the verification of request source IP, but the current requesting IP is not in the configured allowlist. If necessary, you can contact SMS Helper. |
| UnauthorizedOperation.RequestPermissionDeny | The request does not have permission. You can contact SMS Helper. |
| UnauthorizedOperation.ServiceSuspendDueToArrears | If the service is suspended due to outstanding fees, you can log in to Tencent Cloud to recharge and clear the debt on your own. |
| UnsupportedOperation. | The request is not supported. |
是
否
本页内容是否解决了您的问题？