APIでMessage Managerにユーザーを追加する

できること

貴社の顧客基盤（CDPやCRMツールなど）から「end_users/add」APIを実行することで、Message Managerにユーザーを追加できます。

‍

使用するAPI

「end_users/add」API

‍

API リファレンス

‍

指定した LINE ユーザーを登録します。

‍

POST /v2/end_users

‍

リクエストパラメータ

‍

Body Parameters

‍

EndUser オブジェクト

‍

Identifier オブジェクト

‍

エラーコード

エラー定義 参照。

‍

レスポンス

‍

成功時

‍

成功時に ステータスコード 201 Created と以下のプロパティを含む JSON オブジェクトを返します。

‍

Response Body

‍

EndUser オブジェクト

‍

Identifier オブジェクト

‍

‍

レスポンス例

{
  "end_user": {
    "identifiers": [
      {
        "type": "line_uid",
        "value": "U0123456789abcdef0123456789abcdef"
      },
      {
        "type": "socialplus_uid",
        "value": null
      },
      {
        "type": "primary_key",
        "value": null
      }
    ]
  }
}

‍

指定された LINE ユーザが LINE Messaging API チャネルから見つからない場合

‍

ステータスコード 422 Unprocessable Content とともに、以下の内容を返します。

‍

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

‍

"ユーザが LINE Messaging API チャネルから見つからない場合" とは、以下の状態を指します。

• ユーザが LINE Messaging API チャネルに存在しない
• ユーザが LINE 公式アカウントを友だち追加していない
• ユーザが LINE 公式アカウントをブロックしている
• ユーザがプロフィール情報の取得に同意していない

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/end_users \
  -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"
      }
    }
  }'

‍