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

LINE ユーザーの登録

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

POST /v2/end_users

リクエストパラメータ​

Body Parameters​

パラメータ名型必須説明
end_userobject○EndUser オブジェクト を指定

EndUser オブジェクト​

パラメータ名型必須説明
identifierobject◯Identifier オブジェクト を指定

Identifier オブジェクト​

パラメータ名型必須説明
typestring◯エンドユーザーの識別子のタイプ。line_uid を指定
valuestring◯LINE のユーザ識別子

エラーコード​

エラー定義 参照。

レスポンス​

成功時​

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

Response Body​

パラメータ名型Nullable説明
end_userobjectEndUser オブジェクト 参照

EndUser オブジェクト​

パラメータ名型Nullable説明
identifiersarray of objectIdentifier オブジェクト 参照

Identifier オブジェクト​

パラメータ名型Nullable説明
typestringエンドユーザーの識別子のタイプ。socialplus_uid, primary_key, line_uid のいずれか
valuestringエンドユーザーの識別子

レスポンス例​

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

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

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

{
  "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"
      }
    }
  }'