查询成员权益
该接口用于查询成员当前权益情况,包含权益类型、剩余次数与有效期等关键信息。
接口调用
说明
| 接口描述 | 查询团队下的员工/用户权益详情,需调用此接口 |
|---|---|
| 请求域名 | https://ai-user-api.jbangai.com |
| 接口地址 | /api/open/ai/v1/user/equity |
| 请求方式 | GET |
| 权限校验 | 是 |
提交参数
Header请求头
| 参数 | 类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| Access-Token | string | 是 | 从 获取令牌 中获取到对应的参数值accessToken,详情请查看文档 |
Query参数
| 参数 | 类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| sourceIds | string | 是 | 该sourceIds参数为接入方系统用户的ID,可以同时填写多个接入方系统用户的ID查询权益(中间使用,分隔),接入方系统用户的ID需要在 获取令牌 中获取鉴权code API中注册过 |
| type | string | 是 | user 代表用户,sys_user代表员工 |
请求示例
curl --location --request GET 'https://ai-user-api.jbangai.com/api/open/ai/v1/user/equity?sourceIds=41&type=sys_user' \
--header 'Access-Token: eyJhbGciOiJIUzUxMiJ9...' \
--header 'Accept: */*' \
--header 'Host: ai-user-api.jbangai.com' \
--header 'Connection: keep-alive'
返回参数
| 参数 | 子参数 | 子子参数 | 类型 | 说明 |
|---|---|---|---|---|
| code | — | — | string | 响应编码 |
| data | sourceId | — | string | 接入方系统用户的ID |
| uoPoints | createTime | string | 创建时间 | |
| updateTime | string | 更新时间 | ||
| balance | string | 金币余额 | ||
| underway | string | 待入账 | ||
| frozen | string | 冻结 | ||
| incomeTotal | string | 累计收入 | ||
| extInfoList | createTime | string | 创建时间 | |
| updateTime | string | 更新时间 | ||
| targetId | string | 权益ID | ||
| targetType | string | 权益类型 | ||
| totalTimes | string | 总次数(-1表示不做限制) | ||
| remainTimes | string | 剩余次数(-1表示不做限制) | ||
| expireTime | string | 过期时间(为空时永不过期) | ||
| title | string | 权益标题 | ||
| message | — | — | string | 返回提示信息 |
| serverTime | — | — | string | 当前时间戳 |
响应示例
{
"code": 0,
"data": [
{
"sourceId": "41",
"extInfoList": [
{
"createTime": "2025-04-27T06:14:31.000+00:00",
"targetId": "18b7rnr6j0",
"targetType": "bot",
"totalTimes": 1.0,
"remainTimes": 1.0,
"expireTime": "2025-04-30T15:59:59.000+00:00",
"title": "豆包权益"
}
],
"uoPoints": {
"createTime": "2025-04-27T06:14:22.000+00:00",
"updateTime": "2025-04-27T06:14:31.000+00:00",
"balance": 20.0000,
"underway": 0.0000,
"frozen": 0.0000,
"incomeTotal": 20.0000
}
}
],
"message": "",
"serverTime": 1745739428
}