Liny API (0.0.0)

Download OpenAPI specification:

友だち

友だち一覧の取得

友だち一覧を取得します

友だちの詳細情報を一覧で取得タグ情報、友だち情報、対応マークなどを含む

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 1000 ] Default: 50 取得件数
taiou_mark_id	Array of integers <int64> [ items <int64 > ] 対応マークIDでフィルタ（複数指定可、OR条件）
is_blocked	boolean 友だちからのブロック状態でフィルタ
display_status	Array of strings Items Enum: "normal" "block" "hide" 表示ステータスでフィルタ（複数指定可、OR条件）
name	string 友だち名で部分一致検索
full_name	string 本名で部分一致検索
system_name	string システム表示名で部分一致検索
created_at_from	string 作成日時の開始日時 (ISO 8601形式)
created_at_to	string 作成日時の終了日時 (ISO 8601形式)
sort_by	string Default: "created_at" Enum: "created_at" "taiou_mark_updated_at" ソート項目
sort_order	string Default: "desc" Enum: "asc" "desc" ソート順序
include_tags	Array of integers <int64> <= 100 items [ items <int64 > ] 含めるタグID（最大100個）例: [123, 124, 125]
include_friend_infos	Array of integers <int64> <= 100 items [ items <int64 > ] 含める友だち情報ID（最大100個）例: [223, 224, 225]

Responses

Response samples

200
401
422
500

Content type

application/json

{"data": [{"id": 12345,
"uid": "Uabcd1234efgh5678",
"name": "山田太郎",
"full_name": "山田 太郎",
"system_name": "山田太郎（東京支店）",
"taiou_mark": {"id": 1,
"name": "対応済み"
},
"taiou_mark_updated_at": "2025-01-15T14:30:00+09:00",
"is_line_group": false,
"is_blocked": false,
"display_status": "normal",
"created_at": "2025-01-01T10:00:00+09:00",
"memo": "重要顧客",
"tags": [{"id": 123,
"name": "閲覧",
"attached_at": "2025-01-10T15:30:00+09:00"
}
],
"friend_infos": [{"id": 223,
"name": "氏名（漢字）",
"value": "山田太郎",
"type": "string"
}
]
}
],
"path": "/v2/api/friends",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/friends?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/friends?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

[WIP] 友だち詳細の取得

友だち詳細を取得します

指定した友だちの詳細情報を取得

path Parameters

id

required

string (IdOrUid)

友だちID 数値ID（例: 12345）またはUID（例: Uabcd1234 または Cabcd1234）を受け入れる

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": 12345,
"uid": "Uabcd1234efgh5678",
"name": "山田太郎",
"full_name": "山田 太郎",
"system_name": "山田太郎（東京支店）",
"taiou_mark": {"id": 1,
"name": "対応済み"
},
"taiou_mark_updated_at": "2025-01-15T14:30:00+09:00",
"is_line_group": false,
"is_blocked": false,
"display_status": "normal",
"created_at": "2025-01-01T10:00:00+09:00",
"memo": "重要顧客",
"tags": [{"id": 123,
"name": "閲覧",
"attached_at": "2025-01-10T15:30:00+09:00"
}
],
"friend_infos": [{"id": 223,
"name": "氏名（漢字）",
"type": "string",
"value": "山田太郎"
}
]
}
}

友だちのタグ追加

友だちにタグを追加します

タグ追加時アクションは発生しません
タグの人数制限は適用されません
システムメッセージは作成されません

path Parameters

id

required

string (IdOrUid)

友だちID 数値ID（例: 12345）またはUID（例: Uabcd1234 または Cabcd1234）を受け入れる

Request Body schema: application/json
required

tag_ids

required

Array of integers <int64> [ items <int64 > ]

追加するタグIDの配列

Responses

Request samples

Payload

Content type

application/json

{"tag_ids": [1,
2,
3
]
}

Response samples

200
401
404
422
500

Content type

application/json

{"message": "更新が完了しました"
}

友だちのタグ解除

友だちのタグを解除します

システムメッセージは作成されません

path Parameters

id

required

string (IdOrUid)

友だちID 数値ID（例: 12345）またはUID（例: Uabcd1234 または Cabcd1234）を受け入れる

Request Body schema: application/json
required

tag_ids

required

Array of integers <int64> [ items <int64 > ]

削除するタグIDの配列

Responses

Request samples

Payload

Content type

application/json

{"tag_ids": [2
]
}

Response samples

200
401
404
422
500

Content type

application/json

{"message": "更新が完了しました"
}

友だちの対応マーク設定

友だちの対応マークを設定します

システムメッセージは作成されません

path Parameters

id

required

string (IdOrUid)

友だちID 数値ID（例: 12345）またはUID（例: Uabcd1234 または Cabcd1234）を受け入れる

Request Body schema: application/json
required

taiou_mark_id

required

integer <int64>

対応マークID

Responses

Request samples

Payload

Content type

application/json

{"taiou_mark_id": 1
}

Response samples

200
401
404
422
500

Content type

application/json

{"message": "更新が完了しました"
}

友だち情報

友だち情報フォルダの作成

