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

读取粉丝列表

POST
/v2/Friend/GetFansList
ad_relation_scene
来源字段枚举

个微#

1:通过搜索QQ号添加
3:通过搜索微信号添加
8:14:通过群聊添加
10:13:通过手机通讯录添加
15:通过搜索手机号添加
17:通过名片分享添加
18:通过附近的人添加
24:27:28:29:通过摇一摇添加
25:通过漂流瓶添加
30:通过扫一扫添加
48:雷达
65:对方通过搜索QQ号添加
67:对方通过搜索微信号添加
74:对方通过手机通讯录添加
78:对方通过群聊添加
77:79:对方通过搜索手机号添加
81:对方通过名片分享添加
82:对方通过附近的人添加
89:对方通过漂流瓶添加
93:对方通过摇一摇添加
94:对方通过扫一扫添加

企微#

0:未知
1:扫描二维码
2:搜索手机号
3:名片分享
4:群聊
5:手机通讯录
6:微信联系人
7:来自微信的添加好友申请
8:安装第三方应用时自动添加的客服人员
9:搜索邮箱
10:视频号主页添加
201:内部成员共享
202:管理员/负责人分配

请求参数

Header 参数

Body 参数application/json

示例
{
    "wechatId": 0,
    "wechatKey": "string",
    "fansKe": "string",
    "fansName": "string",
    "addStartTime": 0,
    "addEndTime": 0,
    "bindStartTime": 0,
    "bindEndTime": 0,
    "lastChatStartTime": 0,
    "lastChatEndTime": 0,
    "staffCode": "string",
    "minUpdateTime": 0,
    "relationType": 0,
    "relationState": 0,
    "wechatType": 0,
    "orderByKey": "string",
    "orderByModel": "string",
    "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/Friend/GetFansList' \
--header 'Authorization;' \
--header 'TenantId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "wechatId": 0,
    "wechatKey": "string",
    "fansKe": "string",
    "fansName": "string",
    "addStartTime": 0,
    "addEndTime": 0,
    "bindStartTime": 0,
    "bindEndTime": 0,
    "lastChatStartTime": 0,
    "lastChatEndTime": 0,
    "staffCode": "string",
    "minUpdateTime": 0,
    "relationType": 0,
    "relationState": 0,
    "wechatType": 0,
    "orderByKey": "string",
    "orderByModel": "string",
    "pageIndex": 0,
    "pageSize": 0
}'

返回响应

🟢200Success
application/json
Body

示例
{
    "requestId": null,
    "errmsg": 0,
    "succeed": true,
    "msgTime": "string",
    "values": [
        {
            "ad_expand2": "string",
            "ad_expand": "string",
            "ad_relation_time": "string",
            "ad_del_time": "string",
            "ad_bind_time": 0,
            "details": "string",
            "ad_manage_name": "string",
            "ad_ditch_name": "string",
            "ad_order": null,
            "ad_updatechatting_time": "string",
            "ad_request_time": 0,
            "ad_relation_remark": "string",
            "ad_relation_expand3": 0,
            "ad_wechat_lei": 0,
            "ad_relation_isflock": 0,
            "ad_wechatreply_time": 0,
            "ad_relation_state": 0,
            "ad_label": "string",
            "ad_relation_scene": 0,
            "ad_relation_addedmode": 0,
            "ad_description": "string",
            "user_moble": "string",
            "user_nick": "string",
            "user_name": "string",
            "user_chenwei": "string",
            "user_mobletwo": "string",
            "user_moblethree": "string",
            "ad_friend_wenober": "string",
            "ad_friend_id": 0,
            "ad_friend_uwenober": "string",
            "username": "string",
            "sign": null,
            "avatar": "string",
            "id": "string",
            "ad_wechat_nick": "string",
            "ad_wechat_nober": "string",
            "ad_original_nober": "string",
            "ad_wechat_id": 0,
            "organize_id": "string",
            "user_unionid": "string"
        }
    ],
    "errdesc": null
}
修改于 2025-03-19 09:47:24
上一页
获得员工列表
下一页
读取粉丝总数
Built with