メインコンテンツまでスキップ

Flex メッセージの送信

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

POST /v2/messages/flex

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

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

注記

LINE Flex Message については、以下を参照してください。 🔗 Flex Message を送信する（LINE Developers ドキュメント）

リクエストパラメータ​

Body Parameters​

パラメータ名型必須説明
providerstring○プロバイダ名。現在は line のみ対応
recipientobject○Recipient オブジェクトを指定
contentobject○Content オブジェクトを指定
reservation_timenumber予約配信のために配信日時を Unix Time で指定する。未指定の場合は即時配信

Recipient オブジェクト​

パラメータ名型必須説明
typestring○value のタイプを指定する。socialplus_uid または primary_key
valuestring○配信対象とするユーザのソーシャルPLUS ID（socialplus_uid）またはお客様サービス側ユーザID（primary_key）

Content オブジェクト​

パラメータ名型必須説明
typestring○flex を指定
alt_textstring○代替テキスト。空文字は指定不可。Flex Message が表示できない環境で使用されます
contentsobject○Flex Message のコンテナ要素。LINE 公式のドキュメント を参照

エラーコード​

エラー定義 参照。

レスポンス​

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

パラメータ名型Nullable説明
identifierstringメッセージを一意に表す識別子
status_urlstringメッセージの配信状況を確認する 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
  }'
タグ:
に最終更新