tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

QueryCustomersCredit

Last updated: 2024-02-18 11:09:55

    1. API Description

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

    This API is used for a partner to the credits and basic information of cutomers.

    A maximum of 5 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: QueryCustomersCredit.
    Version Yes String Common Params. The value used for this API: 2022-09-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    FilterType No String Search condition type. You can only search by customer ID, name, remarks, or email.
    Filter No String Search condition
    Page No Integer A pagination parameter that specifies the current page number, with a value starting from 1.
    PageSize No Integer A pagination parameter that specifies the number of entries per page.
    Order No String A sort parameter that specifies the sort order. Valid values: desc (descending order), or asc (ascending order) based on AssociationTime. The value will be desc if left empty.

    3. Output Parameters

    Parameter Name Type Description
    Data Array of QueryCustomersCreditData The list of queried customers
    Note: This field may return null, indicating that no valid values can be obtained.
    Total Integer Number of customers
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a the credits of customers

    Input Example

    POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryCustomersCredit
<Common request parameters>

{}

    Output Example

    {
    "Response": {
        "Total": 1,
        "Data": [
            {
                "ClientUin": 1,
                "Name": "abcdefg@tencent.com",
                "Mobile": "131123456789",
                "RecentExpiry": "2022-10-13 20:09:03",
                "RemainingCredit": 100,
                "Remark": "remark",
                "Credit": 100,
                "AssociationTime": "2022-10-13 20:09:03",
                "IdentifyType": 1,
                "Type": "new",
                "Email": "abcd*********@tencent.com",
                "Arrears": "-"
            }
        ],
        "RequestId": "2b7c676e-bb4b-449d-89e6-4866132036c4"
    }
}

    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 Operation failed.
    OperationDenied.ServiceBusy System busy. Please try again later.
    UnauthorizedOperation.UinNoAuth The current user doesn’t have permission for the operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy