API でワークフローを起動する

できること

ID連携済みのユーザーに対して、貴社の顧客基盤（CDPやCRMツールなど）からAPIを利用し、Message Managerの「トリガー＆アクション」に設定したワークフローのトリガーへユーザーを追加できます。

ユーザーがトリガーに追加されると、設定したシナリオに応じてワークフローが開始され、対象ユーザーへLINEメッセージの個別配信を行うことが可能です。

‍

‍

API リファレンス

‍

指定したワークフローを起動します。

‍

POST /v2/workflows/:identifier/run

‍

ワークフローの実行は非同期で行われます。

‍

‍

リクエストパラメータ

‍

Path Parameters

‍

Body Parameters

‍

EndUser オブジェクト

‍

Identifier オブジェクト

‍

‍

‍

エラーコード

エラー定義 参照。

‍

レスポンス

‍

成功時

成功時に ステータスコード 200 OK と空の JSON オブジェクトを返します。

{}

‍

指定された識別子に対応する ワークフロー が存在しない場合

ステータスコード 404 Not Found とともに、以下の内容を返します。
指定された ワークフロー が「APIリクエストトリガーでない場合」「稼働停止の場合」「削除済みの場合」も同じエラーを返します。

‍

{
  "errors": [
    {
      "path": "__global__",
      "code": "resource_not_found"
    }
  ]
}

‍

エンドユーザーが存在しない場合

ステータスコード 404 Not Found とともに、以下の内容を返します。

‍

{
  "errors": [
    {
      "path": "__global__",
      "code": "end_user_not_found"
    }
  ]
}

‍

API Rate Limit

この API には 100 リクエスト/分 のリクエスト回数制限があります。
この制限に達した場合は ステータスコード 429 Too Many Requests とともに、以下の内容を返します。

‍

{
  "errors": [
    {
      "path": "__global__",
      "code": "too_many_requests"
    }
  ]
}

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/workflows/{identifier}/run \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Accept: application/json' \
  -H "X-API-Key: {API Key}" \
  --data-raw '{
    "end_user": {
      "identifier": {
        "type": "line_uid",
        "value": "U01234567890123456789012345678901"
      }
    }
  }'

‍