通讯录搜索-通讯录批量搜索

权限说明：

agentid为0则返回该服务商授权通讯录权限范围内的用户信息或者部门信息，否则返回指定agentid应用可见范围内的信息。
查询范围包含离职用户时，将查询一年内的所有离职用户。

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/service/contact/batchsearch?provider_access_token=' \ --header 'Content-Type: application/json' \ --data-raw '{ "auth_corpid":"wwxxxxxx", "agentid": 1000046, "query_request_list":[ { "query_word": "zhangsan", "query_type":1, "query_range":1, "limit":50, "full_match_field":1, "cursor":"CURSOR" } ] }'

{ "errcode": 0, "errmsg": "ok", "query_result_list": [ { "query_request": { "query_word": "zhangsan", "query_type": 1, "limit": 50, "cursor": "CURSOR" }, "query_result": { "user": { "userid": [ "zhangshan", "lisi" ], "open_userid": [ "wwxxxx", "wwxxxa" ] }, "party": { "department_id": [ 1, 2, 3 ] }, "dismiss_user": { "userid": [ "zhangshan", "lisi" ], "open_userid": [ "wwxxxx", "wwxxxa" ] } }, "is_last": false, "next_cursor": "NEXT_CURSOR" } ] }

请求参数

Query 参数

provider_access_token

必需

应用提供商的provider_access_token，获取方法参见服务商的凭证

示例值:

Body 参数application/json

auth_corpid

string

必需

查询的企业corpid

agentid

integer

可选

应用id，若非0则只返回应用可见范围内的用户或者部门信息

query_request_list

array [object {6}]

必需

搜索请求列表,每次搜索列表数量不超过50

query_word

string

可选

搜索关键词。当查询用户时应为用户名称、名称拼音或者英文名；当查询部门时应为部门名称或者部门名称拼音

query_type

integer

可选

查询类型 1：查询用户，返回用户userid列表 2：查询部门，返回部门id列表。不填该字段或者填0代表同时查询部门跟用户

query_range

integer

可选

查询范围，仅查询类型包含用户时有效。 0：只查询在职用户 1：同时查询在职和离职用户

limit

integer

可选

查询返回的最大数量，默认为50，最多为200，查询返回的数量可能小于limit指定的值。limit会分别控制在职数据和离职数据的数量。

full_match_field

integer

可选

如果需要精确匹配用户名称或者部门名称或者英文名，不填则默认为模糊匹配；1：匹配用户名称或者部门名称 2：匹配用户英文名

cursor

string

可选

用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

示例

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码

必需

errmsg

string

必需

对返回码的文本描述内容

query_result_list

array [object {4}]

必需

query_request

object

原搜索请求报文

可选

query_result

object

可选

搜索请求对应的查询结果

is_last

boolean

可选

根据该字段判断是否是最后一页，若为false，开发者需要使用limit+cursor继续调用

next_cursor

string

可选

分页游标，再下次请求时填写以获取之后分页的记录，如果已经没有更多的数据则返回空