ModifySmsSign

Last updated: 2021-06-10 15:56:14

    1. API Description

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

    1. This API is used to modify an SMS signature. Please read the Tencent Cloud SMS Signature Review Standards before making a modification.
    2. ⚠️ Note: individual users cannot use this API to modify SMS signatures. For more information, please see Identity Verification Overview. If your account identity is individual, you can log in to the console to modify SMS signatures.
    3. Modifications can be made only if the signature status is Pending Review or Rejected. Approved signatures cannot be modified.
      • 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 parameter. The value used for this API: ModifySmsSign.
    Version Yes String Common parameter. The value used for this API: 2021-01-11.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    SignId Yes Integer ID of the signature to be modified.
    SignName Yes String Signature name.
    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, 1, 2, and 3.
    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 or WeChat Mini Program. Valid values of DocumentType include 0, 1, 2, 3, and 6.
    4: trademark. Valid values of DocumentType include 7.
    5: government/public institution/other. Valid values of DocumentType include 2 and 3.
    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.
    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.
    Note: the corresponding DocumentType must be selected according to SignType.
    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
    ModifySignStatus ModifySignStatus Signature modification 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

    
    POST / HTTP/1.1
    Host: sms.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifySmsSign
    <Common request parameters>
    {
      "Remark": "xxxx",
      "SignPurpose": 1,
      "SignType": 0,
      "CommissionImage": "xxxx",
      "SignName": "Tencent Cloud",
      "DocumentType": 1,
      "International": 0,
      "SignId": 1110,
      "ProofImage": "xxxx"
    }
    

    Output Example

    
    {
    "Response": {
      "ModifySignStatus": {
        "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.

    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.MissingSignatureToModify This signature ID has not been submitted for approval or does not exist, so it cannot be modified. Please check whether the SignId is entered correctly.
    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, please see the API description. If necessary, please contact SMS Helper for assistance.
    FailedOperation.SignNumberLimit The number of signatures has reached the maximum value.
    FailedOperation.TemplateAlreadyPassedCheck This template has been approved and cannot be modified again.
    InternalError.OtherError Other error. Please contact SMS Helper and provide the failed mobile number for assistance.
    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.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 A parameter error occurred.
    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.InvalidSignPurpose SignPurpose field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
    InvalidParameterValue.MissingSignatureList Unable to identify the signature. Usually, this is because that the signature has been rejected. Please check whether the signature has been approved. For more information, please see Signature Review.
    InvalidParameterValue.SignAlreadyPassedCheck This signature has been approved and cannot be modified again.
    InvalidParameterValue.SignExistAndUnapproved The same signature pending review already exists.
    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, please contact SMS Helper.
    UnauthorizedOperation.RequestPermissionDeny The request does not have permission. Please contact SMS Helper.
    UnauthorizedOperation.SerivceSuspendDueToArrears The service has been suspended due to overdue payments. You can log in to Tencent Cloud to make the payments.
    UnsupportedOperation. The request is not supported.