获取渠道活码客户明细

拥有此API的权限集
SCRM-查询

请求方式及url

• 请求方式：POST
• 请求头：Content-Type:application/json
• 接口地址：https://api.xiaoe-tech.com/xe.scrm.contact_card.user_details/1.0.0
• 频率限制：1s/10次

请求参数

参数名	必选	类型	说明	备注
access_token	是	string	专属token	...
b_user_id	否	string	B 端操作人 ID	不传或传空时，服务端在受控的活码明细链路中使用 system，并查询全部跟进员工范围；传普通 B 端用户 ID 时保留原有可见范围
card_id	是	string	渠道活码 ID	支持传入带 s_ 前缀的渠道值，服务端会归一化为活码 ID
page_size	否	int	每页数量	不传或传 0 默认为 20，取值范围 1-100
cursor	否	string	下一页游标	使用上一页响应中的 next_cursor，首次请求不传

app_id 已包含在 access_token 凭证中，由服务端从凭证中解析，调用方无需单独传递。统计和明细链路会继续使用活码渠道过滤；system 只用于跳过普通 B 端员工可见范围，不表示绕过应用、企业或活码范围校验。

请求示例

{
  "access_token": "xe_xxxxx",
  "card_id": "10001",
  "page_size": 20
}

如需按普通 B 端用户权限查询：

{
  "access_token": "xe_xxxxx",
  "b_user_id": "b_xxx",
  "card_id": "10001",
  "page_size": 20
}

返回参数

参数名	类型	说明	备注
code	int	状态码，0 表示成功，非 0 表示失败	...
msg	string	状态信息	...
data	object	返回值	...
data.list	array	按活码分组的客户关系明细	当前请求为单个活码，因此通常返回一个分组
data.page_size	int	本次分页大小	...
data.next_cursor	string	下一页游标	无下一页时为空
data.has_more	bool	是否还有下一页	...
data.trade_data_degraded	bool	成交数据是否降级	补充成交数据的下游服务失败时为 true，明细关系仍可返回

data.list[].list 单条明细字段：

参数名	类型	说明	备注
follow_user_channel_id	string	客户跟进渠道 ID	...
corp_id	string	企业微信企业 ID	...
external_user_id	string	企业微信客户 ID	...
follow_user_id	string	跟进员工 ID	...
xiaoe_user_id	string	小鹅用户 ID	...
join_time	string	加入时间	...
transaction_number	int64	成交交易次数	交易数据不可用时为 0
pay_amount	int64	支付金额，单位为分	交易数据不可用时为 0
valid_pay_amount	int64	有效支付金额，单位为分	交易数据不可用时为 0

翻页示例

将上一页返回的 next_cursor 作为下一次请求的 cursor：

{
  "access_token": "xe_xxxxx",
  "card_id": "10001",
  "page_size": 20,
  "cursor": "NEXT_CURSOR"
}

错误说明

场景	说明
请求参数错误	access_token 或 card_id 缺失，或 page_size 超出 1-100 范围
查询失败	下游客户关系查询失败时，接口返回错误信息
成交数据降级	下游成交数据补充失败时，客户关系明细仍返回，trade_data_degraded 为 true，成交字段按 0 返回

直接调用平台客户搜索接口时，b_user_id 仍为必填；只有本活码统计/明细代理接口会将缺失或空白的 b_user_id 归一化为 system，并补充 follow_user_ids=["all"]。