Announcements
Domain name for API request: sms.intl.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.
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. |
| 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. |
POST / HTTP/1.1
Host: sms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReportConversion
<Common request parameters>
{
"SmsSdkAppId": "1400000001",
"SerialNo": "5000:1045710669157053657849499619",
"ConversionTime": 1658310430
}{
"Response": {
"ReportConversionStatus": {
"Code": "ok",
"Message": "report success"
},
"RequestId": "a0aabda6-cf91-4f3e-a81f-9198114a2279"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Service access has timed out,Please verify whether there are any network fluctuations or contact Tencent Cloud SMS Assistant for assistance. |
| UnauthorizedOperation.SmsSdkAppIdVerifyFail | Failed to verify SmsSdkAppId. Please check whether SmsSdkAppId is under the account associated with the TencentCloud API key. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback