友米聚合 - 开放API
  1. Report
友米聚合 - 开放API
  • 应用场景
    • 自有订单系统 嵌入 企客聊侧边栏
  • v1
    • 文档
      • 介绍
        • 开发文档阅读说明
        • 错误码返回说明
      • 入门说明
        • 生成signature
        • 获取TOKEN方法
        • 请求Headers说明
      • 接口详情
        • 基础数据类接口
        • 数据读取类接口
        • 行为操作类接口
        • 回调数据
  • v2
    • 事件发布格式说明
    • ChatMess
      • 发送消息
      • 申请接管
      • 终止接管
      • 激活会话
      • 发送通知
      • 读取聊天记录
    • Report
      • 获取员工客服统计
        POST
      • 获取员工激活客户数统计
        POST
    • System
      • 获取部门列表
      • 根据部门获得组
      • 根据组获得员工
      • 获得员工列表
    • Friend
      • 读取粉丝列表
      • 读取粉丝总数
    • Todo
      • 新增待办记录
      • 新增待办记录(返回编号)
      • 获取待办列表
      • 获取待办列表总数
    • Ad
      • 读取广告列表
      • 读取广告条数
    • BulkSend
      • 保存RPA群发
      • 删除RPA群发
    • 注册回调地址
      POST
    • 订阅事件
      POST
    • 获取商户TOKEN
      POST
  1. Report

获取员工客服统计

POST
/v2/Report/GetDataByStaffCustomer
ChatMess

请求参数

Header 参数
Authorization
可选
授权TOKEN,Bearer
示例值:
Bearer
TenantId
可选
租户ID,仅限代理商使用
Body 参数application/json
startDate
string 
开始时间
可选
格式:yyyy-MM-dd HH:mm:ss
endDate
string 
结束时间
可选
格式:yyyy-MM-dd HH:mm:ss
orderKey
string  | null 
排序字段
可选
默认ad_staff_name;支持ad_staff_name、depart_name、depart_group_name
orderType
string 
排序方式
必需
默认desc;支持desc、asc
staffCode
string 
所选员工
可选
departId
integer 
所选部门
可选
默认-1
departGroupId
integer 
所选分组
可选
默认-1
show
enum<integer> 
显示方式
必需
1=部门、2=组、3=员工
枚举值:
123
默认值:
3
staffState
boolean 
员工状态
必需
true=包含停用、false=不含停用
wechatLei
enum<integer> 
运营号类型
必需
0=个微、1=公众号、2=小程序、3=企微
枚举值:
0123
默认值:
0
relationIsFlock
enum<integer> 
粉丝类型
必需
-1=全部、0=好友、1=群、2=企微好友、3=企微群
枚举值:
-10123
默认值:
-1
searchData
enum<integer> 
数据类型
必需
0=实时数据、1=日终数据
枚举值:
01
默认值:
0
pageIndex
integer 
分页
必需
pageSize
integer 
单页条数
必需
示例
{
  "startDate": "string",
  "endDate": "string",
  "orderKey": "string",
  "orderType": "string",
  "staffCode": "string",
  "departId": 0,
  "departGroupId": 0,
  "show": 3,
  "staffState": true,
  "wechatLei": 0,
  "relationIsFlock": -1,
  "searchData": 0,
  "pageIndex": 0,
  "pageSize": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Report/GetDataByStaffCustomer' \
--header 'Authorization: Bearer' \
--header 'TenantId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "startDate": "string",
    "endDate": "string",
    "orderKey": "string",
    "orderType": "string",
    "staffCode": "string",
    "departId": 0,
    "departGroupId": 0,
    "show": 3,
    "staffState": true,
    "wechatLei": 0,
    "relationIsFlock": -1,
    "searchData": 0,
    "pageIndex": 0,
    "pageSize": 0
}'

返回响应

🟢200Success
application/json
Body
requestId
string 
必需
errmsg
integer 
必需
succeed
boolean 
必需
msgTime
string 
必需
values
array [object {16}] 
必需
ad_staff_name
string 
员工名称
必需
ad_staff_code
string 
员工编号
必需
linecount
integer 
进线数
必需
replycount
integer 
未回复数
必需
visitnum
integer 
来访客户数
必需
visitcount
integer 
收消息条数
必需
activationnum
integer 
激活客户数
必需
activationcount
integer 
发消息条数
必需
interactivenum
integer 
互动客户数
必需
addcount
integer 
新增数
必需
addfriend
integer 
新增好友数
必需
addchatroom
integer 
新增群数
必需
endnum
integer 
期末客户数
必需
linezhanbi
integer 
进线占比
必需
replyczhanbi
integer 
未回复率
必需
rn
integer 
必需
errdesc
null 
必需
示例
{
  "requestId": "string",
  "errmsg": 0,
  "succeed": true,
  "msgTime": "string",
  "values": [
    {
      "ad_staff_name": "string",
      "ad_staff_code": "string",
      "linecount": 0,
      "replycount": 0,
      "visitnum": 0,
      "visitcount": 0,
      "activationnum": 0,
      "activationcount": 0,
      "interactivenum": 0,
      "addcount": 0,
      "addfriend": 0,
      "addchatroom": 0,
      "endnum": 0,
      "linezhanbi": 0,
      "replyczhanbi": 0,
      "rn": 0
    }
  ],
  "errdesc": null
}
上一页
读取聊天记录
下一页
获取员工激活客户数统计
Built with