- User Guide
- Distributor
- Second-Level Reseller
- Reseller
- Customer
- Partner Academy
- Access Management
- Bills Management APIs
- API Documentation
- User Guide
- Distributor
- Second-Level Reseller
- Reseller
- Customer
- Partner Academy
- Access Management
- Bills Management APIs
- API Documentation
QueryCustomersCredit
Last updated: 2022-09-01 17:26:58
1. API Description
Domain name for API request: ip.tencentcloudapi.com.
This API is used for a partner to query a customer's credit and basic information.
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: QueryCustomersCredit. |
| Version | Yes | String | Common Params. The value used for this API: 2021-04-09. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| FilterType | No | String | Search condition type. You can only search by UIN, name, or remarks. |
| 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 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 customer’s credit
Input Example
POST / HTTP/1.1
Host: ip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryCustomersCredit
<Common request parameters>
{}
Output Example
{
"Response": {
"Total": 1,
"Data": [
{
"ClientUin": 1,
"Name": "xx",
"Mobile": "xx",
"RecentExpiry": "xx",
"RemainingCredit": 0.0,
"Remark": "xx",
"Credit": 0.0,
"AssociationTime": "xx",
"IdentifyType": 1,
"Type": "xx",
"Email": "xx",
"Arrears": "xx"
}
],
"RequestId": "xx"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
Yes
No
Was this page helpful?