Skip to main content
LINE友だち一覧取得
curl --request GET \
  --url https://api.utage-system.com/v1/accounts/{account_id}/line/friends \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "picture_url": "<string>",
      "is_blocked": true,
      "is_exclusion": true,
      "unread_count": 123,
      "message_tracking_name": "<string>",
      "last_acted_at": "<string>",
      "created_at": "<string>"
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total": 123
  }
}
GET
https://api.utage-system.com/v1/accounts/{account_id}/line/friends
この機能はプレビュー版です。仕様が変更される場合があります。

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

account_id
string
required

アカウントID

Query Parameters

common_friend_id
string

アカウント共通LINE友だちID(line_user_idのMD5ハッシュ)で完全一致検索。Webhookで取得した値を使う想定

display_name
string

LINE登録名で部分一致検索

is_blocked
boolean

ブロック状態で絞り込み

is_exclusion
boolean

配信除外フラグで絞り込み(未指定時は両方返却)

has_unread
boolean

未読メッセージの有無で絞り込み

label_ids
string[]

ラベルIDの配列で絞り込み。複数指定時は全ラベルが付与された友だちのみ(AND条件)

sort
enum<string>

ソート順(降順固定)。created_at: 登録順(デフォルト)、last_acted_at: 最終アクション順

Available options:
created_at,
last_acted_at
page
integer

ページ番号

Required range: x >= 1
per_page
integer
default:20

1ページあたりの件数(既定20・最大100。超過時は100に丸められます)

Required range: 1 <= x <= 100

Response

LINE友だち一覧

data
object[]
meta
object