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

# 専用 OpenAPI について

> DingTalk OA 承認がスマート OA のお客様向けに提供する専用 OpenAPI をご紹介します。社内承認センターの構築、フロー引継ぎ、フローセンター連携などのシーンに対応。利用開始手順や課金ルールなど、よくあるご質問への回答も掲載しています。

## 1. 機能概要

多くの開発者様のパーソナライズドアプリ開発ニーズにお応えするため、DingTalk OA 承認では 2024 年 9 月 1 日より、スマート OA のお客様向けに専用 OpenAPI を順次リリースしています。これらの専用 OpenAPI はより充実した機能を備え、パーソナライズドなビジネスニーズに応えるとともに、さまざまなシーンでの社内アプリ開発をサポートします。開発者様には OpenAPI を合理的かつ効果的にご活用いただき、より健全な DingTalk オープンエコシステムを構築されることをお勧めします。

## 2. 適用シーン

<Note>
  DingTalk は、法令や規制の変更、監督当局の指示への対応、または DingTalk サービスの安全性維持などの理由により、以下の API の範囲や具体的な機能を追加、変更または削除する場合があります。お客様に実際に公開される API は、DingTalk オープンプラットフォームで随時公示される内容が正式なものとなります。
</Note>

| OpenAPI 名                                                            | OpenAPI 詳細                                                                                                                                                                                                 | 適用シーン                     |
| -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| 承認センターのユーザー未処理タスクリストを照会                                              | 本 API を呼び出すと、社内の指定ユーザーの未処理承認タスクリスト（公式 OA 承認タスク、およびサードパーティ業務システムから DingTalk に同期された承認タスクを含む）を照会でき、企業の社内承認センター構築を支援します。                                                                                       | 社内承認センター構築                |
| 承認センターのユーザー処理済みタスクリストを照会                                             | 本 API を呼び出すと、社内の指定ユーザーが処理済みの承認タスクリスト（公式 OA 承認タスク、およびサードパーティ業務システムから DingTalk に同期された承認タスクを含む）を照会でき、企業の社内承認センター構築を支援します。                                                                                     | 社内承認センター構築                |
| 承認センターのユーザー起票済みインスタンスリストを照会                                          | 本 API を呼び出すと、社内の指定ユーザーが起票済みの承認インスタンスリスト（公式 OA 承認インスタンス、およびサードパーティ業務システムから DingTalk に同期された承認インスタンスを含む）を照会でき、企業の社内承認センター構築を支援します。                                                                            | 社内承認センター構築                |
| 承認センターのユーザー受信済みインスタンスリストを照会                                          | 本 API を呼び出すと、社内の指定ユーザーが受信済みの承認インスタンスリスト（公式 OA 承認インスタンス、およびサードパーティ業務システムから DingTalk に同期された承認インスタンスを含む）を照会でき、企業の社内承認センター構築を支援します。                                                                            | 社内承認センター構築                |
| 承認タスクを一括で承認または拒否                                                     | 本 API を呼び出し、指定した userId、タスク結果 (result)、コメント (remark) を用いて、異なる承認インスタンス ID・タスクノード ID を持つ一連の承認タスクを一括処理します。                                                                                                    | 社内承認センター構築                |
| 管理者が指定社員の未処理タスクリストを照会                                                | 本 API は組織管理者向けに未処理タスク照会サービスを提供します。管理者 (managerUserId) が現在の承認者 UserId のすべての未処理 OA 承認タスク情報を照会でき、在職社員と離職社員の未処理タスク照会に対応します。                                                                                    | フロー引継ぎソリューション             |
| 管理者が指定社員の未処理タスクを一括転送                                                 | 未転送承認タスク照会 API を通じて、管理者が組織内の他の在職メンバーへタスクを一括転送できます。転送元は在職メンバーと離職メンバーの双方に対応しますが、転送先は組織内の在職メンバーである必要があります。                                                                                                    | フロー引継ぎソリューション             |
| 業務グループの作成または更新                                                       | 本 API を呼び出すと、サードパーティシステム内の業務グループ情報を DingTalk OA 承認に同期し、対応する DingTalk タスクの OA 承認カテゴリ配下の 2 階層目「業務追加元グループ」を生成できます。以後、未処理タスクを DingTalk に同期する際、タスクが属する業務グループ情報を指定できます。                                          | フローセンター連携（カスタム業務グループ分け）   |
| 業務グループの削除                                                            | 本 API を呼び出すと、サードパーティシステムから DingTalk OA 承認に同期されたグループ情報を削除でき、同時に DingTalk タスクの OA 承認カテゴリ配下の 2 階層目分類も削除されます。対応する分類配下の DingTalk タスクデータは、OA 承認カテゴリ配下の「その他」グループへ移動されます。                                          | フローセンター連携（カスタム業務グループ分け）   |
| フローセンター外部連携承認テンプレートを保存（承認ホスティング、カスタム業務グループ分けなどの featureConfig をサポート） | 本 API を呼び出すと、サードパーティ業務システム内の独自承認テンプレートデータを DingTalk OA 承認に同期でき、同時にテンプレート単位で承認ホスティング、カスタム業務グループ分け、カスタムクイック承認など複数のプレミアム機能モジュールのカスタム連携設定に対応します。                                                               | フローセンター連携（承認ページホスティングモード） |
| フローセンター外部連携承認インスタンスを保存（承認ホスティング、カスタム業務グループ分けなどの featureConfig をサポート） | 本 API を呼び出すと、サードパーティ業務システム内の独自承認インスタンスデータを DingTalk OA 承認に同期でき、同時にインスタンス単位で承認ホスティング、カスタム業務グループ分け、カスタムクイック承認など複数のプレミアム機能モジュールのカスタム連携設定に対応します。                                                               | フローセンター連携（承認ページホスティングモード） |
| フローセンター外部連携承認タスクを保存（カスタムクイック承認などの featureConfig をサポート）               | 本 API を呼び出すことで、サードパーティシステムは承認タスクのコールバック API を設定できます。これにより承認者は DingTalk の承認タスクセンターで直接承認操作を行うことができ、承認タスクセンターがサードパーティシステムにコールバックし、サードパーティシステムはコールバックを受信するとタスク情報を更新し、新しいタスク情報を承認センターへ同期して返すことで、クローズドループを形成します。 | フローセンター連携（カスタム業務グループ分け）   |

