1. API Description
Domain name for API request: intlpartnersmgt.tencentcloudapi.com.
This API is used to query the voucher list based on the customer UIN.
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: QueryVoucherListByUin. |
| 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. |
| ClientUins.N | Yes | Array of Integer | Customer UIN list. Array length value: 1-20. |
| Status | No | String | Voucher status. If this parameter is not passed in, all status will be queried by default. Valid values: Unused, Used, Expired. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of QueryVoucherListByUinItem | Customer voucher information |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the voucher list based on the customer UIN
Input Example
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryVoucherListByUin
<Common Request Parameters>
{
"ClientUins": [
1
],
"Status": "abc"
}
Output Example
{
"Response": {
"Data": [
{
"TotalCount": 0,
"ClientUin": 0,
"Data": [
{
"VoucherId": "xx",
"TotalAmount": 0.0,
"RemainAmount": 0.0,
"VoucherStatus": "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 Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
是
否
本页内容是否解决了您的问题？