リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/delete |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_ext_write-企業外部連絡先の書き込み権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | 必須 | 6d1bxxxx | 本インターフェースを呼び出すためのアプリ認証情報。社内アプリの access_token を取得するインターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| user_id | String | 必須 | 0125xxxx0251487 | 削除対象の外部連絡先の userId。外部連絡先リストの取得インターフェースを呼び出して userid パラメータの値を取得できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/extcontact/delete" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=22c945xxxx509f1' \
-d 'user_id=0125xxxx0251487'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/delete");
OapiExtcontactDeleteRequest req = new OapiExtcontactDeleteRequest();
req.setUserId("0125xxxx0251487");
OapiExtcontactDeleteResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactDeleteRequest("https://api.dingtalk.io/topapi/extcontact/delete")
req.user_id="0125xxxx0251487"
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 OapiExtcontactDeleteRequest;
$req->setUserId("0125xxxx0251487");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/delete");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/delete");
OapiExtcontactDeleteRequest req = new OapiExtcontactDeleteRequest();
req.UserId = "0125xxxx0251487";
OapiExtcontactDeleteResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | リターンコード。 |
| request_id | String | 439eqp31da45 | リクエスト ID。 |
レスポンスボディ例
{
"errcode":0,
"request_id": "439eqp31da45"
}
エラーコード
本インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 33009 | 無効な tokenGrantType | access_token が正しいかご確認ください |
| 33012 | 無効な userId | userId が正しいかご確認ください |
| 43007 | 操作権限が必要 | access_token に操作権限があるかご確認ください |
| 400001 | システムエラー | 後で再試行してください |