リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/create |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-qyapi_ext_write-企業外部連絡先の書き込み権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | 本インターフェースを呼び出すアプリ認証情報。社内アプリの access_token 取得インターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| contact | OpenExtContact | はい | 外部連絡先情報。 | |
| title | String | いいえ | 開発エンジニア | 職位。 |
| label_ids | Number[] | はい | [1561077317,1561077310] | タグリスト。外部連絡先タグリストの取得インターフェースを呼び出してタグ情報を照会できます。 企業によるカスタムタググループの作成方法を参考にカスタムタグを追加してください。1 回の呼び出しにつき最大 20 個の labelId を指定できます。 |
| share_dept_ids | Number[] | いいえ | [1,2,3] | 共有先の部門 ID。子部門 ID リストの取得インターフェースを呼び出して取得できます。1 回の呼び出しにつき最大 20 個の部門 ID を指定できます。 |
| address | String | いいえ | 北京市 | 住所。 |
| remark | String | いいえ | 王マネージャー | 表示名。 |
| follower_user_id | String | はい | manager4220 | 担当者の userId。携帯番号によるユーザー検索インターフェースから userId を取得できます。1 回の呼び出しにつき最大 20 個の userId を指定できます。 |
| name | String | はい | 張 xx | 外部連絡先の名前。 |
| state_code | String | はい | 86 | 携帯番号の国コード。 |
| company_name | String | いいえ | DingTalk | 外部連絡先の企業名。 |
| share_user_ids | String[] | いいえ | [“023420013644”] | 共有先の社員 userid リスト。携帯番号によるユーザー検索インターフェースから userId を取得できます。1 回の呼び出しにつき最大 20 個の userId を指定できます。 |
| mobile | String | はい | 130xxxx8888 | 外部連絡先の携帯番号。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/extcontact/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d5f0efxxxx9fa9e1' \
-d 'contact=null'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/create");
OapiExtcontactCreateRequest req = new OapiExtcontactCreateRequest();
OapiExtcontactCreateRequest.OpenExtContact contact = new OapiExtcontactCreateRequest.OpenExtContact();
contact.setTitle("開発エンジニア");
contact.setLabelIds(Arrays.asList(1561077317L,1561077310L));
contact.setShareDeptIds(Arrays.asList(1L,2L,3L));
contact.setFollowerUserId("manager4220");
contact.setName("張xx");
contact.setStateCode("86");
contact.setCompanyName("DingTalk");
contact.setShareUserIds(Arrays.asList("023420013644"));
contact.setMobile("130xxxx8888");
req.setContact(contact);
OapiExtcontactCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactCreateRequest("https://api.dingtalk.io/topapi/extcontact/create")
req.contact=""
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 OapiExtcontactCreateRequest;
$contact = new OpenExtContact;
$contact->title="開発エンジニア";
$contact->label_ids="[1,2,3]";
$contact->share_dept_ids="[1,2,3]";
$contact->address="住所内容";
$contact->remark="備考内容";
$contact->follower_user_id="023420013645";
$contact->name="山田太郎";
$contact->state_code="86";
$contact->company_name="DingTalk";
$contact->share_user_ids="[\"023420013644\"]";
$contact->mobile="13088888888";
$req->setContact($contact);
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/create");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/create");
OapiExtcontactCreateRequest req = new OapiExtcontactCreateRequest();
OapiExtcontactCreateRequest.OpenExtContactDomain obj1 = new OapiExtcontactCreateRequest.OpenExtContactDomain();
obj1.Title = "開発エンジニア";
obj1.LabelIds = new long[] { 1,2,3 };
obj1.ShareDeptIds = new long[] { 1,2,3 };
obj1.Address = "住所内容";
obj1.Remark = "備考内容";
obj1.FollowerUserId = "023420013645";
obj1.Name = "山田太郎";
obj1.StateCode = "86";
obj1.CompanyName = "DingTalk";
obj1.ShareUserIds = ""023420013644"";
obj1.Mobile = "13088888888";
req.Contact_ = obj1;
OapiExtcontactCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| userid | String | 123420013632 | 外部連絡先の userId。 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| request_id | String | 6idz5ss49kkj | リクエスト ID。 |
レスポンスボディ例
{
"errcode":0,
"userid":"011250026469774889",
"request_id":"6idz5ss49kkj"
}
エラーコード
本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 33009 | 無効な tokenGrantType | access_token が有効かどうかをご確認ください |
| 40036 | パラメータが空です | 上記の必須パラメータがすべて入力されているかをご確認ください |
| 60103 | 無効な電話番号 | 電話番号が正しいかをご確認ください |
| 60204 | 外部連絡先タグが必要です | label_ids を入力してください |
| 60205 | 外部連絡先機能が有効になっていません | ユーザーから権限付与書面を提供いただいた後、外部連絡先機能を有効化する必要があります |
| 43007 | 権限付与が必要です | access_token に操作権限があるかをご確認ください |
| 60112 | 無効なユーザー名 | ユーザー名が正しいかをご確認ください |
| 22005 | 当該外部連絡先はすでに存在します | 外部連絡先の携帯番号が正しいかをご確認ください |
| -1 | システムビジー | 後で再試行してください |