### 2.1 社内承認センターの構築

複数の業務システム（企業の自社開発システム、または購入したサードパーティシステム）の承認タスクを DingTalk 承認センターに接続し、DingTalk OA 承認のオープン機能を活用して社内承認センターを構築し、追加元別の絞り込みや一括承認などの機能を実現したい場合に適しています。

<Frame>
  ![社内承認センター構築の実践事例。承認タスクリストは追加元別絞り込みと一括承認に対応](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/93e3ab21-51da-45f4-8365-a5484cb5e1de.png)
</Frame>

### 2.2 フロー引継ぎソリューション

DingTalk OA 承認のオープン機能を活用し、企業の業務システム内で DingTalk 公式 OA 承認フローの引継ぎ機能を実装し、管理者が組織内の他のメンバーへ承認タスクを一括転送できるようにしたい場合に適しています。

管理者が指定社員の未処理タスクリストを照会：

<Frame>
  ![フロー引継ぎ実践事例。管理コンソールで指定社員の未処理承認タスクリストを照会](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/427d2661-07ff-4d03-af7a-4f131bdb2688.png)
</Frame>

管理者が未処理タスクを組織内の他のメンバーへ一括転送：

<Frame>
  ![フロー引継ぎ実践事例。未処理タスクを選択後に表示される承認フォーム転送ウィンドウで一括転送](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/8701c24d-65c9-4751-92d1-6d1ed569b544.png)
</Frame>

### 2.3 フローセンター連携（カスタム業務グループ分け）

複数のサードパーティシステムの承認タスクを DingTalk 承認センターに集約し、ワンストップの没入型承認を実現したい場合に適しています。同時に DingTalk タスクセンターでカスタム業務分類やリストページのワンクリック承認をサポートし、ユーザー、特に承認事項の多い管理層に優れた体験を提供できます。

タスクセンターでカスタム業務分類に対応し、サードパーティ業務システムを追加元とするタスクをより明確に確認可能：

<Frame>
  ![カスタム業務グループ分け実践事例のビフォーアフター比較。タスクセンターの OA 承認カテゴリ配下に 2 階層目の業務追加元グループを新規追加](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/fe05bb81-8098-450a-a848-b5e288a9f48b.png)
</Frame>

タスクセンターのリストページから、サードパーティ業務システムを追加元とする未処理タスクをクイック承認可能：

<Frame>
  ![カスタムクイック承認実践事例のビフォーアフター比較。タスクセンターのリストページから直接サードパーティシステムのタスクを承認または拒否可能](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/55990238-1572-4fde-9b8b-f87ca6f71385.png)
</Frame>

### 2.4 フローセンター連携（承認ページホスティングモード）

