> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 外部連絡先リストの取得

> 企業の外部連絡先リストをページング検索で取得できます

本インターフェースを呼び出して、企業の外部連絡先リストを取得します。

## リクエスト

| **基本情報**     |                                                                                                  |
| ------------ | ------------------------------------------------------------------------------------------------ |
| HTTP URL     | [https://api.dingtalk.io/topapi/extcontact/list](https://api.dingtalk.io/topapi/extcontact/list) |
| HTTP Method  | POST                                                                                             |
| サポートするアプリタイプ | appType-社内アプリappType-サードパーティ社内アプリ                                                                |
| 権限要件         | permission-qyapi\_ext\_read-企業の外部連絡先の読み取り権限                                                      |

### クエリパラメータ

| 名前            | タイプ    | 必須 | 例        | 説明                                                                                                                                                                                         |
| ------------- | ------ | -- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| access\_token | String | はい | 6d1bxxxx | 当該 API を呼び出すためのアプリ認証情報。   - 社内アプリの場合、[社内アプリの access\_token を取得する](/ja/open/development/obtain-orgapp-token)インターフェースで取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access\_token を取得するインターフェースで取得します。 |

### リクエストボディ

| 名前     | タイプ    | 必須  | 例  | 説明                                                                        |
| ------ | ------ | --- | -- | ------------------------------------------------------------------------- |
| size   | Number | いいえ | 20 | ページング検索をサポートし、offset パラメータと同時に設定した場合のみ有効になります。本パラメータはページサイズを表し、最大 100 です。 |
| offset | Number | いいえ | 0  | ページング検索をサポートし、size パラメータと同時に設定した場合のみ有効になります。本パラメータはオフセット量を表し、0 から開始します。   |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/extcontact/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b5039xxxx8bcc' \
-d 'offset=0' \
-d 'size=20'
```

Java

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.setSize(20L);
req.setOffset(0L);
OapiExtcontactListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import dingtalk.api

req=dingtalk.api.OapiExtcontactListRequest("https://api.dingtalk.io/topapi/extcontact/list")

req.offset=0
req.size=20
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiExtcontactListRequest;
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/list");
```

C#

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.Offset = 0L;
req.Size = 20L;
OapiExtcontactListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## レスポンス

### レスポンスボディ

| 名前                 | タイプ               | 例                         | 説明                                            |
| ------------------ | ----------------- | ------------------------- | --------------------------------------------- |
| results            | 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。                                |
| email              | String            | [1@1.com](mailto:1@1.com) | メール。                                          |
| errcode            | Number            | 0                         | レスポンスコード。                                     |
| errmsg             | String            | ok                        | レスポンスコードの説明。                                  |
| request\_id        | String            | 439eqp31da45              | リクエスト ID。                                     |

### レスポンスボディ例

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "errcode": 0,
  "results": [
    {
      "address": "東京",
      "company_name": "DingTalk",
      "email": "zhang@example.com",
      "follower_user_id": "manager4220",
      "label_ids": [
        1517
      ],
      "mobile": "1360054xxxx",
      "name": "山田太郎",
      "remark": "技術責任者",
      "share_dept_ids": [
        42536
      ],
      "share_user_ids": [
        "0423752"
      ],
      "state_code": "86",
      "title": "CFO",
      "userid": "01129774889"
    }
  ],
  "request_id": "439eqp31da45"
}
```

### エラーコード

当該インターフェースの呼び出し時にエラーが発生した場合、エラーメッセージをもとに[グローバルエラーコード](/ja/open/development/server-api-error-codes-1)ドキュメントで解決方法を検索してください。

| エラーコード（errcode） | エラーコードの説明（errmsg）  | 解決方法                       |
| --------------- | ------------------ | -------------------------- |
| 33009           | 無効な tokenGrantType | access\_token が正しいかご確認ください |
| 40069           | 無効な size           | ページサイズを調整してください            |
| 40068           | 無効なオフセット量          | オフセット量を調整してください            |
| 400001          | システムエラー            | 後でもう一度お試しください              |