# 获取聊天记录页的客户列表

# 中台代码

ListChatExternalUser

# 请求方式

POST

# 请求参数

# 说明

参数	类型	必须	说明
app_id	string	是	企微中台应用 id
keyword	string	否	搜索客户的关键词，如客户姓名、手机等
custom_condition	string	否	自定义查询条件，json 字符串，接入方可识别的格式，由接入方前后端自行约定格式
pager.page	int	否	页码，默认为 1
pager.page_size	int	否	分页行数，默认为 10

# 示例

{
  "app_id": "39febb6a-81f3-0b9a-5698-79041b85d947",
  "keyword": "喵",
  "custom_condition": "xx",
  "pager": {
    "page": 1,
    "page_size": 10
  }
}

# 返回参数

# 说明

参数	类型	必须	说明
total	string	是	符合条件的总记录数
external_users	object[]	是	外部联系人列表
external_users.external_userid	string	是	外部联系人 id
external_users.name	string	是	外部联系人姓名
external_users.avatar	string	是	外部联系人头像
external_users.type	int	是	外部联系人类型：1-微信，2-企业
external_users.corp_name	string	否	外部联系人的企业简称

# 示例

{
  "errcode": 0,
  "errmsg": "ok",
  "total": "100",
  "external_users": [
    {
      "external_userid": "xa",
      "name": "喵大壮",
      "avatar": "https://xxxx",
      "type": 1,
      "corp_name": "明源云"
    }
  ]
}

获取聊天记录页的员工列表 →