App Link (Universal Link) を使用する

App Link (Universal Link) を使用して、LINE WORKS アプリを起動したり、特定の操作を実行させることができます。
App Link (Universal Link) はモバイル版 LINE WORKS でサポートされます。メッセージ と メール 機能についてはブラウザ版でも利用可能です。

1. App Link (Universal Link) の基本 {#about-applink}

App Link (Universal Link) の構成は以下の通りです。

https://line.worksmobile.com/{host}/{path..}?version={link_version}&{parameter1=values1}&{parameter2=values2}...

Host、Path 及び Parameter {#applink-parameter}

利用できる App Link (Universal Link) の項目は以下の通りです。

ItemDescription
host対象サービス

• default : LINE WORKS アプリ
• message : トーク
• calendar : カレンダー
• contact : アドレス帳
• board : 掲示板
• home : ホーム
• mail : メール
• more : その他/ホーム
path各サービスごとの機能
version={link_version}App Link (Universal Link) のバージョン(対応するアプリケーションのバージョン)

• 18 : v3.0 以降
• 26 : v3.5 以降
• 28 : v3.7 以降
{parametar1=values1}各機能ごとのパラメータ

2. App Link (Universal Link) の対応する操作 {#applink-operation}

2.1. モバイル版 LINE WORKS アプリを起動する {#open-mobileapp}

run_lw_app

App Link (Universal Link)Description
https://line.worksmobile.com/default?version={link_verion}LINE WORKS アプリを起動します。

2.2. LINE WORKS の特定のサービスを開く {#open-service}

run_lw_app_with_opening_specific_page

App Link (Universal Link)Description
https://line.worksmobile.com/calendar?version={link_version}カレンダー (モバイル版)
https://line.worksmobile.com/contact?version={link_version}アドレス帳 (モバイル版)
https://line.worksmobile.com/board?version={link_version}掲示板 (モバイル版)
https://line.worksmobile.com/home?version={link_version}掲示板 (モバイル版) : version <= 27
ホーム (モバイル版) : version >= 28
https://line.worksmobile.com/mail?version={link_version}メール (モバイル版)
https://line.worksmobile.com/message?version={link_version}トーク (モバイル版、ブラウザ版)
https://line.worksmobile.com/more?version={link_version}その他 (モバイル版) : アプリバージョン <= V3.6
ホーム(モバイル版) : アプリバージョン >= V3.7

2.3. メッセージを送る {#send-message}

指定したメッセージを入力した状態で、指定した対象を含むトークルームを開きます。 対象が 1名の場合は 1:1 トークルームが生成されます。既存の 1:1 トークルームがある場合は、そのトークルームにメッセージを送信します。対象が複数人の場合は AppLink を実行する度に新しい 1:N トークルームが生成されます。 App Link へアクセスした環境により、モバイル版またはブラウザ版 LINE WORKS が開きます。

send_message

App Link (Universal Link)Description
https://line.worksmobile.com/message/send?version={link_version}&message={message}&emailList={email_Address_List}&callbackMainYn={Y/N}パラメータで指定した emailAddress リストを含むトークルームにメッセージを送信します。

Parameter {#send-message-parameter}

パラメータ説明備考
versionApp Link (Universal Link) version
required
message送信メッセージ
emailListメッセージ送信先のメンバーリスト (ID またはグループ emailAddress。 ";" 区切り)
worksAtResourceIdList と同時に指定できます。
worksAtResourceIdListメッセージ送信先の外部ユーザーリスト (リソース ID。 ";" 区切り)
emailList と同時に指定できます。
channelId※ version 26 以上で利用可能
メッセージ送信先のトークルームのチャネルID。
channelId を指定した場合、emailList と worksAtResourceIdListは 無視されます。
callbackMainYnトークルームを閉じる際、LINE WORKS アプリのメイン画面に戻るかどうか
• Y : メイン画面に戻る(既定値)
• N : メイン画面に戻らない
Android only

emailList、worksAtResourceIdList、channelId を指定しない場合には、送信先の連絡先またはトークルームの選択画面が表示されます。

参考
トークルーム画面のメニューにある「チャンネルID」からも、channelId を確認できます。

Example {#send-message-example}

App Link (Universal Link)Description
https://line.worksmobile.com/message/send?version={link_version}&message={message}&emailList={emailAddressList}{emailAddressList} で構成されたトークルームに {message} を送信します。

2.4. 予定作成 {#create-event}

write_schedule

App Link (Universal Link)Description
https://line.worksmobile.com/calendar/event/write?version={link_version}&content={contents}&scheduletype={schedule_type}&startdate={start_date}&invitees={invitees}&memo={memo}{start_date} に {invitees} が出席する {contents} というタイトルの {schedule_type} 予定を作成します。{memo} を含めて作成します。

Parameter {#create-event-parameter}

パラメータ説明備考
versionApp Link (Universal Link)Version
required
contentタイトル
scheduletype予定タイプ

• 2: 終日スケジュール
• 3: 一般スケジュール
startdate日付および時間

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

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

Example {#create-event-example}

App Link (Universal Link)Description
https://line.worksmobile.com/calendar/event/write?version={link_version}&scheduletype={schedule_type}&content={contents}&startdate={start_date}&invitees={invitees}{start_date} に {invitees} が出席する {contents} というタイトルの {schedule_type} 予定を作成します。

2.5.メール作成 {#send-mail}

指定した件名と本文、To、CC を入力した状態で、メール作成画面を開きます。

send_mail

App Link(Universal Link)Description
https://line.worksmobile.com/mail/write?version={link_version}&to={to_mail_addresses}&cc={cc_mail_addresses}&subject={subject}&body={body}件名 {subject} と本文 {body} 、To {to_mail_addresses} と cc {cc_mail_addresses} を指定してメール作成画面を開きます。

Parameter {#send-mail-parameter}

パラメータ備考
versionApp Link(Universal Link) Version
required
toTo メールアドレス
";" 区切り
ccCC メールアドレス
";" 区切り
subjectメールの件名
URL エンコード
bodyメール本文
URL エンコード

Example {#send-mail-example}

App Link(Universal Link)Description
https://line.worksmobile.com/mail/write?version=31&to=user1@worksmobile.com;user2@worksmobile.com&cc=user3@worksmobile.com&subject=testsubject&body=testbody件名 testsubject と 本文 testbody、 To user1@worksmobile.com;user2@worksmobile.com、cc: user3@worksmobile.comを指定してメール作成画面を開きます。

ログイン画面への移動 {#2step-login}

モバイル版 LINE WORKS を起動し、指定したログイン ID を利用して、ログイン画面に移動します。 ユーザーが既にモバイル版 LINE WORKS にログイン済みの場合には、指定したログイン ID への切り替えは行われません。

App Link(Universal Link)Description
https://line.worksmobile.com/more/login/step2?version={link_version}&account={account}&service={service}account を指定してログイン画面に移動する。

Parameter {#2step-login-parameter}

パラメータ説明備考
versionApp Link(Universal Link) Version28 以上で利用可能
Required
accountログイン IDURL エンコードして指定
Required
serviceログイン後に移動するサービス• home: ホーム(既定)
• message: トーク
• calendar: カレンダー
• contact: アドレス帳
• task: タスク
• board: 掲示板
• mail: メール

Example {#2step-login-example}

App Link(Universal Link)Description
https://line.worksmobile.com/more/login/step2?version=28&account=test%40example.com&service=homeログイン ID に test@example.com を指定して、ログイン画面に移動する。ログイン後にホームに移動する。