リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/user/create |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_manage_addresslist-連絡先データ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | BE3xxxx | この API を呼び出すためのアプリ認証情報。社内アプリの access_token を取得する API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| userid | String | いいえ | zhangsan | 社員の一意な識別 ID(変更不可)、長さは 1~64 文字。 説明 - 社内で一意である必要があります。 - 指定しない場合、userId が自動生成されます。 |
| exclusive_account | Boolean | はい | true | 必ず true を指定してください。企業アカウントを作成することを意味します。 説明 企業アカウントのみに適用されます。 |
| exclusive_account_type | String | はい | dingtalk | 必ず dingtalk を指定してください。DingTalk セルフビルド企業アカウントを意味します。 説明 DingTalk セルフビルド企業アカウントのみに適用されます。 |
| login_id | String | はい | login_id3 | DingTalk セルフビルド企業アカウントのログイン名。 説明 携帯電話番号やメールリンクなどの情報を含めないことを推奨します。通信事業者の規制により新規登録 SMS がブロックされる場合があります。 |
| init_password | String | はい | init_password220 | DingTalk セルフビルド企業アカウントの初期パスワード。初期パスワードは少なくとも 8 文字必要です。 説明 - 全て英字または数値のみは不可です。 - 携帯電話番号、メール、リンクなどの情報を含めないことを推奨します。通信事業者の規制により新規登録 SMS がブロックされる場合があります。 |
| send_password_to_user | Boolean | いいえ | false | アカウントとパスワードを送信するかどうか。デフォルトは false: - false:送信しない - true:送信する 説明 - 送信時、社員の携帯電話番号宛に SMS、または個人メール宛にメールが送信されます。 - このパラメータが true の場合、init_password パラメータは必須です。指定しない場合は送信されません。 |
| name | String | はい | 山田太郎 | 社員名。最大 80 文字。 |
| dept_id_list | String | はい | ”2,3,4” | 所属部門 ID のリスト。複数の部門 ID は 半角カンマ で区切ります。1 回の呼び出しで最大 100 個の部門 ID を指定できます。 |
| telephone | String | いいえ | 010-86123456-2345 | 内線番号。最大 50 文字。 説明 内線番号は一意であり、社内で重複できません。 |
| job_number | String | いいえ | 4 | 社員番号。最大 50 文字。 |
| title | String | いいえ | 技術ディレクター | 職位。最大 200 文字。 |
| String | いいえ | test@xxx.com | 社員の個人メール。最大 50 文字。 説明 社員のメールは一意であり、社内で重複できません。 | |
| org_email | String | いいえ | test@xxx.com | 社員のエンタープライズメール。最大 100 文字。 説明 以下の条件を満たす場合にのみこのフィールドが有効になります:社員がエンタープライズメールを開通済みであること。 |
| org_email_type | String | いいえ | profession | 社員のエンタープライズメールタイプ: - profession: 標準版。 - base: ベーシック版。 |
| work_place | String | いいえ | 未来パーク | 勤務地。最大 100 文字。 |
| remark | String | いいえ | 表示名情報 | 表示名。最大 2000 文字。 |
| dept_order_list | Object[] | いいえ | 対応する部門内における社員の並び替え順。 | |
| dept_id | Number | いいえ | 2 | 部門 ID。 |
| order | Number | いいえ | 1 | 部門内における社員の並び替え順。数値が大きいほど上位に表示されます。 |
| dept_title_list | Object[] | いいえ | 対応する部門内における社員の職位。 | |
| dept_id | Number | いいえ | 2 | 部門 ID。 |
| title | String | いいえ | シニアプロダクトマネージャー | 部門内における社員の職位。 |
| extension | String | いいえ | {"趣味":"旅行","年齢":"24"} | 拡張属性。複数の属性を設定可能。最大長は 2000 文字。説明 - 携帯電話には最大 10 個の拡張属性しか表示できません。 - このパラメータを使用する前に、DingTalk 管理コンソール で該当属性を追加してから、API を呼び出して値を設定してください。 - このフィールドの値はリンクタイプの入力に対応し、リンクは変数ワイルドカードによる自動置換にも対応しています。現在対応しているワイルドカードは userid、corpid です。例:{"趣味":"[趣味](http://www.dingtalk.io?userid=#userid#&corpid=#corpid#)"}。 |
| senior_mode | Boolean | いいえ | false | 役員モードをオンにするかどうか。デフォルトは false。 - true:オンにする。 説明 - オンにすると、携帯電話番号が全社員に対して非表示になります。 - 一般社員はその社員に対して DING の送信や DingTalk ビジネスコールの発信ができなくなります。 - 役員同士では DING の送信や DingTalk ビジネスコールの発信が可能です。 - false:オンにしない。 |
| hired_date | Number | いいえ | 1597573616828 | 入社日。Unix タイムスタンプ、単位はミリ秒。 |
| manager_userid | String | いいえ | 001 | 直属上司の userId。 |
| exclusive_mobile | String | いいえ | +86-13412341234 | 企業アカウントの携帯電話番号。 説明 企業アカウントのみに適用されます。 |
| avatarMediaId | String | いいえ | @lALPDfmVUw19YdrNA-jNA-g | 本組織の企業アカウントを作成する際に指定可能なプロフィール写真の MediaId。jpg/png のみ対応。 メディアファイルをアップロードする API を呼び出して取得できます。 説明 企業アカウントのみに適用されます。 |
| nickname | String | いいえ | 名前 | 本組織の企業アカウントを作成する際に指定可能な名前。 説明 企業アカウントのみに適用されます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/v2/user/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=3e4fcfdc-0d84-4124-9600-9456f89a42ef' \
-d 'exclusive_account_type=dingtalk' \
-d 'login_id=login_id3' \
-d 'extension=%7B%5C%22%E8%B6%A3%E5%91%B3%5C%22%3A%5C%22%E6%97%85%E8%A1%8C%5C%22%2C%5C%22%E5%B9%B4%E9%BD%A2%5C%22%3A%5C%2224%5C%22%7D' \
-d 'exclusive_account=true' \
-d 'manager_userid=001' \
-d 'remark=%E5%82%99%E8%80%83%E5%82%99%E8%80%83' \
-d 'telephone=010-86123456-2345' \
-d 'hired_date=1597573616828' \
-d 'title=%E6%8A%80%E8%A1%93%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%82%BF%E3%83%BC' \
-d 'org_email_type=profession' \
-d 'userid=zhangsan' \
-d 'avatarMediaId=%40lALPDfmVUw19YdrNA-jNA-g' \
-d 'dept_title_list=null' \
-d 'work_place=%E6%9C%AA%E6%9D%A5%E3%83%91%E3%83%BC%E3%82%AF' \
-d 'dept_order_list=null' \
-d 'senior_mode=false' \
-d 'org_email=test%40xxx.com' \
-d 'name=%E5%B1%B1%E7%94%B0%E5%A4%AA%E9%83%8E' \
-d 'nickname=%E5%90%8D%E5%89%8D' \
-d 'exclusive_mobile=%2B86-13412341234' \
-d 'dept_id_list=%5C%222%2C3%2C4%5C%22' \
-d 'job_number=4' \
-d 'init_password=init_password220' \
-d 'email=test%40xxx.com'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/create");
OapiV2UserCreateRequest req = new OapiV2UserCreateRequest();
req.setUserid("123456789");
req.setExclusiveAccount(true);
req.setExclusiveAccountType("dingtalk");
req.setLoginId("xiaodingding");
req.setInitPassword("12345678dingding");
req.setName("DingTalkセルフビルド企業アカウント");
req.setDeptIdList("486882146,609916162");
req.setTelephone("123");
req.setJobNumber("123");
req.setTitle("技術ディレクター");
req.setEmail("test@xxx.com");
req.setOrgEmail("ceshi2");
req.setOrgEmailType("base");
req.setWorkPlace("東京");
req.setRemark("備考情報");
OapiV2UserCreateRequest.DeptOrder deptOrder1 = new OapiV2UserCreateRequest.DeptOrder();
deptOrder1.setDeptId(486882146L);
deptOrder1.setOrder(2L);
OapiV2UserCreateRequest.DeptOrder deptOrder2 = new OapiV2UserCreateRequest.DeptOrder();
deptOrder2.setDeptId(609916162L);
deptOrder2.setOrder(1L);
ArrayList<OapiV2UserCreateRequest.DeptOrder> deptOrderList = new ArrayList<>();
deptOrderList.add(deptOrder1);
deptOrderList.add(deptOrder2);
req.setDeptOrderList(deptOrderList);
OapiV2UserCreateRequest.DeptTitle deptTitle1 = new OapiV2UserCreateRequest.DeptTitle();
deptTitle1.setTitle("テスト");
deptTitle1.setDeptId(486882146L);
OapiV2UserCreateRequest.DeptTitle deptTitle2 = new OapiV2UserCreateRequest.DeptTitle();
deptTitle2.setTitle("ディレクター");
deptTitle2.setDeptId(609916162L);
ArrayList<OapiV2UserCreateRequest.DeptTitle> deptTitleList = new ArrayList<>();
deptTitleList.add(deptTitle1);
deptTitleList.add(deptTitle2);
req.setDeptTitleList(deptTitleList);
req.setExtension("{\"趣味\":\"旅行\",\"年齢\":\"24\"}");
req.setSeniorMode(false);
req.setHiredDate(1650351000000l);
req.setManagerUserid("001");
req.setExclusiveMobile("150xxxx");
req.setAvatarMediaId("@lADPDfYH3A-xxxx");
req.setNickname("山田1");
OapiV2UserCreateResponse rsp = client.execute(req, accessToken);
System.out.println(rsp.getBody());
# -*- coding: utf-8 -*-
import dingtalk.api
req=dingtalk.api.OapiV2UserCreateRequest("https://api.dingtalk.io/topapi/v2/user/create")
req.userid="zhangsan"
req.name="山田太郎"
req.telephone="010-86123456-2345"
req.job_number="4"
req.title="技術ディレクター"
req.email="test@xxx.com"
req.org_email="test@xxx.com"
req.work_place="未来パーク"
req.remark="備考備考"
req.dept_id_list=""2,3,4""
req.dept_order_list=""
req.dept_title_list=""
req.extension="{\"趣味\":\"旅行\",\"年齢\":\"24\"}"
req.senior_mode=false
req.hired_date=1597573616828
req.exclusive_account=false
req.exclusive_account_type="dingtalk"
req.login_id="login_id3"
req.init_password="init_password220"
req.org_email_type="profession"
req.manager_userid="001"
req.exclusive_mobile="+86-13412341234"
req.outer_exclusive_corpid="corpid"
req.outer_exclusive_userid="userid"
req.avatarMediaId="@lALPDfmVUw19YdrNA-jNA-g"
req.nickname="名前"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2UserCreateRequest;
$req->setUserid("zhangsan");
$req->setExclusiveAccount("true");
$req->setExclusiveAccountType("dingtalk");
$req->setLoginId("login_id3");
$req->setInitPassword("init_password220");
$req->setName("山田太郎");
$req->setDeptIdList("\"2,3,4\"");
$req->setTelephone("010-86123456-2345");
$req->setJobNumber("4");
$req->setTitle("技術ディレクター");
$req->setEmail("test@xxx.com");
$req->setOrgEmail("test@xxx.com");
$req->setWorkPlace("未来パーク");
$req->setRemark("備考備考");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/user/create");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/create");
OapiV2UserCreateRequest req = new OapiV2UserCreateRequest();
req.Userid = "zhangsan";
req.Name = "山田太郎";
req.Mobile = "13800138000";
req.Telephone = "010-86123456-2345";
req.JobNumber = "4";
req.Title = "技術ディレクター";
req.Email = "test@xxx.com";
req.OrgEmail = "test@xxx.com";
req.WorkPlace = "未来パーク";
req.Remark = "備考備考";
req.DeptIdList = "\"2,3,4\"";
req.ExclusiveAccount = true;
req.ExclusiveAccountType = "dingtalk";
req.LoginId = "login_id3";
req.InitPassword = "init_password220";
req.OrgEmailType = "profession";
req.ManagerUserid = "001";
req.AvatarMediaId = "@lALPDfmVUw19YdrNA-jNA-g";
OapiV2UserCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | エラーコード。0 は成功を表します。 |
| errmsg | String | ok | エラーメッセージ。 |
| result | Object | 戻り結果。 | |
| userid | String | zhangsan | 社員 ID。 |
| unionId | String | xxxx | 社員の一意な ID。 |
レスポンスボディ例
{
"errcode":"0",
"result":{
"unionId":"xxxx",
"userid":"zhangsan"
},
"errmsg":"ok"
}