メール API の概要

    LINE WORKS メール API(以下、「メール API」、または「API」)は、HTTP リクエストで利用する REST 形式の API です。 呼び出し結果は通常 JSON 形式で返します。(但し、メール作成、メール閲覧、外部アドレス帳などのポップアップウィンドウは除きます。)

    メール API は、メールサービスのうち使用頻度の高い機能を API として提供しています。

    API共通情報

    環境

    メール API はテスト環境を提供せず、サービス環境のみを提供します。

    • サービス:https://apis.worksmobile.com

    オペーレーションをリクエストするときは、HTTP メソッドとリクエスト URL を結合します。例えば、メール送信であれば、以下のようになります。

    例)メール送信

    POST https://apis.worksmobile.com/r/{API ID}/mail/v2/sendMail
    

    リクエスト URL は、各 API の説明を参照してください。

    Request 共通

    API を呼び出すときは必ずヘッダーに LINE WORKS トークンとコンシューマーキーを含めてください。サービス API の場合、LINE WORKS トークンはメンバーがログインするたびに再発行されます。

    コンシューマーキーの発行については、API 共通ガイドを参考にしてください。

    ヘッダーに LINE WORKS トークンとコンシューマーキーを設定する方法は、以下の通りです。

    httpMethod.setRequestHeader("Authorization", "Bearer アクセストークン");
    httpMethod.setRequestHeader("consumerKey", "コンシューマーキー");