创建成员

权限说明：仅通讯录同步助手或第三方通讯录应用可调用。

请求参数

Query 参数

access_token

string

可选

示例值:

Body 参数application/json

address

string

可选

地址。长度最大128个字符

gender

string

可选

性别。1表示男性，2表示女性

external_position

string

可选

对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。长度12个汉字内

mobile

string

可选

手机号码。企业内必须唯一，mobile/email二者不能同时为空

is_leader_in_dept

array[string]

可选

个数必须和参数department的个数一致，表示在所在的部门内是否为上级。1表示为上级，0表示非上级。在审批等应用里可以用来标识上级审批人

telephone

string

可选

座机。32字节以内，由纯数字、“-”、“+”或“,”组成。

to_invite

boolean

可选

是否邀请该成员使用企业微信（将通过微信服务通知或短信或邮件下发邀请，每天自动下发一次，最多持续3个工作日），默认值为true。

main_department

integer <int32>

主部门

可选

userid

string

必需

成员UserID。对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。

enable

integer <int32>

可选

启用/禁用成员。1表示启用成员，0表示禁用成员

avatar_mediaid

string

可选

成员头像的mediaid，通过素材管理接口上传图片获得的mediaid

name

string

必需

成员名称。长度为1~64个utf8字符

alias

string

可选

成员别名。长度1~32个utf8字符

extattr

object

可选

自定义字段。自定义字段需要先在WEB管理端添加，见扩展属性添加方法，否则忽略未知属性的赋值。与对外属性一致，不过只支持type=0的文本和type=1的网页类型，详细描述查看对外属性

position

string

可选

职务信息。长度为0~128个字符

department

array[string]

必需

成员所属部门id列表,不超过100个

external_profile

object

可选

成员对外属性，字段详情见对外属性

string

可选

邮箱。长度6~64个字节，且为有效的email格式。企业内必须唯一，mobile/email二者不能同时为空

order

array[string]

可选

部门内的排序值，默认为0，成员次序以创建时间从小到大排列。个数必须和参数department的个数一致，数值越大排序越前面。有效的值范围是[0, 2^32)

示例

{
  "userid": "zhangsan",
  "name": "张三",
  "alias": "jackzhang",
  "mobile": "+8613800000000",
  "department": [
    1,
    2
  ],
  "order": [
    10,
    40
  ],
  "position": "产品经理",
  "gender": "1",
  "email": "zhangsan@gzdev.com",
  "is_leader_in_dept": [
    1,
    0
  ],
  "enable": 1,
  "avatar_mediaid": "2-G6nrLmr5EC3MNb_-zL1dDdzkd0p7cNliYu9V5w7o8K0",
  "telephone": "020-123456",
  "address": "广州市海珠区新港中路",
  "main_department": 1,
  "extattr": {
    "attrs": [
      {
        "type": 0,
        "name": "文本名称",
        "text": {
          "value": "文本"
        }
      },
      {
        "type": 1,
        "name": "网页名称",
        "web": {
          "url": "http://www.test.com",
          "title": "标题"
        }
      }
    ]
  },
  "to_invite": true,
  "external_position": "高级产品经理",
  "external_profile": {
    "external_corp_name": "企业简称",
    "wechat_channels": {
      "nickname": "视频号名称"
    },
    "external_attr": [
      {
        "type": 0,
        "name": "文本名称",
        "text": {
          "value": "文本"
        }
      },
      {
        "type": 1,
        "name": "网页名称",
        "web": {
          "url": "http://www.test.com",
          "title": "标题"
        }
      },
      {
        "type": 2,
        "name": "测试app",
        "miniprogram": {
          "appid": "wx8bd8012614784fake",
          "pagepath": "/index",
          "title": "myminiprogram"
        }
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/cgi-bin/user/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userid": "zhangsan",
    "name": "张三",
    "alias": "jackzhang",
    "mobile": "+8613800000000",
    "department": [
        1,
        2
    ],
    "order": [
        10,
        40
    ],
    "position": "产品经理",
    "gender": "1",
    "email": "zhangsan@gzdev.com",
    "is_leader_in_dept": [
        1,
        0
    ],
    "enable": 1,
    "avatar_mediaid": "2-G6nrLmr5EC3MNb_-zL1dDdzkd0p7cNliYu9V5w7o8K0",
    "telephone": "020-123456",
    "address": "广州市海珠区新港中路",
    "main_department": 1,
    "extattr": {
        "attrs": [
            {
                "type": 0,
                "name": "文本名称",
                "text": {
                    "value": "文本"
                }
            },
            {
                "type": 1,
                "name": "网页名称",
                "web": {
                    "url": "http://www.test.com",
                    "title": "标题"
                }
            }
        ]
    },
    "to_invite": true,
    "external_position": "高级产品经理",
    "external_profile": {
        "external_corp_name": "企业简称",
        "wechat_channels": {
            "nickname": "视频号名称"
        },
        "external_attr": [
            {
                "type": 0,
                "name": "文本名称",
                "text": {
                    "value": "文本"
                }
            },
            {
                "type": 1,
                "name": "网页名称",
                "web": {
                    "url": "http://www.test.com",
                    "title": "标题"
                }
            },
            {
                "type": 2,
                "name": "测试app",
                "miniprogram": {
                    "appid": "wx8bd8012614784fake",
                    "pagepath": "/index",
                    "title": "myminiprogram"
                }
            }
        ]
    }
}'

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

示例

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

请求参数

示例代码

返回响应