请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/topapi/extcontact/get |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_ext_read-企业外部联系人读权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| user_id | String | 是 | 112500xxxx4889 | 外部联系人userId,可调用获取外部联系人列表接口获取userid参数值。 |
请求示例
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| result | OpenExtContact | 查询结果。 | |
| title | String | 开发工程师 | 职位。 |
| share_dept_ids | Number[] | [1,2,3] | 共享部门ID列表。 |
| label_ids | Number[] | [1,2,3] | 标签。 |
| remark | String | 备注内容 | 备注。 |
| address | String | 地址内容 | 地址。 |
| name | String | 张三 | 姓名。 |
| follower_user_id | String | 6767531692 | 负责人的userId。 |
| state_code | String | 86 | 国家码。 |
| company_name | String | 钉钉 | 公司名。 |
| share_user_ids | String[] | [“042059613752”] | 共享员工userId列表。 |
| mobile | String | 13088888888 | 手机号。 说明 第三方企业应用不返回此参数。 |
| userid | String | 0123456789 | 外部联系人userId。 |
| String | xxx@1.com | 邮箱。 | |
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| request_id | String | xrudojam4g8f | 请求ID。 |
响应体示例
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| 错误码(errcode) | 错误码描述(errmsg) | 解决方案 |
|---|---|---|
| 33009 | 无效的tokenGrantType | 请检查access_token是否正确 |
| 33012 | 无效的userId | 请检查userId是否正确 |
| 43007 | 需要操作权限 | 请检查access_token是否具有操作权限 |
| 400001 | 系统错误 | 请稍后再试 |