リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/get |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_ext_read-企業外部連絡先の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API を呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token を取得するインターフェースで取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token を取得するインターフェースで取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| user_id | String | はい | 112500xxxx4889 | 外部連絡先の userId。外部連絡先リストを取得インターフェースを呼び出して userid パラメータ値を取得できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/extcontact/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=53584xxxx2c50b' \
-d 'user_id=112500xxxx4889'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.setUserId("112500xxxx4889");
OapiExtcontactGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactGetRequest("https://api.dingtalk.io/topapi/extcontact/get")
req.user_id="112500xxxx4889"
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 OapiExtcontactGetRequest;
$req->setUserId("112500xxxx4889");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/get");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.UserId = "112500xxxx4889";
OapiExtcontactGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | OpenExtContact | クエリ結果。 | |
| title | String | 開発エンジニア | 職位。 |
| share_dept_ids | Number[] | [1,2,3] | 共有部門 ID リスト。 |
| label_ids | Number[] | [1,2,3] | タグ。 |
| remark | String | 表示名の内容 | 表示名。 |
| address | String | 住所の内容 | 住所。 |
| name | String | 山田太郎 | 名前。 |
| follower_user_id | String | 6767531692 | 担当者の userId。 |
| state_code | String | 86 | 国コード。 |
| company_name | String | DingTalk | 企業名。 |
| share_user_ids | String[] | [“042059613752”] | 共有社員 userId リスト。 |
| mobile | String | 13088888888 | 携帯電話番号。 説明 サードパーティ社内アプリではこのパラメータは返されません。 |
| userid | String | 0123456789 | 外部連絡先の userId。 |
| String | xxx@1.com | メール。 | |
| errcode | Number | 0 | レスポンスコード。 |
| errmsg | String | ok | レスポンスコードの説明。 |
| request_id | String | xrudojam4g8f | リクエスト ID。 |
レスポンスボディ例
{
"errcode":0,
"result":{
"share_user_ids":[
"66220007745510"
],
"follower_user_id":"manager4220",
"address":"東京",
"share_dept_ids":[],
"label_ids":[
1561077317
],
"share_dept_ids": [
42xxxx36
],
"mobile":"136***47616",
"remark":"技術責任者",
"title":"CFO",
"userid":"011250026469774889",
"company_name":"DingTalk",
"name":"山田マネージャー",
"state_code":"86",
"email":"zhang@example.com"
},
"request_id":"xrudojam4g8f"
}
エラーコード
このインターフェースの呼び出しでエラーが発生した場合は、エラーメッセージに基づき グローバルエラーコード ドキュメントで解決方法を確認してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 33009 | 無効な tokenGrantType | access_token が正しいか確認してください |
| 33012 | 無効な userId | userId が正しいか確認してください |
| 43007 | 操作権限が必要です | access_token に操作権限があるか確認してください |
| 400001 | システムエラー | 後でもう一度お試しください |