客服查询接口

根据指定的查询条件查询客服列表

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/iservice/ccm/agent/query' \ --header 'Content-Type: application/json' \ --data-raw '{ "answering_mode": "0", "ccs_instance_id": "XAHSNRBS", "email": "test@163.com", "page_num": 1, "page_size": 10, "real_name": "张三", "chat_ext_group_ids": "[\"123\"]", "chat_group_ids": "[\"123\"]", "chat_level_ids": "[\"123\"]", "hotline_group_ids": "[\"123\"]", "role_ids": "[\"123\"]" }'

{ "agents": [ { "answering_mode": "0", "avatar": "testfile", "chat_config": [ { "ccs_instance_id": "string", "group_id": "string", "level_id": "string", "extended_group_ids": [ "string" ] } ], "creator_id": "2019032101896769", "dingtalk_user_id": "1293894912", "email": "test@163.com", "external_id": "2088xxx", "hotline_config": [ { "ccs_instance_id": "string", "group_ids": [ "string" ] } ], "id": "2019032101896769", "job_number": "0002", "mobile": "13812345678", "nick_name": "风清扬", "profile": "我是玉树临风一表人才的张三", "real_name": "张三", "role_ids": [ { "ccs_instance_id": "string", "role_id": "string" } ], "status": "NORMAL", "type": "NORMAL", "updater_id": "2019032101896769", "ccs_instance_ids": "[\"XAHSNRBS\"]", "create_time": {}, "last_login_time": {}, "update_time": {} } ], "page_num": 1, "page_size": 10, "total_count": 99 }

请求参数

Body 参数application/json

answering_mode

string

热线接入方式

可选

示例值:

ccs_instance_id

string

部门id

可选

示例值:

XAHSNRBS

string

客服邮箱

可选

示例值:

test@163.com

page_num

integer

可选

查询结果的页码，起始值为 1，默认值为 1

示例值:

page_size

integer

可选

分页查询时设置的每页记录数，最大值 100 行，默认为 10

示例值:

real_name

string

客服姓名

可选

示例值:

张三

chat_ext_group_ids

array[string]

在线扩展技能组id

可选

示例值:

["123"]

chat_group_ids

array[string]

在线技能组id

可选

示例值:

["123"]

chat_level_ids

array[string]

在线服务等级

可选

示例值:

["123"]

hotline_group_ids

array[string]

热线扩展技能组id

可选

示例值:

["123"]

role_ids

array[string]

客服角色id

可选

示例值:

["123"]

示例

返回响应

🟢200common response

application/json

Body

agents

array[object (AgentVO) {22}]

客服列表

可选

answering_mode

string

热线接入方式

可选

示例值:

avatar

string

可选

头像的oss file key

示例值:

testfile

chat_config

array[object (AgentChatInfo) {4}]

在线技能组信息

可选

creator_id

string

创建人id

可选

示例值:

2019032101896769

dingtalk_user_id

string

可选

钉钉user_id（绑定钉钉的用户该字段非空）

示例值:

1293894912

string

客服邮箱

可选

示例值:

test@163.com

external_id

string

可选

外部系统用户,比如金融云的用户id、支付宝账号id

示例值:

2088xxx

hotline_config

array[object (AgentHotlineInfo) {2}]

热线技能组信息

可选

string

客服唯一标识id

可选

示例值:

2019032101896769

job_number

string

客服工号

可选

示例值:

0002

mobile

string

客服手机号

可选

示例值:

13812345678

nick_name

string

客服昵称

可选

示例值:

风清扬

profile

string

个人简介

可选

示例值:

我是玉树临风一表人才的张三

real_name

string

客服姓名

可选

示例值:

张三

role_ids

array[object (RoleId) {2}]

客服角色id列表

可选

status

string

可选

状态：NORMAL，DELETE

示例值:

NORMAL

type

string

可选

用户类型：NORMAL（普通客服），ADMIN（超级管理员，不能被删除）

示例值:

NORMAL

updater_id

string

最后修改人id

可选

示例值:

2019032101896769

ccs_instance_ids

array[string]

可选

客服归属的部门id列表

示例值:

["XAHSNRBS"]

create_time

string

可选

创建时间，标准时间格式：yyyy-MM-dd HH:mm:ss

示例值:

{}

last_login_time

string

可选

最后登录时间,标准时间格式：yyyy-MM-dd HH:mm:ss

示例值:

{}

update_time

string

可选

最后修改时间，标准时间格式：yyyy-MM-dd HH:mm:ss

示例值:

{}

page_num

integer

可选

查询结果的页码，起始值为 1，默认值为 1

示例值:

page_size

integer

可选

分页查询时设置的每页记录数，最大值 100 行，默认为 10

示例值:

total_count

integer

总条目数

可选

示例值:

🔴500请求失败