はじめに

LINE WORKS様より
「LINE WORKS API 2.0」が2022年4月01日に公開されました！！（遅

それに伴い
「LINE WORKS API 1.0」は2023年4月30日に提供終了されることに...

「LINE WORKS API 1.0」で稼動中のBOTやシステムが多々あるので
「LINE WORKS API 2.0」へのアップグレード対応を行う必要がある！

ということで、アップグレード対応を行う際に役に立った記事や
引っ掛かった点をまとめさせていただきます。

※基本的にPythonで実装行っている為、他言語のコードや参考記事は記載しておりません。

最初に必ず確認しておくべき記事

LINE WORKS公式 API 2.0とAPI 1.0の違い

変更点がざっくりまとめられています。

LINE WORKS公式 API 2.0 Botへのアップグレードガイド

「LINE WORKS API 2.0」へのアップグレード手順や、変更点がまとめられています。

1.0からアップグレードを行う場合、プロパティ名の変更に気付きにくい部分がある為
『付録 : プロパティ名変更一覧』は特に確認しておいた方が良いです。

必要に応じて確認すると幸せになれる記事

API 2.0 トークン取得方法 Service Account認証（Python）

API 2.0 PostmanでAPI試行

API 2.0 オウム返しBOT

Shintaro Yamasaki(@mmclsntr(ワークスモバイルジャパン株式会社) )様の記事が
とてもわかりやすく、参考になりました。
この場を借りて感謝を！！

アップグレード対応を行う際、引っ掛かった点

BOTからのメッセージ受信に含まれるパラメータの変更

API 1.0の場合
「accountId」へ「ユーザのメールアドレス」
「roomId」へ「ルームを特定するID」
が格納されていたが

API 2.0の場合
「userId」へ「ユーザのID」
「channelId」へ「ルームを特定するID」
が格納されるよう変更されている
※ついでに 「domainId」 も格納されている

API 1.0 メッセージ(Callback) 受信

{
  "type": "message",
  "source": {
    "accountId": "admin@example.com",
    "roomId": "12345"
  },
  "createdTime": 1470902041851,
  "content": {
    "type": "text",
    "text": "hello"
  }
}

API 2.0 メッセージ(Callback) 受信

{
  "type": "message",
  "source": {
    "userId": "c72af563-0f21-4736-11e4-045237113344",
    "channelId": "12345",
    "domainId": 40029600
  },
  "issuedTime": "2022-01-04T05:16:05.716Z",
  "content": {
    "type": "location",
    "address": "〒150-0002 東京都渋谷区渋谷２丁目１５−１",
    "latitude": 35.6587750,
    "longitude": 139.7052230
  }
}

API 1.0で実装したBOTの場合
ユーザの特定を 「ユーザのメールアドレス」 で行っているケースが多いので

API 2.0へアップグレードする際、DBなどへの影響を考慮しつつ、必要に応じて
ユーザーの取得 API を利用し、「ユーザのID」 から 「ユーザのメールアドレス」 を取得する必要がある

なお、API 2.0 でも API 1.0 と同じく
「ユーザのメールアドレス」 でメッセージの送信を行うことができる為

設計上問題ないのであれば、「ユーザのID」 から 「ユーザのメールアドレス」 を取得する必要は無い

おわりに

API1.0からAPI2.0での変更点が数多くあり、以降期間も1年と短いので
アップグレード対応を行う方々は大変かと思いますが、頑張りましょう！

APIとしては、全体的に整理され、とても使いやすい物になったと感じました！

引き続き対応を行い、引っ掛かった点など更新していく予定です。(2022/06/28)

LINE WORKS API 1.0 から 2.0 へのアップグレード