文档中心.开放API
企微中台聊天记录页的员工列表
更新时间：2022-11-15 10:21:44接口说明
企微中台聊天记录页的员工列表
基本信息
请求方式： GET
请求路径：
https://prod.open-api.mysre.cn/yx/qw-nbd-api/list-chat-employee
请求参数
| 参数名 | 参数位置 | 参数类型 | 必填 | 默认值 | 示例 | 描述 |
|---|---|---|---|---|---|---|
| app_id | query | string | 是 | value1 | 企微中台应用 id | |
| keyword | query | string | 否 | 搜索员工的关键词，如客户姓名、手机等 | ||
| custom_condition | query | string | 否 | 自定义查询条件，json 字符串，接入方可识别的格式，由接入方前后端自行约定格式 | ||
| pager.page | query | number | 否 | 页码，默认为 1 | ||
| pager.page_size | query | number | 否 | 分页行数，默认为 10 |
请求示例
get /qw-nbd-api/list-chat-employee?app_id=value1&keyword=&custom_condition=&pager.page&pager.page_size
返回成功示例
{
"errcode": 0,
"errmsg": "ok",
"total": "100",
"employees": [
{
"qw_user_id": "xaaaa",
"name": "喵大壮",
"avatar": "https://xxxx"
},
{
"qw_user_id": "string",
"name": "string",
"avatar": "string"
}
]
}
返回参数说明（成功）
| 参数名 | 参数类型 | 描述 |
|---|---|---|
失败返回示例
{
"errcode": 100,
"errmsg": "ok",
}
返回参数说明（失败）
| 参数名 | 参数类型 | 描述 |
|---|---|---|