概要

DingTalkドキュメント OpenAPI は、RESTful スタイルの API を提供しており、開発者はプログラム経由で DingTalkドキュメントを操作できます。これらの API を使用することで、ドキュメントコンテンツの自動読み書き、ブロック要素の追加・削除・更新・取得、コンテンツの一括操作などの機能を実現でき、ドキュメントの自動生成、コンテンツ同期、スマートライティングなどのシナリオに適しています。

​

DingTalkドキュメントとは

DingTalkドキュメントは、Alibaba Group の DingTalk が独自開発した企業向けコラボレーションオフィススイートで、ドキュメント、スプレッドシート、マインドマップなどのオンライン作成ツールを含みます。日常的な利用では、ドキュメントをダウンロードすることなく、PC、スマートフォン、タブレットから直接ドキュメントコンテンツを編集・閲覧でき、内容はリアルタイムで自動保存されます。 また、DingTalkドキュメントは DingTalk と深く統合されており、組織関係に基づいて同僚と効率的にコラボレーションできます。DingTalkドキュメントは、情報収集、プロジェクト管理、会議、業務報告、新人オンボーディングなど、日常業務のさまざまなシナリオでも活用できます。その他の機能紹介については、DingTalk 使い方ガイド-DingTalkドキュメントをご参照ください。

​

オープン概要

​

公開 API リスト

DingTalkドキュメントは豊富な API 機能を提供しており、開発者は API を通じてドキュメントのベーシック操作を実現できます。

​

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

• ドキュメントエクスポートタスク完了イベント

​

用語解説

DingTalkドキュメント OpenAPI を使用する前に、以下のコア概念を理解する必要があります。

​

dentryUuid

ドキュメントの一意な識別子です。例としてhttps://docs.dingtalk.io/i/nodes/Z90D4da-idの場合、dentryUuidはZ90D4da-idとなります。

​

blockId

ブロック要素の一意な識別子で、「ブロック要素を取得」API から取得できます。

​

operatorId

操作者のunionIdで、操作を実行するユーザーの本人確認および権限検証に使用されます。

​

BlockElement

ブロック要素は、ドキュメントコンテンツの基本構成単位であり、段落、見出し、ハイライトブロック、テーブルなどがあります。

​

InlineElement

インライン要素は、ブロック要素の内部にネストされる要素で、ステッカー、画像、リンク、スロットなどがあります。