友だち情報フォルダを新規作成します

Request Body schema: application/json
required

name

required

string

フォルダ名

Responses

Request samples

Payload

Content type

application/json

{"name": "新規フォルダ"
}

Response samples

200
401
422
500

Content type

application/json

{"data": {"id": 12345
}
}

友だち情報の作成

友だち情報を新規作成します

Request Body schema: application/json
required

name required	string 項目名
type required	string Enum: "string" "text" "image" "pdf" "select" "date" "datetime" タイプ
	integer or null 友だち情報フォルダID (nullable)
	Array of FriendInfoChoice (objects) or null <= 100 items 選択肢の配列（type=selectの場合のみ有効)

Responses

Request samples

Payload

Content type

application/json

{"name": "新規友だち情報",
"type": "select",
"folder_id": 10,
"choices": [{"value": "新規友だち情報_選択肢A",
"color": "#FF0000"
},
{"value": "新規友だち情報_選択肢B",
"color": "#0000FF"
}
]
}

Response samples

200
401
422
500

Content type

application/json

{"data": {"id": 12345
}
}

タグフォルダ一覧の取得

タグフォルダ一覧を取得します

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": null,
"name": "未分類"
},
{"id": 10,
"name": "顧客分類"
},
{"id": 11,
"name": "興味関心"
}
]
}

タグフォルダの作成

タグフォルダを新規作成します

Request Body schema: application/json
required

name

required

string

フォルダ名

Responses

Request samples

Payload

Content type

application/json

{"name": "新規タグフォルダ"
}

Response samples

200
401
422
500

Content type

application/json

{"data": {"id": 12345
}
}

タグ一覧の取得

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 1000 ] Default: 50 取得件数
	integer or null フォルダID（nullは未分類フォルダのみ、未指定は全て）

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 1,
"name": "重要顧客",
"folder_id": 10
},
{"id": 2,
"name": "見込み客",
"folder_id": 10
},
{"id": 3,
"name": "要フォロー",
"folder_id": null
}
],
"path": "/v2/api/tags",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/tags?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/tags?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

タグの作成

タグを新規作成します

Request Body schema: application/json
required

name required	string タグ名
	integer or null タグフォルダID (nullable)

Responses

Request samples

Payload

Content type

application/json

{"name": "新規タグ",
"folder_id": 10
}

Response samples

200
401
422
500

Content type

application/json

{"data": {"id": 12345
}
}

タグの更新

タグを更新します

path Parameters

id

required

integer <int64>

Request Body schema: application/json
required

name	string タグ名
	integer or null タグフォルダID (nullable) 未指定の場合: 既存の値を保持 null を指定した場合: 未分類に移動数値IDを指定した場合: 指定したフォルダに移動

Responses

Request samples

Payload

Content type

application/json

{"name": "更新タグ",
"folder_id": 10
}

Response samples

Content type

application/json

{"message": "更新が完了しました"
}

[未定] タグの削除

タグの削除します

path Parameters

id

required

integer <int64>

Responses

Response samples

401
404
500

Content type

application/json

{"message": "認証が必要です。APIキーを確認してください"
}

タグに紐づく友だち一覧の取得

指定したタグが付与されている友だちの一覧を取得します

path Parameters

id

required

integer <int64>

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 10000 ] Default: 50 取得件数

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": [{"id": 12345,
"uid": "Uabcd1234efgh5678",
"is_line_group": false,
"is_blocked": false,
"display_status": "normal"
},
{"id": 12346,
"uid": "Uabcd1234efgh5679",
"is_line_group": false,
"is_blocked": false,
"display_status": "hide"
}
],
"path": "/v2/api/tags/1/friends",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/tags/1/friends?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/tags/1/friends?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

タグに友だちを一括追加

指定したタグを複数の友だちに付与します

システムメッセージは作成されません

path Parameters

id

required

integer <int64>

Request Body schema: application/json
required

friend_ids

required

Array of strings (IdOrUid) <= 1000 items

追加する友だちIDの配列（数値IDまたはUID）

Responses

Request samples

Payload

Content type

application/json

{"friend_ids": ["12345",
"12346",
"12347"
]
}

Response samples

200
401
404
422
500

Content type

application/json

{"message": "更新が完了しました"
}

タグから友だちを一括削除

指定したタグを複数の友だちから解除します

システムメッセージは作成されません

path Parameters

id

required

integer <int64>

Request Body schema: application/json
required

friend_ids

required

Array of strings (IdOrUid) <= 1000 items

削除する友だちIDの配列（数値IDまたはUID）

Responses

Request samples

Payload

Content type

application/json

{"friend_ids": ["12345",
"12346"
]
}

Response samples

200
401
404
422
500

Content type

application/json

{"message": "更新が完了しました"
}

対応マーク

対応マーク一覧の取得

対応マーク一覧を取得します

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 100 ] Default: 50 取得件数

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 1,
"name": "対応済み"
},
{"id": 2,
"name": "対応中"
},
{"id": 3,
"name": "未対応"
}
],
"path": "/v2/api/taiou-marks",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/taiou-marks?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/taiou-marks?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

トーク情報

トーク履歴の取得

