查询API点数使用情况
Action GetCreditBalance
简介
此接口用于查询当前账号点数的使用情况
请求
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | String | 对应的 API 指令名称 | ✓ |
| PublicKey | String | 用户公钥，可从 PICPIK用户中心 (opens in a new tab) 获取 | ✓ |
| Signature | String | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | ✓ |
| request_uuid | String | 请求uuid，采用uuid生成方式随机生成，可用于管理您业务和客户的请求 |
请求示例
{
"Action": "GetCreditBalance",
"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
"request_uuid":"b91fcfbe-bb35-47ce-a168-bd6252c75270",
"Signature": "0131f4e4296f3ca8e1220b47247e83a4315ea8e1"
}响应
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | Int | 返回状态码，为 0 则为成功返回，非 0 为失败 | ✓ |
| Action | String | 操作指令名称 | ✓ |
| Message | String | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | |
| request_uuid | String | 返回请求时填写的uuid |
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| TotalCredits | Int | 账号点数总量 | ✓ |
| UsedCredits | Int | 账号点数使用数量 | ✓ |
| ExpireTimestamp | Int | 点数到期时间 |
响应示例
{
"Action": "GetCreditBalance",
"RetCode": 0,
"Message": "",
"request_uuid": "18a62d99-cb9b-4fde-a6a3-d14180a13f2a",
"TotalCredits": 804000,
"UsedCredits": 4641,
"ExpireTimestamp": 1727331226
}