Domain name for API request: sms.tencentcloudapi.com.
This API is used to pull SMS delivery status for one single number.
A maximum of 20 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 parameter. The value used for this API: PullSmsSendStatusByPhoneNumber. |
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. |
SendDateTime | Yes | Integer | Pull start time in seconds in the format of UNIX timestamp. |
Offset | Yes | Integer | Offset. Note: this parameter is currently fixed at 0. |
Limit | Yes | Integer | Maximum number of pulled entries. Maximum value: 100. |
PhoneNumber | Yes | String | Target mobile number in the e.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number). |
SmsSdkAppid | Yes | String | SMS SdkAppid actually generated after an application is added in the SMS Console, such as 1400006666. |
EndDateTime | No | Integer | Pull end time in UNIX timestamp accurate to seconds. |
Parameter Name | Type | Description |
---|---|---|
PullSmsSendStatusSet | Array of PullSmsSendStatus | Delivery status response set. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
- To get the common request parameters
SecretId
andSecretKey
(which will be used in the SDK too), please go to the TencentCloud API Key page.- Note: because of the improved security of TencentCloud API 3.0, API authentication is more complicated. You are recommended to use the Tencent Cloud SMS service with the SDK.
https://sms.tencentcloudapi.com/?Action=PullSmsSendStatusByPhoneNumber
&SendDateTime=1464624000
&Offset=0
&Limit=2
&PhoneNumber=+8615291996666
&SmsSdkAppid=1400006874
&<Common request parameters>
{
"Response": {
"PullSmsSendStatusSet": [
{
"UserReceiveTime": "2019-10-08 17:18:37",
"NationCode": "86",
"PurePhoneNumber": "+8615291996666",
"PhoneNumber": "15291996666",
"SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
"ReportStatus": "SUCCESS",
"Description": "DELIVRD"
},
{
"UserReceiveTime": "2019-10-08 17:18:37",
"NationCode": "86",
"PurePhoneNumber": "+8615291996666",
"PhoneNumber": "15291996666",
"SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
"ReportStatus": "SUCCESS",
"Description": "DELIVRD"
}
],
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
---|---|
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.PhoneNumberOnBlacklist | The mobile number is in the blocklist. Usually, this is because that the user unsubscribed or the carrier's blocklist was hit. You can contact SMS Helper for assistance. |
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. 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.SendAndRecvFail | |
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 | Invalid parameter. |
InvalidParameterValue.IncorrectPhoneNumber | The format of the mobile number is incorrect. Please see Detailed Explanation of Error 1016. |
InvalidParameterValue.InvalidStartTime | Invalid start time or end time. The reason may be that the requested SendDateTime is later than EndDateTime. |
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.SdkAppidIsDisabled | This sdkappid is forbidden to provide services. If necessary, 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. |
UnauthorizedOperation.SmsSdkAppidVerifyFail | SmsSdkAppid check failed. |
UnsupportedOperation. | This request is not supported. |
Was this page helpful?