# 查询客服账号列表

# 请求方式

GET

# 请求地址

https://nbd-api.myscrm.cn/bff-nbd-qw-openapi/v1/kefu/list

# 请求参数

# 示例

https://nbd-api.myscrm.cn/bff-nbd-qw-openapi/v1/kefu/list?app_id=xxx&project_id=xxx&user_id=xxx&pager.page=1&pager.page_size=10

# 说明

名称	类型	是否必须	说明
app_id	string	是	企微中台应用 id
kefu_name	string	否	客服名称
project_id	string	是	项目id, 项目共用 == common，多个项目用英文逗号分割
user_id	string	是	后台登录管理员的用户id
pager.page	int64	是	页码
pager.page_size	int64	是	页数

# 返回参数

# 示例

{
  "errcode": 0,
  "errmsg": "ok",
  "list": [
    {
      "kefu_id": "string",
      "kefu_name": "string",
      "kefu_photo": "string",
      "kefu_photo_path": "string",
      "message_count": 0,
      "receptionist_count": 0,
      "qw_url": "string",
      "reception_customer_count": 0,
      "welcome_msg": {
        "type": "string",
        "text": "string",
        "menu": {
          "head_content": "string",
          "items": [
            {
              "hit_content": "string",
              "display_content": "string"
            }
          ]
        }
      },
      "autorespond_reception": true,
      "session_timeout_second": 0,
      "project_list": [
        {
          "organ_proj_id": "string",
          "organ_proj_name": "string"
        }
      ],
      "qw_kefu_name": "string",
      "ending_words_type": 0,
      "ending_words": "string",
      "prefer_last_receptionist": true,
      "receptionist_distribute_rule": 0,
      "max_reception_num": 0,
      "queuing_words": "string",
      "schedule": {
        "work_start_at": "string",
        "work_end_at": "string",
        "work_at_monday": true,
        "work_at_tuesday": true,
        "work_at_wednesday": true,
        "work_at_thursday": true,
        "work_at_friday": true,
        "work_at_saturday": true,
        "work_at_sunday": true
      },
      "off_duty_response": "string"
    }
  ],
  "pager": {
    "page": "0",
    "page_size": "0",
    "total_rows": "0"
  }
}

# 说明

名称	类型	备注
list	array
list.kefu_id	string	客服账号 id
list.kefu_name	string	客服名称
list.kefu_photo	string	客服头像url
list.kefu_photo_path	string	客服头像oss path
list.message_count	uint64	接入系统后该客服账号接收到的信息数量
list.receptionist_count	uint32	关联的接待人员数量
list.qw_url	string	客服账号链接
list.reception_customer_count	uint32	接待客户数
list.welcome_msg	object	欢迎语
list.welcome_msg.type	string	欢迎语类型：
text-文本；msgmenu-菜单消息;
list.welcome_msg.text	string	欢迎语 - 文本消息
list.welcome_msg.menu	object	欢迎语 - 菜单消息
list.welcome_msg.menu.head_content	string	起始文本
list.welcome_msg.menu.items	array	菜单项配置
list.welcome_msg.menu.items.hit_content	string	菜单触发时的文本
list.welcome_msg.menu.items.display_content	string	菜单显示时展示的文本
list.autorespond_reception	bool	是否使用智能助手接待
list.session_timeout_second	int32	会话超时时间 - 秒
list.project_list	array	客服项目关联
@inject_tag: validate:"dive" comment:"自动回复项目关联"
list.project_list.organ_proj_id	string	关联项目id
@inject_tag: validate:"required" comment:"关联项目id"
list.project_list.organ_proj_name	string	关联项目名称
@inject_tag: validate:"required" comment:"关联项目名称"
list.qw_kefu_name	string	对外展示的客服名称
list.ending_words_type	int32	结束语类型 1 发送满意度评价菜单 2 发送会话结束提醒文本 3 不发送结束语
list.ending_words	string	结束语文本
list.prefer_last_receptionist	bool	是否优先分配上次接待人员
list.receptionist_distribute_rule	int32	接待人员分配规则 1轮流分配 2空闲分配
list.max_reception_num	int32	单人同时最多接待客户数，数值范围 1-50
autorespond_reception 为 true 时必传
list.queuing_words	string	排队提示语
autorespond_reception 为 true 时必传
list.schedule	object	接待时间
autorespond_reception 为 true 时必传
list.schedule.work_start_at	string	上班时间，格式 13:56
list.schedule.work_end_at	string	下班时间，格式 21:56
list.schedule.work_at_monday	bool	周一是否接待
list.schedule.work_at_tuesday	bool	周二是否接待
list.schedule.work_at_wednesday	bool	周三是否接待
list.schedule.work_at_thursday	bool	周四是否接待
list.schedule.work_at_friday	bool	周五是否接待
list.schedule.work_at_saturday	bool	周六是否接待
list.schedule.work_at_sunday	bool	周日是否接待
list.off_duty_response	string	非接待时间自动回复文本
pager	object	分页参数
pager.page	string	页码
pager.page_size	string	页数
pager.total_rows	string	总行数

← 迁移已有的客服账号到企微中台