登录
基础
连接微信
办公目录
请求方式：POST（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/service/contact/search?provider_access_token=ACCESS_TOKEN
请求包体：
{
"auth_corpid":"wwxxxxxx",
"query_word": "zhangsan",
"query_type":1,
"query_range":1,
"agentid": 1000046,
"limit":50,
"full_match_field":1,
"cursor":"CURSOR"
}
参数说明：
| 参数 | 必须 | 说明 |
|---|---|---|
| provider_access_token | 是 | 应用提供商的provider_access_token，获取方法参见服务商的凭证 |
| auth_corpid | 是 | 查询的企业corpid |
| query_word | 是 | 搜索关键词。当查询用户时应为用户名称、名称拼音或者英文名；当查询部门时应为部门名称或者部门名称拼音。最长64个utf8字 |
| query_type | 否 | 查询类型 1：查询用户，返回用户userid列表 2：查询部门，返回部门id列表。 不填该字段或者填0代表同时查询部门跟用户 |
| query_range | 否 | 查询范围，仅查询类型包含用户时有效。 0：只查询在职用户 1：同时查询在职和离职用户（离职用户仅当离职前有激活企业微信才可以被搜到） |
| agentid | 否 | 应用id，若非0则只返回应用可见范围内的用户或者部门信息 |
| limit | 否 | 查询返回的最大数量，默认为50，最多为200，查询返回的数量可能小于limit指定的值。limit会分别控制在职数据和离职数据的数量。 |
| full_match_field | 否 | 精确匹配的字段。1：匹配用户名称或者部门名称 2：匹配用户英文名。不填则为模糊匹配 |
| cursor | 否 | 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 |
权限说明：
agentid为0则返回该服务商授权通讯录权限范围内的用户信息或者部门信息，否则返回指定agentid应用可见范围内的信息。
查询范围包含离职用户时，将查询一年内的所有离职用户。
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"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"
}参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| is_last | 根据该字段判断是否是最后一页，若为false，开发者需要使用limit+cursor继续调用 |
| query_result | 查询结果 |
| query_result.user | 返回的在职用户信息（通过用户名称，拼音匹配） |
| query_result.user.userid | 查询到的用户userid |
| query_result.user.open_userid | 查询到的用户open_userid |
| query_result.party | 返回的部门信息 （通过部门名称，拼音匹配） |
| query_result.party.department_id | 返回的部门id |
| query_result.dismiss_user | 返回的离职用户信息（通过用户名称，拼音匹配） |
| query_result.dismiss_user.userid | 查询到的离职用户userid |
| query_result.dismiss_user.open_userid | 查询到的离职用户open_userid |
| next_cursor | 分页游标，再下次请求时填写以获取之后分页的记录，如果已经没有更多的数据则返回空 |
注意：由于查询结果会过滤掉不在应用可见范围的成员与部门，所以每次返回的记录数可能小于limit。此时，如果is_last为false，则说明后续还有匹配的记录，服务商需要继续调用该接口进行查询。
请求方式：POST（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/service/contact/batchsearch?provider_access_token=ACCESS_TOKEN
请求包体：
{
"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"
}
]
}
参数说明：
| 参数 | 必须 | 说明 |
|---|---|---|
| provider_access_token | 是 | 应用提供商的provider_access_token，获取方法参见服务商的凭证 |
| auth_corpid | 是 | 查询的企业corpid |
| agentid | 否 | 应用id，若非0则只返回应用可见范围内的用户或者部门信息 |
| query_request_list | 是 | 搜索请求列表,每次搜索列表数量不超过50 |
| query_request_list.query_word | 是 | 搜索关键词。当查询用户时应为用户名称、名称拼音或者英文名；当查询部门时应为部门名称或者部门名称拼音。最长64个utf8字 |
| query_request_list.query_type | 否 | 查询类型 1：查询用户，返回用户userid列表 2：查询部门，返回部门id列表。 不填该字段或者填0代表同时查询部门跟用户 |
| query_request_list.query_range | 否 | 查询范围，仅查询类型包含用户时有效。 0：只查询在职用户 1：同时查询在职和离职用户 |
| query_request_list.limit | 否 | 查询返回的最大数量，默认为50，最多为200，查询返回的数量可能小于limit指定的值。limit会分别控制在职数据和离职数据的数量。 |
| query_request_list.full_match_field | 否 | 如果需要精确匹配用户名称或者部门名称或者英文名，不填则默认为模糊匹配；1：匹配用户名称或者部门名称 2：匹配用户英文名 |
| query_request_list.cursor | 否 | 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 |
权限说明：
agentid为0则返回该服务商授权通讯录权限范围内的用户信息或者部门信息，否则返回指定agentid应用可见范围内的信息。
查询范围包含离职用户时，将查询一年内的所有离职用户。
返回结果：
{
"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_request": {
"query_word": "lisi",
"query_type": 1,
"limit": 50,
"cursor": "CURSOR"
},
"query_result": {
},
"is_last": false,
"next_cursor": "NEXT_CURSOR",
"errcode": -1,
"errmsg": "system error"
}
]
}参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| query_result_list | 搜索结果列表 |
| query_result_list.query_request | 原搜索请求报文 |
| query_result_list.query_result | 搜索请求对应的查询结果 |
| query_result_list.query_result.user | 返回的在职用户信息（通过用户名称，拼音匹配） |
| query_result_list.query_result.userid | 查询到的用户userid |
| query_result_list.query_result.open_userid | 查询到的用户open_userid |
| query_result_list.query_result. party | 返回的部门信息 （通过部门名称，拼音匹配） |
| query_result_list.query_result.party.department_id | 返回的部门id |
| query_result_list.query_result.dismiss_user | 返回的离职用户信息（通过用户名称，拼音匹配） |
| query_result_list.query_result.dismiss_user.userid | 查询到的离职用户userid |
| query_result_list.query_result.dismiss_user.open_userid | 查询到的离职用户open_userid |
| query_result_list.next_cursor | 分页游标，再下次请求时填写以获取之后分页的记录，如果已经没有更多的数据则返回空 |
| query_result_list.is_last | 根据该字段判断是否是最后一页，若为false，开发者需要使用limit+cursor继续调用 |
| query_result_list.errcode | 若对应的query_request请求失败，则会返回该字段，且errcode非0 |
| query_result_list.errmsg | errcode对应的描述 |
注：若某个query_request对应的errcode非0，返回的is_last为false，next_cursor为query_request中的cursor。开发者可重试该query_request请求。
基础连接微信办公基础连接微信办公基础连接微信办公