添加外部联系人

POST

http://127.0.0.1/topapi/extcontact/create

服务端API/通讯录管理/外部联系人

最后修改时间：2022-08-30 09:19:22

责任人：未设置

说明

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

权限

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

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

请求参数

Query 参数

access_token

string

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

contact

object

外部联系人信息。

必需

title

string

职位。

可选

label_ids

array[number]

必需

标签列表，可调用获取外部联系人标签列表接口查询标签信息。参考企业如何自定义标签组添加自定义标签。

share_dept_ids

array[number]

可选

共享给的部门ID，可调用获取子部门ID列表接口获取。

address

string

地址。

可选

remark

string

备注。

可选

follower_user_id

string

必需

负责人的userId，可通过根据手机号获取userid接口获取userid。

name

string

外部联系人的姓名。

必需

state_code

string

手机号国家码。

必需

company_name

string

可选

外部联系人的企业名称。

share_user_ids

array[string]

可选

共享给的员工userid列表，可通过根据手机号获取userid接口获取userid。

mobile

string

必需

外部联系人的手机号。

示例

{
    "contact": {
        "name": "张xx",
        "mobile": "130xxxx8888",
        "remark": "王经理",
        "follower_user_id": "manager4220",
        "title": "开发工程师",
        "state_code": "86",
        "label_ids": [
            1561077317,
            1561077310
        ],
        "share_dept_ids": [
            1,
            2,
            3
        ],
        "share_user_ids": [
            "023420013644"
        ],
        "address": "北京市"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/extcontact/create?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact": {
        "name": "张xx",
        "mobile": "130xxxx8888",
        "remark": "王经理",
        "follower_user_id": "manager4220",
        "title": "开发工程师",
        "state_code": "86",
        "label_ids": [
            1561077317,
            1561077310
        ],
        "share_dept_ids": [
            1,
            2,
            3
        ],
        "share_user_ids": [
            "023420013644"
        ],
        "address": "北京市"
    }
}'

返回响应

🟢200成功

application/json

Body

userid

string

可选

外部联系人的userId。

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
    "userid": "string",
    "errcode": 0,
    "errmsg": "string",
    "request_id": "string"
}

修改于 2022-08-30 09:19:22

获取指定角色的员工列表

删除外部联系人

添加外部联系人

说明#

权限#

请求参数

示例代码

返回响应

说明

权限