URL スキームを使用する

    URL スキーム(URL Scheme)を使用して、LINE WORKSアプリを実行したり、特定の操作を実行させることができます。 URL スキームは iOS または android 版 LINE WORKS でサポートされます。

    1. URL スキームの基本

    URL スキームの構成は以下の通りです。

    lineworks://{host}/{path..}?version={scheme_version}?{parameter1=values1}&{parameter2=values2}...

    Host、Path及びParameter

    利用できる URL スキームの項目は以下の通りです。

    Item Description
    host 対象サービス

    ● default: LINE WORKSアプリ
    ● message: トーク
    ● calendar: カレンダー
    ● contact: アドレス帳
    ● drive: Drive
    ● home: ホーム
    ● mail: メール
    ● more: その他
    path 各サービスごとの機能
    version={schem_version} URL スキームのバージョン(対応するアプリケーションのバージョン)

    ● 8: v2.1.3以降
    ● 10: v2.2.1以降
    ● 11: v2.3.1以降
    {parametar1=values1} 各機能ごとのパラメータ

    2. URL スキームの対応する操作

    2.1. LINE WORKS アプリを実行する

    run_lw_app

    URL Scheme

    Scheme Description
    lineworks://default?version={scheme_verion} LINE WORKSアプリを実行します。

    2.2. LINE WORKS の特定のサービスを開く

    run_lw_app_with_opening_specific_page

    Scheme Description
    lineworks://calendar?version={scheme_verion} カレンダー
    lineworks://contact?version={scheme_verion} アドレス帳
    lineworks://drive?version={scheme_verion} Drive
    lineworks://home?version={scheme_verion} ホーム
    lineworks://mail?version={scheme_verion} メール
    lineworks://message?version={scheme_verion} トーク
    lineworks://more?version={scheme_verion} その他メニュー

    2.3. メッセージを送る

    指定したメッセージを指定された対象を含むトークルームに送信します。
    対象が1名の場合は1:1 トーク、複数人の場合は1:N トークルームが生成されます。同じ出席者がいる既存のトークルームがある場合は、そのトークルームにメッセージを送信します。

    send_message

    Scheme Description
    lineworks://message/send?version={scheme_verion}&message={message}&emailList={email_Address_List}&callbackMainYn={Y/N} パラメーターで指定したemailAddressリストを含むトークルームにメッセージを送信します。

    2.3.1 Parameter

    パラメータ 必須 説明 備考
    version Y URL Scheme version
    message N 送信メッセージ
    emailList N メッセージを受信するメンバー。ID またはグループ emailAddressで指定する (;で区分)
    callbackMainYn N トークルームを閉じる際、LINE WORKSアプリのメイン画面に戻るかどうか
    ● Y: メイン画面に戻る(既定値)
    ● N: メイン画面に戻らない
    Android only

    2.3.2 Example

    Scheme Description
    lineworks://message/send?version={scheme_verion}&message={message}&emailList={emailAddressList} {emailAddressList}で構成されたトークルームに{message}を送信します。

    2.4. 予定作成

    write_schedule

    Scheme Description
    lineworks://calendar/event/write?version={scheme_verion}&content={contents}``&scheduletype={schedule_type}&startdate={start_date}&invitees={invitees}``&memo={memo} {start_date}に{invitees}が出席する{contents}というタイトルの{schedule_type}予定を作成します。{memo}を含めて作成します。

    2.4.1 Parameter

    パラメータ 必須 説明 備考
    version Y URL Scheme Version
    content N タイトル
    scheduletype N 予定タイプ

    ● 1: 記念日
    ● 2: 終日スケジュール
    ● 3: 一般スケジュール
    ● 4: タスク
    startdate N 日付および時間

    ● yyyy-MM-dd: 日付形式の予定
    ● yyyy-MM-ddTHH:mm:ss: 日付・時間形式の予定
    ● yyyy-MM-ddTHH:mm:ssZ: 日付・時間形式の予定
    日付形式の予定の場合、現在時刻から1時間後に設定されます。
    日付・時間形式の予定で、Zが含まれていない場合、ローカルタイムゾーンを使用します。
    invitees N 出席者emailリスト(,で区分)

    ● mailto:attendeetype:name:{name_value}"{attendeetype_value}:{mailto_value}
    inviteeでmailtoは必須項目
    attendeetype: 必須の出席者かどうか
    (0: 必須(default)、1: 任意)
    memo N メモ

    2.4.2 Example

    Scheme Description
    lineworks://calendar/write?version={scheme_verion}``&scheduletype={schedule_type}&content={contents}&startdate={start_date}&invitees={invitees} {start_date}に{invitees}が出席する{contents}というタイトルの{schedule_type}予定を作成します。