登录
基础
连接微信
办公可调用该接口对企业的员工或者客户名称进行搜索
权限说明
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 需具备「数据与智能专区权限」 |
| 代开发应用 | 需具备「数据与智能专区权限」 |
| 第三方应用 | 需具备「数据与智能专区权限」 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
search_contact_or_customer
请求包体：
{
"query_word": "张三",
"query_user_type": 1,
"limit": 50,
"cursor": "CURSOR"
}参数说明：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| query_word | 是 | 搜索的文本，要求大于等于2个UTF8字符，小于32个UTF8字符。 当查询的用户类型类型包括员工时，关键字跟员工的姓名、姓名拼音或者别名字段匹配即可搜到 当查询的用户类型包括客户时，关键字跟客户的昵称、客户昵称拼音字段匹配即可搜到 |
| query_user_type | 否 | 搜索的用户类型。不填默认为 0 0. 员工和客户的名称 1. 员工名称 2. 客户名称 |
| limit | 否 | 用于分页查询，每次请求返回的数据上限。最大为100，不填默认为50 |
| cursor | 否 | 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 |
注：需要根据has_more是否为1来判断是否拉取结束，不能依赖返回的记录数。返回的记录数可能小于limit
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"has_more": 1,
"next_cursor": "CURSOR",
"user_list":[
{
"type": 1,
"id": "woAAAAAAAAAAA"
},
{
"type": 1,
"id": "woAAAAAAAAAAA"
}
]
}参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误码说明 |
| has_more | 是否还有更多数据未获取，不填默认为0 0: 否 1: 是 |
| next_cursor | 下一次请求的cursor值 |
| user_list | 搜索结果的员工或者客户id列表。 若type为员工，员工当前在存档范围才会返回 若type为客户，跟进人当前在存档范围才会返回对应的客户ID |
| user_list.id | 员工或者客户id |
| user_list.type | 用户身份类型。1：员工；2：外部联系人; |
基础连接微信办公基础连接微信办公基础连接微信办公