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.
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. |
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. |
POST / HTTP/1.1
Host: ip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryCustomersCredit
<Common request parameters>
{}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?