AddSmsSign

Last updated: 2020-05-09 14:56:06

PDF

1. API Description

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

This API is used to add an SMS signature.

⚠️ Note: individual users cannot use this API to apply for SMS signatures. For more information, please see Identity Verification Overview. If your account identity is individual, please log in to the console to apply for SMS signatures.

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

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: AddSmsSign.
Version Yes String Common parameter. The value used for this API: 2019-07-11.
Region No String Common parameter. This parameter is not required for this API.
SignName Yes String Signature name.
SignType Yes Integer Signature type. Each of these types is followed by their DocumentType (identity document type) option:
0: company (0, 1, 2, 3).
1: app (0, 1, 2, 3, 4).
2: website (0, 1, 2, 3, 5).
3: WeChat Official Account or WeChat Mini Program (0, 1, 2, 3, 6).
4: trademark (7).
5: governmental/public institution or others (2, 3).
Note: the identity document type must be selected according to the correspondence; otherwise, the review will fail.
DocumentType Yes Integer Identity document type:
0: 3-in-1 license.
1: business license.
2: organization code certificate.
3: certificate of unified social credit code.
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.
International Yes Integer Whether it is Global SMS:
0: Mainland China SMS.
1: Global SMS.
UsedMethod Yes Integer Signature use:
0: for self-use.
1: for others.
ProofImage Yes String You should Base64-encode the image of the identity document 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 Authorization letter, which should be submitted if UsedMethod is for 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 UsedMethod is 1 (for 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://sms.tencentcloudapi.com/?Action=AddSmsSign
&SignName=“test”
&SignType=0
&DocumentType=1
&International=0
&UsedMethod=1
&ProofImage="xxxx"
&CommissionImage="xxxx"
&Remark="xxxx"
&<common request parameters>

Output Example

{
  "Response": {
    "AddSignStatus": {
      "SignId": 1110,
      "SignApplyId": 1109
    },
    "RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
FailedOperation.FailResolvePacket Failed to parse the request packet. Generally, 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 packet.
FailedOperation.NotEnterpriseCertification Individual users cannot use the APIs related to signatures and templates.
FailedOperation.OtherError Other error. Generally, this is because that the carried parameter is non-compliant. For more information, please see the API description. If necessary, please contact SMS Helper for assistance.
InternalError.RequestTimeException The request was initiated in an exceptional time. Generally, 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 packet in the backend packet does not have a Sig field or the Sig field is empty.
InternalError.SigVerificationFail Sig check on backend 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. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.InvalidDocumentType DocumentType field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.InvalidInternational International field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.InvalidUsedMethod UsedMethod field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.SdkAppidNotExist The SdkAppid does not exist.
MissingParameter Missing parameter.
UnauthorizedOperation.RequestIpNotInWhitelist The requesting IP is not in the whitelist. You have configured verification of request source IP, but the current requesting IP is not in the configured whitelist. If necessary, please contact SMS Helper for assistance.
UnauthorizedOperation.RequestPermissionDeny You do not have permission to make the request. Please contact SMS Helper for assistance.
UnauthorizedOperation.SerivceSuspendDueToArrears The service has been suspended due to arrears. You can log in to Tencent Cloud to top up your account.
UnsupportedOperation. This request is not supported.