tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

PullSmsSendStatusByPhoneNumber

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

    1. API Description

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

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

    • 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 to eliminate the need to calculate signatures. 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 Params. The value used for this API: PullSmsSendStatusByPhoneNumber.
    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.
    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
    PullSmsSendStatusSet Array of PullSmsSendStatus Delivery status response set.
    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: PullSmsSendStatusByPhoneNumber
<Common request parameters>

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

    Output Example

    {
    "Response": {
        "PullSmsSendStatusSet": [
            {
                "Description": "DELIVRD",
                "CountryCode": "86",
                "SubscriberNumber": "15291996666",
                "ReportStatus": "SUCCESS",
                "PhoneNumber": "+8615291996666",
                "SerialNo": "14:19325917feb3914eb78b50d6182d7e452e",
                "UserReceiveTime": 1620734188
            },
            {
                "Description": "DELIVRD",
                "CountryCode": "86",
                "SubscriberNumber": "15291996666",
                "ReportStatus": "SUCCESS",
                "PhoneNumber": "+8615291996666",
                "SerialNo": "14:19325917feb3914eb78b50d6182d7e456f",
                "UserReceiveTime": 1620734188
            }
        ],
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
    }
}

    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.PhoneNumberInBlacklist The mobile number is in the opt-out list. This may be because the recipient has unsubscribed from your service or the mobile number is in the carrier’s opt-out list. To solve this problem, contact SMS Helper.
    InternalError.JsonParseFail Failed to parse the user parameter. You can contact SMS Helper for assistance.
    InternalError.OtherError Other error. You can 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. You need to check whether your network jitters or contact SMS Helper for assistance.
    InternalError.SigFieldMissing The request body in the backend body does not have a Sig field or the Sig field is empty.
    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 Incorrect mobile number format
    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, you can contact SMS Helper.
    UnauthorizedOperation.RequestPermissionDeny The request does not have permission. You can contact SMS Helper.
    UnauthorizedOperation.SdkAppIdIsDisabled This SdkAppId is forbidden to provide services. If necessary, you can contact SMS Helper.
    UnauthorizedOperation.ServiceSuspendDueToArrears If the service is suspended due to outstanding fees, you can log in to Tencent Cloud to recharge and clear the debt on your own.
    UnauthorizedOperation.SmsSdkAppIdVerifyFail Failed to verify SmsSdkAppId. Please check whether SmsSdkAppId is under the account associated with the TencentCloud API key.
    UnsupportedOperation. The request is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy