> ## 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.

# 概要

> 企業の組織構成とメンバー情報をDingTalk連絡先で一元管理し、メンバー検索、権限制御、業務システム連携を実現します

このドキュメントは、DingTalk 連絡先を全体的に理解いただくことを目的としています。本ドキュメントを通じて、企業管理者、IT 担当者、開発者は連絡先の機能範囲を迅速に把握し、今後のシステム統合やビジネス革新の基礎を築くことができます。

## DingTalk 連絡先とは

DingTalk 連絡先は、社内情報を一元管理するためのコアインフラです。企業の組織構成とメンバー情報をデジタル化して表現し、企業メンバーが素早く人を探し、効率的にコラボレーションするための基盤機能を提供します。

機能の詳細については、[DingTalk 使い方ガイド - 企業連絡先](https://docs.dingtalk.io/i/p/Y7kmbokZp3pgGLq2/docs/Y7kmbpxy30LLzLq2?dontjump=true#)をご参照ください。

| **観点** | **説明**                                             |
| ------ | -------------------------------------------------- |
| 本質     | 企業の組織構成をデジタル化して表現するキャリア                            |
| 形態     | ツリー型部門構造 + メンバー情報データベース                            |
| 役割     | 企業の人・物・事をつなぐハブであり、承認フロー、メッセージルーティング、権限制御などのシーンを支える |

## 連絡先の確認方法

### 組織管理者の視点

組織管理者は、以下の方法で連絡先を管理・閲覧できます。

* DingTalk 管理コンソール：[DingTalk 管理コンソール](https://oa.dingtalk.io/)にログインし、**社内連絡先**モジュールに入ると、連絡先の完全な管理と設定を行えます。
* 連絡先設定：連絡先の可視性ルール、カスタムフィールド、役員モードなどのプレミアム機能を設定できます。

### 一般メンバー

一般組織メンバーは、以下のクライアントから連絡先を閲覧できます。

* **DingTalk PC 版**：DingTalk PC クライアントで「連絡先」タブをクリックすると、企業の組織構成と連絡先詳細を閲覧できます。
* **DingTalk モバイル版**：DingTalk モバイル App で「連絡先」ページに入り、部門別の閲覧やキーワード検索が可能です。
* **DingTalk Web 版**：DingTalk ウェブ版を通じて連絡先機能にアクセスできます。

## オープン機能概要

### オープン API リスト

連絡先は豊富なオープン API 機能を提供しています。開発者は API を通じて、連絡先と企業のビジネスシステムを連携できます。

#### ユーザー連絡先

| API              | 説明                          | API バージョン |
| ---------------- | --------------------------- | --------- |
| ユーザー連絡先のプロフィール取得 | 企業ユーザーの連絡先におけるプロフィールを取得します。 | 新バージョン    |

#### 連絡先権限

| API          | 説明                | API バージョン |
| ------------ | ----------------- | --------- |
| 連絡先の権限スコープ取得 | 連絡先の権限スコープを取得します。 | 旧バージョン    |

#### ユーザー管理

| API                                                                                                           | API 説明                                      | API バージョン |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | --------- |
| [ユーザー作成](/ja/open/development/user-information-creation)                                                      | 新規ユーザーを作成します。                               | 旧バージョン    |
| [ユーザー情報更新](/ja/open/development/user-information-update)                                                      | 指定したユーザー情報を更新します。                           | 旧バージョン    |
| [ユーザー削除](/ja/open/development/delete-a-user)                                                                  | ユーザーの userid に基づいて指定したユーザーを削除します。           | 旧バージョン    |
| [ユーザー詳細の取得](/ja/open/development/query-user-details)                                                          | 指定したユーザーの詳細情報を取得します。                        | 旧バージョン    |
| [部門ユーザーのベーシック情報取得](/ja/open/development/queries-the-simple-information-of-a-department-user)                  | 指定した部門のユーザーのベーシック情報を取得します。                  | 旧バージョン    |
| [部門ユーザーの userid リスト取得](/ja/open/development/query-the-list-of-department-userids)                             | 指定した部門の userid リストを取得します。                   | 旧バージョン    |
| [部門ユーザー詳細の取得](/ja/open/development/queries-the-complete-information-of-a-department-user)                     | 指定した部門のユーザー詳細情報を取得します。                      | 旧バージョン    |
| [社員数の取得](/ja/open/development/user-management-acquires-number-employees)                                      | 社員数を取得します。                                  | 旧バージョン    |
| [DingTalk 未ログイン社員リストの取得](/ja/open/development/queries-the-inactive-users-or-active-users-under-an-enterprise) | 指定した期間内に DingTalk にログインしていない企業社員のリストを取得します。 | 旧バージョン    |
| [電話番号によるユーザー検索](/ja/open/development/query-users-by-phone-number)                                             | 電話番号からユーザーの userId を取得します。                  | 旧バージョン    |
| [unionid によるユーザー userid 取得](/ja/open/development/query-a-user-by-the-union-id)                                | unionid からユーザーの userid を取得します。              | 旧バージョン    |
| [管理者リストの取得](/ja/open/development/query-the-administrator-list)                                                | 管理者リストを取得します。                               | 旧バージョン    |
| [管理者の連絡先権限スコープ取得](/ja/open/development/query-permissions-of-the-administrator-address-book)                   | 管理者の連絡先権限スコープを取得します。                        | 旧バージョン    |
| [管理者のアプリ管理権限取得](/ja/open/development/obtains-the-administrator-s-microapplication-management-permission)      | 管理者のアプリ管理権限を取得します。                          | 旧バージョン    |
| [離職レコードリストの取得](/ja/open/development/query-the-details-of-employees-who-have-left-office)                      | 企業の離職レコードリストを取得します。                         | 新バージョン    |
| [役員モードの設定](/ja/open/development/update-executive-settings)                                                    | 社員の役員モードを設定します。                             | 新バージョン    |
| [ユーザー役員モード設定の取得](/ja/open/development/get-user-executive-mode-settings)                                       | ユーザーの役員モード設定の詳細を取得します。                      | 新バージョン    |
| [ユーザー属性の可視性設定削除](/ja/open/development/delete-enterprise-employee-attribute-field-visibility-settings)         | 企業社員の属性フィールド可視性設定を削除します。                    | 新バージョン    |
| [ユーザー属性の可視性設定取得](/ja/open/development/pull-hidden-property-field-for-enterprise-employees)                    | 企業社員の属性フィールド非表示設定を取得します。                    | 新バージョン    |
| [ユーザー属性の可視性設定](/ja/open/development/add-or-update-the-hidden-settings-of-the-employee-property)               | 企業社員の属性フィールド非表示設定を追加または更新します。               | 新バージョン    |
| [ユーザー userId 検索](/ja/open/development/address-book-search-user-id)                                            | ユーザー名称からユーザーの userId を検索します。                | 新バージョン    |
| [連絡先 userId 並び替え](/ja/open/development/address-book-userid-sorting)                                           | ユーザー名のピンインで userId を並び替えます。                 | 新バージョン    |

#### 部門管理

| API                                                                                                | 説明                             | API バージョン |
| -------------------------------------------------------------------------------------------------- | ------------------------------ | --------- |
| [部門作成](/ja/open/development/address-book-creation-department-established-department)               | 新規部門を作成します。                    | 旧バージョン    |
| [部門更新](/ja/open/development/address-book-update-department)                                        | 部門情報を更新します。                    | 旧バージョン    |
| [部門削除](/ja/open/development/address-book-deletion-department)                                      | 部門 ID に基づいて指定した部門を削除します。       | 旧バージョン    |
| [部門 ID 検索](/ja/open/development/address-book-search-department-id)                                 | 部門 ID を検索します。                  | 新バージョン    |
| [部門詳細の取得](/ja/open/development/query-department-details0-v2)                                       | 部門 ID に基づいて指定した部門の詳細を取得します。    | 旧バージョン    |
| [部門リストの取得](/ja/open/development/user-management-acquires-the-list-departments)                     | 下位レベルの部門のベーシック情報を取得します。        | 旧バージョン    |
| [子部門 ID リストの取得](/ja/open/development/obtain-the-list-of-sub-department-ids)                        | 企業の部門配下にあるすべての直属子部門のリストを取得します。 | 旧バージョン    |
| [指定部門のすべての親部門リスト取得](/ja/open/development/query-the-list-of-all-parent-departments-of-a-department) | 指定した部門のすべての親部門 ID リストを取得します。   | 旧バージョン    |
| [指定ユーザーのすべての親部門リスト取得](/ja/open/development/queries-the-list-of-all-parent-departments-of-a-user)   | 指定したユーザーが所属するすべての親部門を取得します。    | 旧バージョン    |

#### ロール管理

| API            | 説明                            | API バージョン |
| -------------- | ----------------------------- | --------- |
| ロール作成          | 新規ロールを作成します。                  | 旧バージョン    |
| ロールグループ作成      | ロールグループを作成します。                | 旧バージョン    |
| ロール名称更新        | ロール名称を更新します。                  | 旧バージョン    |
| 社員ロールの一括追加     | 社員のロールを一括追加します。               | 旧バージョン    |
| ロール削除          | ロール ID に基づいて指定したロールを削除します。    | 旧バージョン    |
| 社員ロールの一括削除     | 社員のロールを一括削除します。               | 旧バージョン    |
| ロールユーザー管理範囲の設定 | ロールユーザーの管理範囲を設定します。           | 旧バージョン    |
| ロールグループリストの取得  | ロールグループ情報を取得します。              | 旧バージョン    |
| ロールリストの取得      | ロールリストを取得します。                 | 旧バージョン    |
| ロール詳細の取得       | ロール ID に基づいて指定したロールの詳細を取得します。 | 旧バージョン    |
| 指定ロールの社員リスト取得  | 指定したロールの社員リストを取得します。          | 旧バージョン    |

#### 外部連絡先

| API           | 説明                   | API バージョン |
| ------------- | -------------------- | --------- |
| 外部連絡先の追加      | 企業の外部連絡先を追加します。      | 旧バージョン    |
| 外部連絡先の削除      | 企業の外部連絡先を削除します。      | 旧バージョン    |
| 外部連絡先の更新      | 企業の外部連絡先を更新します。      | 旧バージョン    |
| 外部連絡先リストの取得   | 企業の外部連絡先リストを取得します。   | 旧バージョン    |
| 外部連絡先のタグリスト取得 | 企業の外部連絡先のタグを取得します。   | 旧バージョン    |
| 外部連絡先詳細の取得    | 企業の外部連絡先の詳細情報を取得します。 | 旧バージョン    |

#### 企業アカウント

| API                                                                                                         | 説明                                             | API バージョン |
| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | --------- |
| [シングルサインオン企業アカウントの作成](/ja/open/development/create-an-sso-account)                                           | シングルサインオン企業アカウントの新規ユーザーを作成します。                 | 旧バージョン    |
| [企業アカウントの DingTalk ID 変更](/ja/open/development/api-changedingtalkid)                                        | 企業アカウントの DingTalk ID を変更します。                   | 新バージョン    |
| [DingTalk 自作企業アカウントの作成](/ja/open/development/create-dingtalk-user-created-dedicated-account)                | DingTalk 自作企業アカウントの新規ユーザーを作成します。               | 旧バージョン    |
| [企業アカウントユーザー情報の更新](/ja/open/development/update-dedicated-accounts-information)                              | 指定した企業アカウントのユーザー情報を更新します。                      | 旧バージョン    |
| [企業アカウントユーザー詳細の取得](/ja/open/development/queries-the-details-of-a-dedicated-account)                         | 指定した企業アカウントユーザーの詳細情報を取得します。                    | 旧バージョン    |
| [企業アカウントの有効化完了](/ja/open/development/enable-a-dedicated-account)                                            | 指定した企業アカウントを有効化完了します。                          | 新バージョン    |
| [企業アカウントの停用](/ja/open/development/disable-an-exclusive-account)                                             | 指定した企業アカウントを停用します。                             | 新バージョン    |
| [企業アカウントの強制ログアウト](/ja/open/development/force-logout-from-dedicated-account)                                 | 指定した企業アカウントを強制ログアウトします。                        | 新バージョン    |
| [企業アカウントのステータス取得](/ja/open/development/query-dedicated-account-status-1)                                    | ある企業アカウントの有効化ステータスを取得します。                      | 新バージョン    |
| [企業アカウントが所有する組織の取得](/ja/open/development/you-can-call-this-operation-to-query-the-organization-that)        | 企業アカウントがどの企業で作成者の身分を持っているかを取得し、これらの企業情報を取得します。 | 新バージョン    |
| [企業アカウントの複数組織参加権限付与](/ja/open/development/authorize-a-dedicated-account-to-join-multiple-organizations)     | 企業アカウントが複数の組織に参加できるように権限付与します。                 | 新バージョン    |
| [他組織の企業アカウントの招待参加](/ja/open/development/invite-other-organization-specific-accounts-to-join)                | 他組織の企業アカウントを本組織に参加させます。                        | 旧バージョン    |
| [部門企業アカウントユーザー詳細の取得](/ja/open/development/queries-account-details)                                          | 指定した部門のユーザー詳細情報を取得します。                         | 旧バージョン    |
| [電話番号による企業アカウントユーザー検索](/ja/open/development/obtain-the-userid-of-your-mobile-phone-number)                  | 電話番号から企業アカウントユーザーの userId を取得します。              | 旧バージョン    |
| [企業アカウントのスーパー管理者（作成者）への引き継ぎ](/ja/open/development/transfer-exclusive-account-to-main-administrator-creator) | 本組織内のある企業アカウントが所有権を持つ組織を、別の企業アカウントに引き継ぎます。     | 新バージョン    |
| 移行後の dingId による元 dingId 取得                                                                                  | 移行後の dingId から元の dingId を取得します。                | 新バージョン    |
| 移行後の unionId による元 unionId 取得                                                                                | 移行後の unionId から元の unionId を取得します。              | 新バージョン    |
| 元 dingId による移行後 dingId 取得                                                                                   | 元の dingId から移行後の dingId を取得します。                | 新バージョン    |
| 元 unionId による移行後 unionId 取得                                                                                 | 元の unionId から移行後の unionId を取得します。              | 新バージョン    |
| [他組織への本組織企業アカウント情報閲覧権限付与](/ja/open/development/api-orgaccountmobilevisibleinotherorg)                       | 他組織が本組織の企業アカウント情報を閲覧できる具体的なフィールドを設定します。        | 新バージョン    |

#### 企業管理

| API                                                                                                               | 説明                         | API バージョン |
| ----------------------------------------------------------------------------------------------------------------- | -------------------------- | --------- |
| 企業認証情報の取得                                                                                                         | 企業認証情報を取得します。              | 新バージョン    |
| 企業招待情報の取得                                                                                                         | 企業の招待情報を取得します。             | 新バージョン    |
| 企業の最新 DingTalk 指数情報取得                                                                                             | 企業の最新 DingTalk 指数情報を取得します。 | 新バージョン    |
| [管理者にアプリ管理権限があるかの確認](/ja/open/development/check-whether-the-administrator-has-application-management-permissions) | 組織管理者にアプリの管理権限があるかを確認します。  | 新バージョン    |

| API            | 説明                            | API バージョン |
| -------------- | ----------------------------- | --------- |
| 部門詳細の取得        | 部門 ID に基づいて部門詳細を取得します。        | 旧バージョン    |
| 部門配下のメンバーリスト取得 | 部門配下のメンバーリスト情報を取得します。         | 旧バージョン    |
| 部門リストの取得       | 部門 ID に基づいて業界連絡先の部門リストを取得します。 | 旧バージョン    |
| 部門ユーザー詳細の取得    | 部門ユーザー詳細を取得します。               | 旧バージョン    |
| 企業情報の取得        | 業界連絡先の企業情報を取得します。             | 旧バージョン    |

#### 連絡先 ID 変換

| API                                                                                           | 説明                                                                     | API バージョン |
| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | --------- |
| [連絡先 ID の非同期変換](/ja/open/development/asynchronous-address-book-file-content-translation)      | 非同期で連絡先 ID コンテンツを変換し、製品ソリューションプロバイダーの連絡先権限スコープ内のユーザー ID と部門 ID を置換します。 | 新バージョン    |
| [非同期変換タスク結果の取得](/ja/open/development/obtains-the-results-of-an-asynchronous-translation-task) | 送信済みの変換タスク結果を取得します。                                                    | 新バージョン    |

#### 連絡先の可視性管理

| API               | 説明                     | API バージョン |
| ----------------- | ---------------------- | --------- |
| 連絡先非表示設定の取得       | 連絡先の非表示設定リストを一括取得します。  | 新バージョン    |
| 連絡先非表示設定の削除       | 連絡先の非表示設定を削除します。       | 新バージョン    |
| 連絡先非表示設定の追加または更新  | 連絡先の非表示設定を追加または更新します。  | 新バージョン    |
| 部門可視性優先度の設定       | 連絡先の部門可視性優先度を設定します。    | 新バージョン    |
| 連絡先閲覧制限設定の追加または変更 | 連絡先閲覧制限の設定を追加または変更します。 | 新バージョン    |
| 連絡先閲覧制限設定リストの取得   | 連絡先閲覧制限の設定リストを取得します。   | 新バージョン    |
| 連絡先閲覧制限設定の削除      | 連絡先閲覧制限設定を削除します。       | 新バージョン    |

| API                           | 説明                                         | API バージョン |
| ----------------------------- | ------------------------------------------ | --------- |
| 上下流組織の作成                      | 上下流組織を作成します。                               | 新バージョン    |
| 関連組織の解除                       | 関連組織の関係を解除します。                             | 新バージョン    |
| 上下流組織の招待情報取得                  | 上下流組織の招待リンクを取得します。                         | 新バージョン    |
| パートナー組織の参加申請一括承認              | パートナー組織の上下流組織への参加申請を一括承認します。               | 新バージョン    |
| 上下流組織内のパートナー組織の属性情報更新         | 上下流組織内のパートナー組織の属性情報を更新します。                 | 新バージョン    |
| 上下流組織内のパートナー組織の可視範囲設定         | 上下流組織内のパートナー組織の可視範囲を設定します。                 | 新バージョン    |
| 企業が参加済みまたは参加申請中の上下流組織情報取得     | 企業が参加済みまたは参加申請中の上下流組織情報を取得します。             | 新バージョン    |
| 上下流組織への参加済みまたは申請中の組織および個人情報取得 | 上下流組織の組織 ID から、参加済みまたは申請中の組織および個人情報を取得します。 | 新バージョン    |

| API                  | 説明                          | API バージョン |
| -------------------- | --------------------------- | --------- |
| 関連組織の解除              | 関連組織の関係を解除します。              | 新バージョン    |
| メイン組織リストの取得          | メイン組織リストを取得します。             | 新バージョン    |
| ブランチ組織リストの取得         | ブランチ組織リストを取得します。            | 新バージョン    |
| パートナー組織の参加申請一括承認     | ブランチ組織のメイン組織への参加申請を一括承認します。 | 新バージョン    |
| 上下級組織のブランチ権限付与データ取得  | 上下級組織のブランチ権限付与データを取得します。    | 新バージョン    |
| メイン組織内のブランチ組織の可視範囲設定 | メイン組織内のブランチ組織の可視範囲を設定します。   | 新バージョン    |
| メイン組織内のブランチ組織の属性情報更新 | メイン組織内のブランチ組織の属性情報を更新します。   | 新バージョン    |

### コールバックイベントリスト

連絡先は、ユーザー変更、部門変更、ロール変更、企業情報変更などのコールバックイベントをサポートしています。その他のイベントについてはイベントサブスクリプション概要をご参照ください。

## チュートリアル

DingTalk は連絡先 API の統合フローのサンプルを提供しています。

* [企業社員の作成、取得、更新、削除](/ja/open/development/address-book-employee-operations)
* [企業部門の作成、取得、更新、削除](/ja/open/development/operations-related-to-address-book-departments)
* [企業 OA システムと DingTalk 連絡先の同期実現](/ja/open/development/synchronization-between-enterprise-oa-system-and-dingtalk-address-book)
* サードパーティ個人ミニプログラムでのログインユーザー情報取得

## 用語解説

### 社員番号

社員番号に対応するフィールドコードは job\_number です。社内社員の社員番号は一意である必要はないため、社員の社内での一意の識別子としては使用できません。

組織管理者が[DingTalk 管理コンソール](https://oa.dingtalk.io/)にログインし、連絡先ページで**社員名**をクリックすると、社員の社員番号を確認できます。社員番号フィールドは任意フィールドです。

### unionId

現在の DingTalk オープンプラットフォームアカウント範囲内におけるユーザーの一意の識別子です。同一の DingTalk オープンプラットフォームアカウントには複数のオープンアプリを含めることができ、ISV のスイートアプリや企業アプリも含まれます。

unionId は[ユーザー詳細の取得](/ja/open/development/query-user-details) API を呼び出して取得できます。

### ロールグループとロール

社内で定義されたロールグループとロールであり、社員の身分情報を管理しやすくします。社員は同時に複数のロール身分を持つことができます。

組織管理者が[DingTalk 管理コンソール](https://oa.dingtalk.io/)にログインし、**連絡先 > 社内連絡先管理**ページで**ロール**をクリックすると、ロールグループとロールを確認できます。

### 連絡先拡張フィールド

連絡先には拡張フィールドを追加できます。

組織管理者が[DingTalk 管理コンソール](https://oa.dingtalk.io/)にログインし、**社内連絡先設定 > 連絡先情報** > **カスタムフィールド追加**ページで、カスタムフィールドを新規追加します。