業務システムが独自のフローエンジンを持ち、独自の OA 承認モードで連携したいが H5 詳細ページがなく、DingTalk 公式 OA 承認詳細ページを再利用したい場合、およびカスタム承認操作エリアを実装したい場合に適しています。異なる業務システムの承認フォーム構造・スタイルを統一し、ユーザーにマルチデバイス（モバイル / PC / タブレット）で一貫した体験を提供します。承認操作エリアのボタンはカスタマイズ可能です（承認、拒否、転送、印刷など）。

サードパーティの独自 OA 承認で公式詳細ページのスタイルを利用可能：

<Frame>
  ![承認ページホスティングの実践事例。サードパーティの独自承認フォームが DingTalk 公式詳細ページのスタイルで表示](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/ddd9870e-afc3-435c-bd4e-9da60d0e9b4f.png)
</Frame>

モバイル端末の詳細ページでも同様にカスタム承認操作エリアに対応：

<div style={{maxWidth: '400px', margin: '16px auto'}}>
  <Frame>
    ![承認ページホスティング実践事例のスマートフォン詳細ページ。底部操作エリアにカスタマイズされた拒否・承認ボタンを表示](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/92fe8096-a822-44ed-a829-9f6bc754fa75.png)
  </Frame>
</div>

サードパーティ業務による承認操作エリアボタン（承認、拒否など）のカスタム設定・レンダリングに対応し、サードパーティ業務の実行エラーメッセージの詳細も表示可能：

<Frame>
  ![承認ページホスティング実践事例のビフォーアフター比較。PC 端詳細ページの操作エリアボタンはカスタマイズ可能でエラー情報も表示](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/bf6fdc33-79d4-45a8-944e-02f0616cc5ff.png)
</Frame>

## 3. 操作手順

上記の専用 OpenAPI について、標準版のお客様は **スマート OA へのアップグレード** 後に申請してご利用いただけます。一部のお客様は 2024 年 9 月 1 日のリリース前にパブリックベータへ参加され、これらの OpenAPI の呼び出し権限を取得されています。以下のルールに従ってご利用ください。

| 顧客タイプ        | パブリックベータ参加有無 | 影響有無                                                                     |
| ------------ | ------------ | ------------------------------------------------------------------------ |
| スマート OA のお客様 | 参加済み         | 影響なし。引き続き通常どおり呼び出し可能                                                     |
| スマート OA のお客様 | 未参加          | API 利用権限を申請後、呼び出し可能                                                      |
| 標準版のお客様      | 参加済み         | 呼び出し不可。スマート OA へのアップグレード後、API 呼び出し権限を申請することで再度呼び出し可能。権限申請手順は下記説明をご参照ください |
| 標準版のお客様      | 未参加          | 呼び出し不可。スマート OA へのアップグレード後、API 呼び出し権限を申請することで呼び出し可能。権限申請手順は下記説明をご参照ください   |

権限申請パス：**開発者管理コンソール** > アプリ開発 > DingTalk アプリ > 新規アプリまたは既存アプリ > アプリをクリック >【権限管理】>【OA 承認】から、必要な権限を選択して申請します。

<Frame>
  ![開発者管理コンソールのアプリ権限管理ページ。OA 承認カテゴリ配下で必要な API 権限を選択して申請](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYybPY69PKqwZ/img/021b73d4-c1fc-4f6f-90a4-9ebe0810cdfb.png)
</Frame>

## 4. よくあるご質問

<AccordionGroup>
  <Accordion id="q1" title="専用 OpenAPI の課金ルールは？">
    標準版の DingTalk のお客様はスマート OA の専用 OpenAPI をご利用いただけません。これらの API を呼び出すには、まず **スマート OA へのアップグレード** が必要です。専用 OpenAPI 利用時はスマート OA の OpenAPI 利用枠を消費します。
  </Accordion>

  <Accordion id="q2" title="標準版のお客様はこれらの専用 OpenAPI を確認できますか？">
    2024 年 9 月 1 日より、開発者は DingTalk オープンプラットフォームの開発者ドキュメントおよび **開発者管理コンソール** から、今回リリースされる専用 OpenAPI を確認できます。
  </Accordion>
</AccordionGroup>

## 5. 関連ドキュメント

<CardGroup cols={2}>
  <Card title="フローセンターオープンソリューション" icon="sitemap" href="/ja/approval/open-solution-overview">
    企業の業務システムを DingTalk OA 承認に接続する 4 種類のソリューション概要
  </Card>

  <Card title="サードパーティフローページ連携" icon="plug" href="/ja/approval/open-third-party-process">
    業務システムから起票し、DingTalk 内で業務システムの詳細ページを開いて承認
  </Card>
</CardGroup>
