获取外部联系人列表

说明

调用本接口获取企业外部联系人列表。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

size

number

可选

支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100。

offset

number

可选

支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。

示例

{
  "size": 20,
  "offset": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

results

array [object {13}]

查询结果。

可选

title

string

职位。

可选

share_dept_ids

array[number]

共享部门ID列表。

可选

label_ids

array[number]

可选

标签，可调用获取外部联系人标签列表接口查询标签信息。

remark

string

备注。

可选

address

string

地址。

可选

name

string

姓名。

可选

follower_user_id

string

可选

负责人的userid。

state_code

string

国家码。

可选

company_name

string

公司名。

可选

share_user_ids

array[string]

可选

共享员工userid列表。

mobile

string

可选

手机号。第三方企业应用不返回此参数。

userid

string

可选

外部联系人的userid。

string

邮箱。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
  "results": [
    {
      "title": "string",
      "share_dept_ids": [
        0
      ],
      "label_ids": [
        0
      ],
      "remark": "string",
      "address": "string",
      "name": "string",
      "follower_user_id": "string",
      "state_code": "string",
      "company_name": "string",
      "share_user_ids": [
        "string"
      ],
      "mobile": "string",
      "userid": "string",
      "email": "string"
    }
  ],
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限