tencent cloud

eKYC

DocumentationeKYCAPI DocumentationReal-name Information Verification APIsMobileStatus

MobileStatus

PDF
Focus Mode
Font Size
Last updated: 2026-04-24 16:15:33

1. API Description

Domain name for API request: faceid.intl.tencentcloudapi.com.

This API is used to verify phone number status. You can enter mobile number to query.

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: MobileStatus.
Version Yes String Common Params. The value used for this API: 2018-03-01.
Region No String Common Params. This parameter is not required for this API.
Mobile Yes String Mobile number.
Encryption No Encryption Sensitive data encryption info.
-Users with encryption requirements for incoming information (mobile number) can use this parameter. For details, please click the left-side link.

3. Output Parameters

Parameter Name Type Description
Result String Verification result code. Billing is as follows.
-Result code for charges
0: Success.

-Result code with no charge
-No results found.
-2: Invalid phone number format.
-3: Verification Center Service is busy.
-4: Authentication attempts exceeded the daily limit. Retry the next day.
Description String Business result description.
StatusCode Integer Status code.
-Value range:
0: Normal.
1: Out of service.
2: Account cancellation.
4: Offline.
99: unknown status.
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 Mobile Number Status Query Exception Example

Input Example

https://faceid.intl.tencentcloudapi.com/?Action=MobileStatus
&Mobile=16137688175
&<Common request parameters>

Output Example

{
    "Response": {
"Description": "Invalid phone number format"
        "RequestId": "7411a5fc-0ba6-431d-9e8a-5f6537fb8701",
        "Result": "-2",
        "StatusCode": 99
    }
}

Example2 Mobile Number Status Query Successful Example

Input Example

https://faceid.intl.tencentcloudapi.com/?Action=MobileStatus
&Mobile=13800138000
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": "0",
"Description": "Success"
        "StatusCode": 1,
        "RequestId": "f893bfcf-167d-45df-99aa-60a23fe5809d"
    }
}

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.DecryptSystemError Decryption failed.
FailedOperation.StsUnAuthErrError STS unauthorized.
FailedOperation.UnKnown Unknown internal error.
InvalidParameter Invalid parameter.
InvalidParameter.UnsupportEncryptField Unencrypted fields exist. Refer to the documentation to modify.
InvalidParameterValue Incorrect parameter value.
UnauthorizedOperation.Arrears The account is in arrears.
UnauthorizedOperation.ChargeStatusException The billing status is abnormal.
UnauthorizedOperation.NonAuthorize Identity verification has not been completed for the account.
UnauthorizedOperation.Nonactivated The service has not been activated.
Previous Topic: MobileNetworkTimeVerificationNext Topic: PhoneVerification

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback