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

权限说明：

agentid为0则返回该服务商授权通讯录权限范围内的用户信息或者部门信息，否则返回指定agentid应用可见范围内的信息

请求参数

Query 参数

provider_access_token

string

必需

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

示例值:

Body 参数application/json

agentid

integer <int32>

可选

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

query_request_list

array [object {5}]

必需

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

offset

integer <int32>

可选

查询的偏移量，每次调用的offset在上一次offset基础上加上limit

full_match_field

integer <int32>

可选

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

limit

integer <int32>

可选

查询返回的最大数量，默认为50，最多为200，查询返回的数量可能小于limit指定的值

query_word

string

必需

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

query_type

integer <int32>

可选

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

auth_corpid

string

必需

查询的企业corpid

示例

{
  "auth_corpid": "wwxxxxxx",
  "agentid": 1000046,
  "query_request_list": [
    {
      "query_word": "zhangsan",
      "query_type": 1,
      "offset": 0,
      "limit": 50,
      "full_match_field": 1
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

query_result_list

array [object {3}]

搜索结果列表

可选

is_last

boolean

可选

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

query_request

object

原搜索请求报文

可选

query_result

object

可选

搜索请求对应的查询结果

errmsg

string

可选

对返回码的文本描述内容

示例

{
  "errcode": 0,
  "query_result_list": [
    {
      "is_last": true,
      "query_request": {
        "offset": 0,
        "limit": 0,
        "query_word": "string",
        "query_type": 0
      },
      "query_result": {
        "user": {
          "open_userid": [
            "string"
          ],
          "userid": [
            "string"
          ]
        },
        "party": {
          "department_id": [
            0
          ]
        }
      }
    }
  ],
  "errmsg": "string"
}