获取外部联系人列表

说明

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

权限

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

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

错误码

错误码（errcode）	错误码描述（errmsg）	解决方案
33009	无效的tokenGrantType	请检查access_token是否正确
40069	无效的size	请调整分页大小
40068	无效的偏移量	请调整偏移量
400001	系统错误	请稍后再试

curl --location --request POST 'https://oapi.dingtalk.com/topapi/extcontact/list?access_token=6d1bxxxx' \ --header 'Content-Type: application/json' \ --data-raw '{ "size":20, "offset":0 }'

{ "errcode": 0, "results": [ { "address": "北京", "company_name": "钉钉", "email": "zhang@example.com", "follower_user_id": "manager4220", "label_ids": [ 1517 ], "mobile": "1360054xxxx", "name": "王经理", "remark": "技术负责人", "share_dept_ids": [ 42536 ], "share_user_ids": [ "0423752" ], "state_code": "86", "title": "CFO", "userid": "01129774889" } ], "request_id": "439eqp31da45" }

请求参数

Query 参数

access_token

必需

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

示例值:

6d1bxxxx

Body 参数application/json

size

number

可选

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

offset

number

可选

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

示例

返回响应

🟢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。

可选

获取外部联系人列表

说明#

权限#

错误码#

请求参数

返回响应

说明

权限

错误码