获取机器人的客户列表

请求方式：POST

请求地址：https://$basehost/gateway/qopen/GetRobotAccountListV2

注意:

由于数据量级比较大，这边建议拉取全量只在机器人登录后/每天凌晨闲时进行全量拉取，其他时间可以依靠被动的好友回调来更新本地数据，或者间隔一段时间调用/qopen/GetRobotAccountListV2接口，但同时传递from_updated_at从上次更新时间之后来进行增量拉取

body参数：

{
    "robot_id": "机器人id",
    "offset": 0,
    "limit": 10,
    "need_tag_info": false,
    "need_user_attr_field": false,
    "need_user_attr_sys_field": false,
    "need_empty_attr_field": false
}

字段	类型	必填	说明
robot_id	string	是	机器人id
offset	int	是	每次获取的的开始位置，最小值为0
limit	int	是	每次获取的条数，取值范围（1～100）
need_tag_info	bool	否	是否需要客户标签信息
from_updated_at	int	否	拉取指定的更新时间之后的数据，时间戳格式
need_user_attr_field	bool	否	是否返回 need_user_attr_field （默认fasle）
need_user_attr_sys_field	bool	否	是否返回 need_user_attr_sys_field （默认fasle）
need_empty_attr_field	bool	否	是否返回空属性字段 （默认fasle）

返回值：

{
    "data": {
        "has_more": true,
        "account_list": [
            {
                "account_id": "客户id",
                "account_type": 2,
                "deleted_by_contact": false,
                "deleted_by_staff": false,
                "profile": {
                    "name": "姓名",
                    "gender": 0,
                    "avatar": "头像url",
                    "alias": "备注",
                    "phone": 1399998888,
                    "add_way": 2,
                    "add_at": 1624873867,
                    "union_id": "微信union_id",
                    "phone_list": [
                      "1399998888"
                    ],
                    "external_user_id": "微信external_user_id",
                    "state_code": "微信添加来源state",
                    "channel_name": "微信添加渠道",
                    "desc": "客户描述"
                },
                "user_attr_sys_field_list": [
                    {
                        "field_name": "备注",
                        "field_value": ""
                    },
                    {
                        "field_name": "生日1",
                        "field_value": "2022-05-12"
                    }
                ],
                "user_attr_field_list": [
                    {
                        "field_name": "user_attr_field1",
                        "field_value": "user_attr_value1"
                    },
                    {
                        "field_name": "user_attr_field2",
                        "field_value": "user_attr_value2"
                    }
                ],
                "tag_info_list":[
                    {
                        "parent_tag_name": "标签组名称",
                        "tag_name": "标签名称"
                    }
                ]
            }
        ]
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

返回说明

字段	类型	说明
data	json	json返回值
has_more	bool	是否还有更多
account_list	array	客户列表
errcode	int	状态码，0为正常，非0代表错误
errmsg	string	错误信息
hint	string	请求日志ID

account_list说明

字段	类型	说明
account_id	string	客户id
account_type	int	客户类型：0:客户类型未知，1=员工，2=微信外部联系人，3=企业微信外部联系人
deleted_by_contact	bool	是否被客户删除
deleted_by_staff	bool	是否主动删除客户
profile	object	详细信息
user_attr_sys_field_list	array	用户系统属性字段列表
user_attr_field_list	array	用户自定义属性字段列表
tag_info_list	array	获取到的客户标签列表

profile说明

字段	类型	说明
name	string	姓名
gender	int	性别 0为未知，1为男，2为女
avatar	string	头像url
alias	string	别名
phone	string	[废弃]电话号码，请使用phone_list
phone_list	list	如存在多个手机号则返回数组
add_at	int	添加时间
add_way	string	添加方式
union_id	string	微信union_id
external_user_id	string	微信external_user_id
state_code	string	微信添加来源state
channel_name	string	微信添加渠道
desc	string	客户描述

tag_info_list说明

字段	类型	说明
parent_tag_name	string	标签组名称
tag_name	string	标签名称

add_way枚举说明

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

完整请求示例：

curl -X POST \
  https://$basehost/gateway/qopen/GetRobotAccountList \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
    "robot_id": "",
    "offset": 0,
    "limit": 10,
    "need_tag_info": false
}'