Appearance

获取渠道活码统计数据 ​

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

请求方式及url ​

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

接口调试

请求参数
响应结果
暂无响应数据

请求参数 ​

参数名必选类型说明备注
access_token是string专属token...
b_user_id否stringB 端操作人 ID；不传或传空时服务端使用 system 身份，并以 filters.follow_user_ids=["all"] 查询全部跟进员工范围普通 B 端用户 ID 仍按其原有可见范围查询
card_ids是arraystring 类型的渠道活码 ID 列表一次最多传入 200 个活码 ID，不允许为空数组

app_id 已包含在 access_token 凭证中，由服务端从凭证中解析，调用方无需单独传递。接口会对重复的活码 ID 去重。

请求示例 ​

json
{
  "access_token": "xe_xxxxx",
  "card_ids": [
    "10001",
    "10002"
  ]
}

b_user_id 为可选参数。缺失或为空时，服务端在受控的活码统计链路中使用 system，并向客户搜索服务传递 filters.follow_user_ids=["all"]。这表示查询当前应用范围内、这些活码渠道关联的全部跟进员工客户关系；不会绕过活码渠道过滤。直接调用平台客户搜索接口时，b_user_id 仍为必填，不能传空字符串。

返回参数 ​

参数名必选类型说明备注
code是int状态码，0 表示成功，非 0 表示失败...
msg是string状态信息...
data是object返回值...
data.list是array渠道活码统计列表无数据时为空数组

data.list 渠道活码统计列表

参数名类型说明备注
card_idstring渠道活码 ID与请求中的活码 ID 对应
xiaoe_user_countint当前活码关联的去重后小鹅用户数仅统计非空 xiaoe_user_id，同一用户在不同活码下分别计数
deal_user_countint成交人数；统计 transaction_number > 0 的用户数...
deal_amountfloat成交金额，单位：元由支付金额（分）汇总后换算为元

xiaoe_user_count 按每个活码独立统计当前关联的非空 xiaoe_user_id，同一活码内重复用户只计一次；同一用户在不同活码下分别计数。该字段基于客户关系查询结果计算，与成交数据补充独立，即使成交数据下游失败也不影响用户数。

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "card_id": "10001",
        "xiaoe_user_count": 123,
        "deal_user_count": 12,
        "deal_amount": 199.00
      },
      {
        "card_id": "10002",
        "xiaoe_user_count": 0,
        "deal_user_count": 0,
        "deal_amount": 0
      }
    ]
  }
}

错误说明 ​

场景说明
请求参数错误access_token 缺失，或 card_ids 为空；b_user_id 缺失或为空不会导致该开放接口请求失败，服务端会在统计链路内使用 system
活码数量超限单次请求的 card_ids 超过 200 个
查询失败下游客户数据查询失败时，接口返回错误信息；成交统计字段可能按服务端策略降级为 0