LINE WORKS API

LINE WORKS API は、LINE WORKS との連携アプリを開発するための Web API です。

開発者は LINE WORKS API を利用して、Bot の利用、組織やグループの管理、ファイルのアップロード/ダウンロードなど、LINE WORKS が提供する様々な機能やリソースを利用するアプリを開発できます。

LINE WORKS API 実行の流れ {#how-api-works}

api_overview

  1. API の呼び出しには Access Token が必要です。Developer Console で アプリ を設定し、認可サーバーへ認可リクエストを送ることで Access Token を取得します。詳しくは こちら を参照してください。
  2. 取得した Access Token を使用し、API サーバーへ API リクエストを送ります。API の共通仕様は こちら を参照してください。

API リファレンス {#api-reference}

API リファレンスには、開発者向けに各 API の詳細な仕様についてまとめられています。API を利用する前に必ず参照してください。

API カテゴリ一覧 {#category}

LINE WORKS API は、取り扱うリソースにより、複数のカテゴリに分類されています。各説明と概要ページへのリンクは以下の通りです。

カテゴリ説明
BotBotからのメッセージ送信やメニューの設定、Botの管理をします。
Directoryユーザー (メンバー) や組織、グループなど、利用者や組織に関するリソースを取得・更新します。
Contact連絡先や連絡先タグの管理をします。
Board掲示板や投稿、コメントの管理をします。
Note組織/グループノートの管理をします。
Calender予定の取得・作成・編集・削除やカレンダーの管理をします。
Formアンケートの管理をします。
Taskタスクやタスクカテゴリーの管理をします。
Driveマイドライブ、共有ドライブ、組織/グループフォルダを管理します。
Mailメールの送信・閲覧・削除や、メールフォルダ・フィルタなどの設定管理をします。
AiNoteAiNote サービスやノートを管理します。
PaperOnPaperOn サービスのプロジェクトとファイルを管理します。
Audit監査データの取得を行います。
Monitoringモニタリングデータの取得を行います。
Security外部ブラウザの利用設定を行います。
Partner顧客管理を行うパートナー限定
パートナーと契約する顧客企業のテナント情報を管理します。

用語 {#glossary}

API リファレンスでは、schema でのバリデーションを表示するために以下の用語を使用します。

  • type : データタイプ
    • string : 文字列
    • number : 数値
    • integer : 整数値
    • boolean : 真偽値
    • array : 配列
    • object : オブジェクト
  • 文字列
    • maxLength : 最大桁数
    • minLength : 最小桁数
  • 数値または整数値
    • maximum : 最大値（境界値を含む）
    • maximum : 最小値（境界値を含む）
  • 配列
    • maxItems : 最大要素数
    • minItems : 最小要素数
  • その他
    • default : 既定値
    • required : 必須
    • enum : 列挙型
    • example : 例
    • pattern : パターン
    • format : フォーマット
    • writeOnly : 書き込み専用
    • readOnly : 読み取り専用
    • nullable : Null 許容
    • unique : 一意