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

LINE 友だち状態取得

お客様の LINE 公式アカウント（LINE Messaging API チャネル）と指定したユーザとの友だち関係を取得します。

LINE ログインチャネルと LINE 公式アカウントが紐付けられている必要があります。
指定するユーザーが LINE 連携済みである必要があります（未連携のユーザーの友だち状態は取得できません）。

GET /api/line/friendship_status

リクエストパラメータ​

パラメータ名型必須説明
keystring○API キー
identifierstring△対象のソーシャルPLUS ID
primary_keystring△対象のお客様サービス側ユーザID

エラーコード​

HTTP StatusCodeMessage説明
4011Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
4005Required parameter not found.必須のパラメーターが指定されていません
4006Invalid parameter.パラメーターに間違いがあります
4047Entity not found.指定されたユーザが存在しません

レスポンス​

キー型最大長説明
statusstring15リクエストが成功したかどうか（ok または failed）
friendship_statusboolean-友だち状態である場合に true
friendship_status_updated_attimestamp-友だち状態の最終取得日時

レスポンス例: 友だち状態の取得成功時​

{
  "status": "ok",
  "friendship_status": true,
  "friendship_status_updated_at": "2018-08-09T01:55:24Z"
}

レスポンス例: ソーシャルPLUS から LINE 社へのアクセス時にエラー発生​

{
  "status": "ok",
  "provider_error": {
    "error": "401",
    "error_description": "invalid token"
  }
}

実行サンプル​

curl -X GET https://api.socialplus.jp/api/line/friendship_status -G \
  -d key={API Key} \
  -d primary_key={Primary Key}
に最終更新