PullSmsReplyStatusByPhoneNumber

Last updated: 2021-06-01 15:19:56

1. API Description

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

This API is used to pull SMS reply status for one single number.
Currently, you can also configure the reply callback to get replies.

  • 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 20 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: PullSmsReplyStatusByPhoneNumber.
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.
BeginTime Yes Integer Pull start time in seconds in the format of UNIX timestamp.
Note: the data for the last 7 days can be pulled at most.
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 The SMS SdkAppId generated after an application is added in the SMS console, such as 1400006666.
EndTime No Integer Pull end time in seconds in the format of UNIX timestamp.

3. Output Parameters

Parameter Name Type Description
PullSmsReplyStatusSet Array of PullSmsReplyStatus Reply status response set.
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: PullSmsReplyStatusByPhoneNumber
<Common request parameters>

{
    "SmsSdkAppId": "1400006666",
    "PhoneNumber": "+8615291996666",
    "BeginTime": 1464624000,
    "Offset": 0,
    "Limit": 2,
    "EndTime": 1464624000
}

Output Example

{
  "Response": {
    "RequestId": "a0aabda6-cf91-4f3e-a81f-9198114a2279",
    "PullSmsReplyStatusSet": [
      {
        "CountryCode": "86",
        "ReplyContent": "xxxxxx",
        "SubscriberNumber": "15291990000",
        "ExtendCode": "11",
        "ReplyTime": 1620734188,
        "PhoneNumber": "+8615291990000",
        "SignName": "Tencent Cloud"
      },
      {
        "CountryCode": "86",
        "ReplyContent": "xxxxxx",
        "SubscriberNumber": "15291990001",
        "ExtendCode": "11",
        "ReplyTime": 1620734189,
        "PhoneNumber": "+8615291990001",
        "SignName": "Tencent Cloud"
      }
    ]
  }
}

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.JsonParseFail Failed to parse the request body.
FailedOperation.PhoneNumberInBlacklist 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. 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.SendAndRecvFail The API timed out or SMS packet sending/receiving timed out. Please check whether your network jitters or contact SMS Helper for assistance.
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.
InvalidParameterValue.BeginTimeVerifyFail BeginTime parameter check failed.
InvalidParameterValue.EndTimeVerifyFail EndTime parameter check failed.
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 parameters. Please check and try again.
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.SdkAppIdIsDisabled This SdkAppId is forbidden to provide services. If necessary, 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.
UnauthorizedOperation.SmsSdkAppIdVerifyFail SmsSdkAppId check failed.
UnsupportedOperation. The request is not supported.