API でFlex Messgeを送信する

設定マニュアル MENUを表示する

できること

ID連携をしたユーザーに対して、貴社顧客基盤側（CDPやCRMツールなど）から直接APIを使ってLINEのセグメントメッセージ配信（個別配信）ができます。

例えば、再入荷通知やポイント有効期限のお知らせなど、貴社側で作成した配信シナリオをもとに、「Flex Message」形式メッセージが配信いただけます。

当該APIで配信したメッセージの配信数、開封数、クリック数はMessage Managerに集計されますので、貴社側で集計の仕組みを作成する必要もありません。

‍

API リファレンス

‍

指定したユーザーに LINE Flex Message を送信します。

‍

POST /v2/messages/flex

‍

メッセージ送信は非同期で行われるため、この API ではメッセージ送信リクエストが正常に受け付けられたかどうかを返します。正常に受け付けた場合はメッセージ毎に一意のメッセージ ID を採番して返します。

メッセージ送信が完了しているかどうかは、そのメッセージ ID を用いてメッセージ送信結果の取得 API で確認する必要があります。そのための URL をレスポンスに含めて返します。

‍

注記

LINE Flex Message については、以下を参照してください。 ‍

Flex Message を送信する（LINE Developers ドキュメント）

‍

リクエストパラメータ

‍

Body Parameters

パラメータ名	型	必須	説明
provider	string	○	プロバイダ名。現在は `line` のみ対応
recipient	object	○	Recipient オブジェクトを指定
content	object	○	Content オブジェクトを指定
reservation_time	number		予約配信のために配信日時を Unix Time で指定する。未指定の場合は即時配信
custom_aggregation_unit	string		任意の集計単位のユニット名

‍

「任意の集計単位のユニット名」について

大文字と小文字は区別されます。たとえば promotion_a と promotion_A は別のユニットとして扱われます。
最大文字数は 30 文字、使用可能な文字の種類は半角英数字およびアンダースコア（ _ ）です。

‍

Recipient オブジェクト

パラメータ名	型	必須	説明
type	string	○	value のタイプを指定する。`socialplus_uid`, `primary_key`,`line_uid` のいずれかを指定
value	string	○	配信対象とするユーザのソーシャルPLUS ID（socialplus_uid）, お客様サービス側ユーザID（primary_key）, LINE ユーザID（line_uid）

‍

Content オブジェクト

パラメータ名	型	必須	説明
type	string	○	`flex` を指定
alt_text	string	○	代替テキスト。空文字は指定不可。プッシュ通知とトークリストに表示されます。また Flex Message が表示できない環境で使用されます
contents	object	○	Flex Message のコンテナ要素。LINE公式のドキュメントを参照

‍

エラーコード

エラー定義参照。

‍

レスポンス

成功時はステータスコード 202 Accepted とともに、作成した Message リソースの JSON を返します。

パラメータ名	型	Nullable	説明
identifier	string		メッセージを一意に表す識別子
status_url	string		メッセージの配信状況を確認する URL

‍

レスポンス例

{
  "identifier": "ff67bae17fe8496e75b84da304515b8410854064",
  "status_url": "https://msgapi.socialplus.jp/v2/messages/ff67bae17fe8496e75b84da304515b8410854064"
}

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/messages/flex \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: {API Key}' \
  --data-raw '{
    "provider": "line",
    "recipient": {
      "type": "primary_key",
      "value": "user_123"
    },
    "content": {
      "type": "flex",
      "alt_text": "これは Flex Message です",
      "contents": {
        "type": "bubble",
        "body": {
          "type": "box",
          "layout": "horizontal",
          "contents": [
            {
              "type": "text",
              "text": "Hello,"
            },
            {
              "type": "text",
              "text": "World!"
            }
          ]
        }
      }
    },
    "reservation_time": 1626050213,
    "custom_aggregation_unit": "promotion_a"
  }'

‍