tencent cloud

All product documents
International Partners
QueryCustomersCredit
Last updated: 2025-02-27 10:07:17
QueryCustomersCredit
Last updated: 2025-02-27 10:07:17

1. API Description

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

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

Callable roles: Distributor, Second-level reseller, Reseller

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 No String Common Params. This parameter is not required.
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 Queries the list of customers.
Total Integer Number of customers
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 Querying a the Credits Of Customers

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.intl.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,
                "Force": 0,
                "AssociationTime": "2022-10-13 20:09:03",
                "IdentifyType": 1,
                "Type": "new",
                "Email": "abcd*********@tencent.com",
                "Arrears": "Fixed as -"
            }
        ],
        "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.
InvalidParameterValue.InvalidUin InvalidParameterValue.InvalidUin
OperationDenied.ServiceBusy System busy. Please try again later.
UnauthorizedOperation.UinNoAuth The current user doesn’t have permission for the operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon