2019 年 7 月のアップデートで LINE WORKS の Bot API の構造が変わりました。
変更点と対応ポイントについてまとめましたので、参考にしてください。
主な変更ポイント
主なポイントは 3 点です。特に、1 の REST API 化に伴う対応は、1年以内 (できればなるはや) に実施する必要がありますので注意してください。
1. REST API 化
Bot の登録、変更やメッセージ送信など、API 全体の REST 化が行われました。
これに伴い、URI の構造も変更されてバージョン番号が "v1" にリセットされたことも注意が必要です。
2. Quick Reply の追加
全てのメッセージ形式で、Quick Reply を追加できるようになりました。
QuickReply の追加方法については別の記事に記載しています。
3. カルーセル、リッチメニューなどのコンテンツ追加
LINE WORKS でもようやくカルーセルやリッチメニューなどのリッチな表現が使えるようになりました。新しいコンテンツは、旧APIからは利用できないので注意が必要です。
既存の Bot の移行ポイント
API がバージョンアップしても、すでに登録済みの Bot に対して手動でバージョンアップや再登録の作業は不要です。
Bot No. もそのままで新しい API を利用できます。
最小の工数で新しい API に移行するための作業は以下です。
メッセージ送信
送信先 URL とリクエスト ボディ内の botNo. の指定方法が変わります。
旧 URL
https://apis.worksmobile.com/{API_ID}/message/sendMessage/v2
新 URL
https://apis.worksmobile.com/r/{API_ID}/message/v1/bot/{botNo}/message/push
- botNo はリクエスト ボディではなく URL 内に記述するよう変更されました。
- REST 対応済み API では API ID の前に /r/ が入ります。(わかりやすさ？なのかな。。)
リクエストボディは、botNo パラメータだけ削除すれば OK です。
メッセージ受信
受信形式に変更ありません。
Bot 登録 / 修正 / 削除
これまで Bot の登録や修正にはそれぞれ個別の URL が割り当てられていましたが、REST化にあわせてHTTP メソッドで指定する形に変更されました。
新 URL
https://apis.worksmobile.com/r/{API_ID}/message/v1/bot/{botNo}
| 操作 | 新 API の HTTP メソッド | 旧 API の URL |
|---|---|---|
| 登録 | POST | ~/regiserBot/v4 |
| 修正 | PUT | ~/updateBot/v4 |
| 削除 | DELETE | ~/removeBot |
| 照会 | GET | ~/getBotList/v4 , /getBotInfo/v4 |
照会は、botNo の引数がなければ Bot リスト照会、botNo があれば Bot 詳細情報の照会となります。
その他の注意点
- 固定メニューと新規に追加されたリッチメニューはどちらか片方しか指定できません。
- メッセージ受信サーバー追加やBot 利用メンバーの登録 / 削除など一部の API はまだ REST 化されていません。