LINE Messaging API まとめ

自分の脳内整理のために、LIFF APIリファレンスを見ながら、まとめたものです。
公式ドキュメントを参照することを強くお勧めします。
↓公式リファレンス
https://developers.line.biz/ja/reference/liff/

リッチメニューの作成方法

POST https://api.line.me/v2/bot/richmenu

リッチメニューを表示する方法は画像をアップロードしたのち、下記2ついずれかの方法をとる

• デフォルトのリッチメニューを設定する
• リッチメニューとユーザーをリンクする

上記エンドポイントに対して下記内容をsendする

• ヘッダー
  • Authorization：Bearer {channel access token}
  • Content-Type：application/json
• ボディ
  • リッチメニューオブジェクト
    • size
    • selected:デフォルトでリッチメニューを表示するか否か
    • name
    • chatBarText
    • areas: Array
      • bounds
        • x
        • y
        • width
        • height
      • action

レスポンスとして、richMenuIdが返ってくる

リッチメニューオブジェクトの検証

POST https://api.line.me/v2/bot/richmenu/validate

リッチメニューの画像をアップロードする

POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content

以下要件をみたす画像をアップ

• 画像フォーマット：JPEGまたはPNG
• 画像の幅サイズ（ピクセル）：800以上、2500以下
• 画像の高さサイズ（ピクセル）：250以上
• 画像のアスペクト比（幅÷高さ）：1.45以上
• 最大ファイルサイズ：1MB

ヘッダーにAutherizationとContent-Typeを付与し、パスパラメータにrichMenuIdを渡してエンドポイントを叩く。

リッチメニューの画像をダウンロードする

GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content

ヘッダーにAutherizationとContent-Typeを付与し、パスパラメータにrichMenuIdを渡してエンドポイントを叩く。

リッチメニューの配列を取得する

GET https://api.line.me/v2/bot/richmenu/list

作成したリッチメニュー全てを配列で取得。

ヘッダーにAutherizationとContent-Typeを付与してたたく。

リッチメニューを取得する

GET https://api.line.me/v2/bot/richmenu/{richMenuId}

デフォルトのリッチメニューを設定する

POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}

リッチメニューエイリアスを作成する

POST https://api.line.me/v2/bot/richmenu/alias

# リッチメニューエイリアスAを作成したい場合の例
curl -v -X POST https://api.line.me/v2/bot/richmenu/alias \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d \
'{
    "richMenuAliasId": "richmenu-alias-a",
    "richMenuId": "richmenu-862e6ad6c267d2ddf3f42bc78554f6a4"
}'

# リッチメニューエイリアスBを作成したい場合の例
curl -v -X POST https://api.line.me/v2/bot/richmenu/alias \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d \
'{
    "richMenuAliasId":"richmenu-alias-b",
    "richMenuId":"richmenu-88c05ef6921ae53f8b58a25f3a65faf7"
}'

任意のリッチメニューに対して、エイリアスIDを付与する。

リッチメニューエイリアスの情報を取得する

GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}