tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ReportConversion

Last updated: 2024-09-10 16:03:49

    1. API Description

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

    This API is used to report the SMS conversion rate (SMS conversion rate = the number of returned verification codes / the number of verification codes sent) and report the serial numbers of received SMS messages to Tencent Cloud SMS.

    • Note: To call this API, you need to be added to the allowlist first. If you have any questions, contact SMS Helper.

    A maximum of 1000 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: ReportConversion.
    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.
    SmsSdkAppId Yes String The SMS SdkAppId generated after an application is created in the SMS console, such as “1400006666”.
    SerialNo Yes String The serial number returned for a message sent.
    ConversionTime No Integer The recipient’s reply time in seconds in the format of UNIX timestamp.

    3. Output Parameters

    Parameter Name Type Description
    ReportConversionStatus ReportConversionStatus Response packet for conversion rate reporting.
    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: ReportConversion
<Common request parameters>

{
    "SmsSdkAppId": "1400000001",
    "SerialNo": "5000:1045710669157053657849499619",
    "ConversionTime": 1658310430
}

    Output Example

    {
    "Response": {
        "ReportConversionStatus": {
            "Code": "ok",
            "Message": "report success"
        },
        "RequestId": "a0aabda6-cf91-4f3e-a81f-9198114a2279"
    }
}

    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
    InternalError.SendAndRecvFail The API timed out or SMS packet sending/receiving timed out. You need to check whether your network jitters or contact SMS Helper for assistance.
    UnauthorizedOperation.SmsSdkAppIdVerifyFail Failed to verify SmsSdkAppId. Please check whether SmsSdkAppId is under the account associated with the TencentCloud API key.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy