リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/update |
| HTTP Method | POST |
| サポートするアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-qyapi_ext_write-企業外部連絡先の書き込み権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | 本インターフェースを呼び出すアプリ認証情報。社内アプリの access_token を取得するインターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| contact | OpenExtContact | はい | 外部連絡先情報。 | |
| title | String | いいえ | 開発エンジニア | 職位。 |
| label_ids | Number[] | はい | [1,2,3] | タグリスト。外部連絡先リストの取得インターフェースを呼び出してタグ情報を照会できます。 企業によるカスタムタググループの作成方法を参照してカスタムタグを追加してください。 1 回の呼び出しで最大 20 個の labelId を渡すことができます。 |
| share_dept_ids | Number[] | いいえ | [420606536] | 共有先の部門 ID。子部門 ID リストの取得インターフェースを呼び出して取得できます。 1 回の呼び出しで最大 20 個の部門 ID を渡すことができます。 |
| address | String | いいえ | 東京 | 住所。 |
| remark | String | いいえ | 技術責任者 | 表示名。 |
| follower_user_id | String | はい | 023420013645 | 担当者の userId。 |
| name | String | はい | 山田xx | 外部連絡先の名前。 |
| user_id | String | はい | 123420013632 | 当該外部連絡先の userId。外部連絡先リストの取得インターフェースを呼び出して取得できます。 |
| company_name | String | いいえ | DingTalk | 外部連絡先の企業名。 |
| share_user_ids | String[] | いいえ | [“023420013644”] | 共有先の社員 userid リスト。 1 回の呼び出しで最大 20 個の labelId を渡すことができます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/extcontact/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=34ddexxxx6c95' \
-d 'contact=null'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/update");
OapiExtcontactUpdateRequest req = new OapiExtcontactUpdateRequest();
OapiExtcontactUpdateRequest.OpenExtContact contact = new OapiExtcontactUpdateRequest.OpenExtContact();
contact.setTitle("開発エンジニア");
contact.setLabelIds(Arrays.asList(1L,2L,3L));
contact.setShareDeptIds(Arrays.asList(420606536
L));
contact.setAddress("東京");
contact.setRemark("技術責任者");
contact.setFollowerUserId("023420013645");
contact.setName("山田xx");
contact.setUserId("123420013632");
contact.setCompanyName("DingTalk");
contact.setShareUserIds(Arrays.asList("user123"));
req.setContact(contact);
OapiExtcontactUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactUpdateRequest("https://api.dingtalk.io/topapi/extcontact/update")
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 OapiExtcontactUpdateRequest;
$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->user_id="123420013632";
$contact->company_name="DingTalk";
$contact->share_user_ids="[\"023420013644\"]";
$req->setContact($contact);
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/update");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/update");
OapiExtcontactUpdateRequest req = new OapiExtcontactUpdateRequest();
OapiExtcontactUpdateRequest.OpenExtContactDomain obj1 = new OapiExtcontactUpdateRequest.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.UserId = "123420013632";
obj1.CompanyName = "DingTalk";
obj1.ShareUserIds = ""023420013644"";
req.Contact_ = obj1;
OapiExtcontactUpdateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | リターンコード。 |
| request_id | String | 8n3mksu5hqzy | リクエスト ID。 |
レスポンスボディ例
{
"errcode":0,
"request_id": "8n3mksu5hqzy""
}
エラーコード
本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージに基づいて グローバルエラーコード ドキュメントから解決策を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 33009 | 無効な tokenGrantType | access_token が正しいか確認してください |
| 40036 | パラメータが空です | 必須パラメータが入力されているか確認してください |
| 40003 | 無効な userId | userId が正しいか確認してください |
| 60112 | 無効なユーザー名 | ユーザー名が正しいか確認してください |
| 60121 | 対応するユーザーが見つかりません | ユーザー情報が正しいか確認してください |
| 60204 | 外部連絡先の label が必要です | 外部連絡先の label_ids を入力してください |
| 43007 | 権限が必要です | access_token に当該操作の権限があるか確認してください |
| 60103 | 無効な携帯電話番号 | 携帯電話番号が正しいか確認してください |
| 60200 | 外部連絡先が既に存在します | 外部連絡先情報が正しいか確認してください |
| 60203 | 外部連絡先の数を超過しています | 一部の外部連絡先を削除してください |
| -1 | システムビジー | 後でもう一度お試しください |