LINE 友だち状態取得

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

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

GET /api/line/friendship_status

リクエスト

Path パラメーター

パラメータ名	型	必須	説明
key	string	○	API キー
identifier	string	※	対象のソーシャルPLUS ID
primary_key	string	※	対象のお客様サービス側ユーザID

※ identifier または primary_key のいずれかを指定（必須）。詳しくはユーザーの特定を参照

リクエストサンプル

curl -X GET https://api.socialplus.jp/api/line/friendship_status \
  -d key={Web API キー} \
  -d primary_key={お客様サービス側のユーザID}

エラーレスポンス

エラーコード

HTTP ステータスコード	Code	Message	説明
401（Unauthorized）	1	Invalid API key or key not found.	API キーが指定されていないか、存在しないAPIキーです
500（Internal Server Error）	3	Operation failed.	予期せぬエラー
400（Bad Request）	5	Required parameter not found.	必須のパラメーターが指定されていません
400（Bad Request）	6	Invalid parameter.	パラメーターに間違いがあります
404（Not Found）	7	Entity not found.	指定されたユーザが存在しません

成功レスポンス

リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。

成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json

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

ソーシャルPLUS から LINE へのアクセス時にエラーが発生した場合のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json

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

レスポンスパラメーター

パラメータ名	型	必須	最大長	説明
status	string	○	15	リクエストが成功したかどうか（`ok` または `failed`）
friendship_status	boolean		-	友だち状態である場合に `true`
friendship_status_updated_at	timestamp		-	友だち状態の最終取得日時
provider_error	object		-	プロバイダから応答されたエラー。`error`, `error_description` を含む JSON オブジェクト

リクエスト​

Path パラメーター​

リクエストサンプル​

エラーレスポンス​

エラーコード​

成功レスポンス​

レスポンスパラメーター​