トーク履歴を取得

注意: prev_cursor と prev_page_url は実装されておらず、常にnullを返します

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 1000 ] Default: 50 取得件数
friend_id	string (IdOrUid) 送信者の友だちIDでフィルタリング
direction	string Enum: "inbound" "outbound" "system" メッセージの方向でフィルタリング
is_unconfirmed	boolean 未読メッセージのみ取得（true: 未読のみ、false: 既読のみ、指定なし: 全て）
staff_id	integer <int64> 送信操作を行ったスタッフIDでフィルタリング
has_staff	boolean スタッフによる送信の有無でフィルタリング（true: 手動送信メッセージ、false: その他(受信メッセージ・システムメッセージ・自動送信メッセージ等)、未指定: 全て）
sent_at_from	string 送信日時の開始範囲 (ISO 8601形式、この日時以降のメッセージを取得)
sent_at_to	string 送信日時の終了範囲 (ISO 8601形式、この日時以前のメッセージを取得)
sort_by	string Default: "sent_at" Value: "sent_at" ソート対象フィールド（デフォルト: sent_at）
sort_order	string Default: "desc" Enum: "asc" "desc" ソート順（デフォルト: desc）

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"direction": "inbound",
"id": 98765,
"friend_id": 12345,
"friend_uid": "Uabcd1234efgh5678",
"timeline_text": "こんにちは！",
"content": {"type": "text",
"text": "こんにちは！"
},
"sent_at": "2025-01-15T10:30:00Z",
"is_unconfirmed": false
},
{"direction": "outbound",
"id": 98766,
"friend_id": 12345,
"friend_uid": "Uabcd1234efgh5678",
"timeline_text": "ありがとうございます",
"content": {"type": "text",
"text": "ありがとうございます"
},
"sent_at": "2025-01-15T10:31:00Z",
"staff": {"id": 456,
"name": "佐藤太郎"
},
"sender_decoration": {"display_name": "カスタマーサポート"
},
"is_unconfirmed": false
}
],
"path": "/v2/api/messages",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/messages?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/messages?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

[WIP] メッセージの送信（未実装）

メッセージを送信します（未実装）

Responses

Response samples

501

Content type

application/json

{"message": "未実装"
}

共通情報

共通情報フォルダ一覧の取得

共通情報フォルダ一覧を取得します

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": null,
"name": "未分類"
},
{"id": 10,
"name": "営業情報"
},
{"id": 11,
"name": "スタッフ情報"
}
]
}

共通情報一覧の取得

共通情報一覧を取得します

query Parameters

cursor	string カーソル
limit	integer <int32> [ 1 .. 1000 ] Default: 50 取得件数
	integer or null フォルダID（nullは未分類フォルダのみ、未指定は全て）

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 123,
"name": "営業時間",
"value": "10:00-18:00",
"shortcode_id": "CVAR_abcd",
"type": "string",
"folder_id": 10
},
{"id": 124,
"name": "定休日",
"value": "土日祝",
"shortcode_id": "CVAR_efgh",
"type": "string",
"folder_id": 10
},
{"id": 125,
"name": "スタッフ数",
"value": "5",
"shortcode_id": "CVAR_ijkl",
"type": "number",
"folder_id": null
}
],
"path": "/v2/api/common-infos",
"per_page": 50,
"next_cursor": "dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=",
"next_page_url": "https://api.lineml.jp/v2/api/common-infos?cursor=dHN1Z2kgbm8gcGFnZSBoZW5vIGN1cnNvciB3byBzaGltZXN1IG1vamlyZXRzdSBkZXN1Lgo=&limit=50",
"prev_cursor": "bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=",
"prev_page_url": "https://api.lineml.jp/v2/api/common-infos?cursor=bWFlbm8gbm8gcGFnZSAuIGhlbm8gY3Vyc29yIC4gc2hpbWVzdSBtb2ppcmV0c3UgLi5kZQo=&limit=50"
}

共通情報の更新

共通情報を更新します

path Parameters

id

required

integer <int64>

Request Body schema: application/json
required

name	string 共通情報名
value	string 値
	integer or null 共通情報フォルダID

Responses

Request samples

Payload

Content type

application/json

{"name": "キャンペーン期間",
"value": "2025年1月1日〜1月31日",
"folder_id": 10
}

Response samples

Content type

application/json

{"message": "更新が完了しました"
}

Liny API (0.0.0)

友だち

友だち一覧の取得

query Parameters

Responses

Response samples

[WIP] 友だち詳細の取得

path Parameters

Responses

Response samples

友だちのタグ追加

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

友だちのタグ解除

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

友だちの対応マーク設定

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

友だち情報

友だち情報フォルダの作成

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

友だち情報の作成

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

タグ

タグフォルダ一覧の取得

Responses

Response samples

タグフォルダの作成

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

タグ一覧の取得

query Parameters

Responses

Response samples

タグの作成

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

タグの更新

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

[未定] タグの削除

path Parameters

Responses

Response samples

タグに紐づく友だち一覧の取得

path Parameters

query Parameters

Responses

Response samples

タグに友だちを一括追加

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

タグから友だちを一括削除

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required