モジュールチャネルからMessaging APIを利用する

モジュールチャネルではMessaging APIチャネルと同様にMessaging APIを使ってメッセージを送信や、リッチメニューの切り替えが可能です。

• モジュールチャネルのチャネルアクセストークンでMessaging APIを利用する
• Webhookを受信する
• モジュールチャネルからLINE公式アカウントの情報を取得する
• 注意事項

モジュールチャネルのチャネルアクセストークンでMessaging APIを利用する

• モジュールチャネルで利用するユーザーID
• モジュールチャネルのチャネルアクセストークン
• Messaging APIのエンドポイントを呼び出す
• Messaging APIを利用する際のレート制限

モジュールチャネルで利用するユーザーID

LINEマーケットプレイスで提供するモジュールチャネルでは、ユーザー個別の識別子であるユーザーIDは、Lからはじまる68桁の文字列で構成されます。

この識別子は、同一ユーザーであっても、LINE公式アカウントごとに異なる値となります。

Lから始まる68桁の識別子の例

LUb577ef3cbe786a8da85ff8e902a03fc6-U5fac33f633e72c192759f09afc41fa28

モジュールチャネルのチャネルアクセストークン

モジュールチャネルがActive Channelに切り替わったら、モジュールチャネルのチャネルアクセストークンを利用して、Messaging APIやModule Channel APIを呼び出すことができます。

モジュールチャネルでは、以下のチャネルアクセストークンを利用できます。

• 短期のチャネルアクセストークン
• 任意の有効期間を指定できるチャネルアクセストークン（チャネルアクセストークンv2.1）
• ステートレスチャネルアクセストークン

チャネルアクセストークンを発行する際に必要な情報は、LINE Developersコンソールのモジュールチャネルの［チャネル基本設定］タブで確認できます。

Messaging APIのエンドポイントを呼び出す

モジュールチャネルのチャネルアクセストークンを利用して、Messaging APIを呼び出すことができます。

ただし、スコープとリクエストヘッダーに注意してください。

スコープ

Messaging APIを利用するには、エンドポイントごとに決められたスコープを持つアクセストークンが必要です。

スコープは、モジュールチャネルをアタッチするときに指定し、LINE公式アカウントの管理者から利用の許可を得る必要があります。詳しくは、「LINE公式アカウントの管理者に認可を要求する」を参照してください。

リクエストヘッダー

モジュールチャネルからMessaging APIのエンドポイントを呼び出すときは、Authorizationヘッダーにはモジュールチャネルのチャネルアクセストークンを指定します。また、モジュールチャネルは複数のLINE公式アカウントにアタッチすることを前提にしたサービスのため、後述の「ボットのユーザーIDを指定するヘッダー」を必ず指定してください。

以下は、モジュールチャネルからMessaging APIでプッシュメッセージを送信する場合の例です。

curl -v -X POST https://api.line.me/v2/bot/message/push \
-H 'Content-Type:application/json' \
-H 'Authorization: Bearer {channel access token}' \
-H 'ボットのユーザーIDを指定するヘッダー: xxxxxxxxxxxxxxxxxxxxxxxx'　\      // NEED THIS HEADER
-d '{
    "to": "LUb577ef3cbe...",
    "messages":[
        {
            "type":"text",
            "text":"Hello, world1"
        }
    ]
}'

Messaging APIを利用する際のレート制限

モジュールチャネルからMessaging APIを利用する際のレート制限は、モジュールチャネル単位かつモジュールチャネルを連携しているLINE公式アカウントのボットごとに、各API機能（エンドポイント）に対して適用されます。

モジュールチャネルが複数のLINE公式アカウントのボットと連携していたとしても、モジュールチャネル x LINE公式アカウントのボット x API機能の組み合わせごとにレート制限が適用されます。

各エンドポイントのレート制限について詳しくは、『Messaging APIリファレンス』の「レート制限」を参照してください。

モジュールチャネルから送信したメッセージの統計情報を取得する

複数のユーザーに送信したプッシュメッセージやマルチキャストメッセージについて、ユーザーがメッセージをどのように操作したかを示す統計情報を、ユニットごとに集計できます。

モジュールチャネルでの統計情報の集計は、LINE公式アカウントのボットとユニット名の組み合わせで集計されます。

たとえば、あるモジュールチャネルにおいて、ユニット名の「ユニットA」を付与したメッセージを、LINE公式アカウントAとLINE公式アカウントBから送信したとします。このとき、それぞれのLINE公式アカウントごとにユニット単位の統計情報が集計されます。

また、当月中（その月の1日～末日）に付与したユニット名の種類数も同様に、LINE公式アカウントのボットとユニット名の組み合わせで集計されます。

詳しくは、『Messaging APIドキュメント』の「送信したメッセージの統計情報を取得する」を参照してください。

Webhookを受信する

モジュールチャネルに登録したWebhook URLサーバーでWebhookイベントを受信した際は、modeプロパティとdestinationプロパティの値を確認してください。

• modeプロパティ
• destinationプロパティ
• モジュールチャネル専用のWebhookイベントを受信する

modeプロパティ

ユーザーが、LINE公式アカウントにメッセージを送信したり、友だち追加したりすると、LINE公式アカウントに紐づくすべてのチャネル（Primary ChannelおよびLINE公式アカウントにアタッチされたモジュールチャネル）に、Webhookイベントが同時に送信されます。

Webhookイベントを処理する前に、モジュールチャネルが主導権（Chat Control）を持っていることを確認し、そのチャネルがエンドユーザーに対して応答すべきかどうかを確認してください。

主導権（Chat Control）を持っているかを確認するには、Webhookイベントのmodeプロパティを利用します。

LINE公式アカウントにアタッチされているチャネルのうち、modeプロパティがactiveに設定されているチャネルは1つだけです。それ以外のチャネルでは、modeプロパティがstandbyに設定されています。

以下は、modeプロパティの値がactive場合とstandbyの場合に送信されるWebhookイベントの例です。

#Active Channelに送信されるWebhookイベントの例
{
    "replyToken": "0f3779fba3b349968c5d07db31eab56f", // NOTICE THIS PROPERTY
    "type": "message",
    "mode": "active", // NOTICE THIS PROPERTY
    "timestamp": 1462629479859,
    "source": {
        "type": "user",
        "userId": "LUb577ef3cbe..."
    },
    "message": {
        "id": "325708",
        "type": "text",
        "text": "Hello, world"
    }
}

#Standby Channelに送信されるWebhookイベントの例
{
    // replyToken PROPERTY DOES NOT EXIST
    "type": "message",
    "mode": "standby", // NOTICE THIS PROPERTY
    "timestamp": 1462629479859,
    "source": {
        "type": "user",
        "userId": "U4af4980629..."
    },
    "message": {
        "id": "325708",
        "type": "text",
        "text": "Hello, world!"
    }
}

destinationプロパティ

モジュールチャネルは、下図のように複数のLINE公式アカウント（OA "X"、OA "Y"、OA "Z"、…）にアタッチされる可能性があります。

そのため、WebhookがどのLINE公式アカウントから送信されたかを判別するために、destinationプロパティを利用します。

以下は、Webhookイベントの例です。

{
  "destination": "U53387d54817...",  // CHECK THIS PROPERTY
  "events": [...]
}

モジュールチャネル専用のWebhookイベントを受信する

以下のWebhookイベントが、モジュールチャネルのWebhook URLサーバーに送信されます。

モジュールチャネルからLINE公式アカウントの情報を取得する

以下のAPIを使うことで、モジュールチャネルをアタッチしたLINE公式アカウントの情報を取得できます。

• ボットの情報を取得する
• モジュールをアタッチしたボットのリストを取得する

ボットの情報を取得する

モジュールチャネルをアタッチしたLINE公式アカウントのボットの基本情報を取得します。詳しくは、『Messaging APIリファレンス』の「ボットの情報を取得する」を参照してください。

なお、リクエストヘッダーには、以下の内容を指定してください。

モジュールをアタッチしたボットのリストを取得する

モジュールチャネルをアタッチした、複数のLINE公式アカウントのボットの基本情報をリストで取得します。詳しくは、『法人ユーザー向けオプションAPIリファレンス』の「モジュールをアタッチしたボットのリストを取得する」を参照してください。

注意事項

• モジュールチャネルをデタッチした際、設定が反映されるまでにタイムラグが発生します。デタッチ後は、リクエストを送信しないようにご注意ください。
• 対象のアカウントにスコープを追加したい場合は、既にアタッチ済のLINE公式アカウントに対しても、追加でアタッチを行うことが可能です。