ホームAPIの概要

    LINE WORKS のホーム API(以下、「ホーム API」または「API」)は、HTTP メソッドを用いる REST API です。 呼び出し結果は JSON 形式で返します。

    ホーム API は、ホームで利用頻度の高い機能を API として提供しています。

    API 共通情報

    投稿者情報の適用

    投稿作成、コメント作成などの API で投稿者を指定する際の規則は下記の通りです。

    パラメータ タイプ 必須  説明
    accountId String N 投稿者の LINE WORKS アカウント情報
    memberName String N 投稿者の名前
    department String N 投稿者の部署情報
    1. accountId で LINE WORKS アカウント情報を指定した場合、そのメンバー名で投稿されます。
    2. accountId で LINE WORKS アカウント情報を指定しない場合、memberName、department を指定して投稿します。
    3. memberName、department も指定しない場合、部署なしの「SYSTEM」として投稿されます。

    API 呼び出し結果

    1. 呼び出し成功時は HTTP status 200 とともに body に data が渡されます。
    2. 呼び出し失敗時は HTTP status code でエラーを渡します。

    例)

    HTTP status code error message 説明
    400 Bad Request Invalid Parameter パラメーター不足
    413 Payload too large Over Quota File Size ファイルサイズの制限を超過している。
    507 Insufficient Storage Over Upload Quota 共有ストレージ容量の超過