バージョン5.62におけるチケットノートタイプの変更点
ご自身のLiveAgentアカウントのバージョンが不明な場合は、こちらのガイドを参照してバージョン番号を確認してください。
バージョン5.62以降、チケットのノート(メモ)に関連するタイプの値が変更されました。5.62より前のバージョンで作成されたノートと比較して、現在ではメッセージグループタイプおよびメッセージタイプの値が異なる形で保存・返却されるようになっています。
| フィールド | バージョン5.62より前 | バージョン5.62以降 |
|---|---|---|
| メッセージグループタイプ | I(internal) | U(internal_offline) |
| メッセージタイプ | N(note) | M(message) |
さらに、チケットのノートのID形式も変更されています。バージョン5.62以降に作成されたノートには、整数IDではなくUUID形式の文字列IDが割り当てられます。
| バージョン5.62より前 | バージョン5.62以降 | |
|---|---|---|
| ノートメッセージグループID | 整数の文字列(例:12345) | UUID文字列(例:“123abcde-45fe-490a-ba7f-999e7855h5uc”) |
影響を受ける範囲
これらの変更は、バージョン5.62以降に作成されたすべてのノートに適用されます。作成方法にかかわらず対象となります。
- エージェントがエージェントパネルから手動で追加したノート
- 自動化ルールによって自動的に追加されたノート
- API v1エンドポイント POST /api/v1/conversations/{id}/messages 経由で追加されたノート
バージョン5.62へのアップグレード前に作成されたノートは、元のタイプの値(メッセージグループタイプ = I、メッセージタイプ = N)と元の整数IDを保持し続けます。その結果、1つのチケット内に、作成時期によって新旧両方のメッセージタイプの値や、整数IDとUUIDの両方のグループIDが混在するノートが、同一のAPIレスポンス内に含まれる場合があります。
インテグレーションおよびWebhookへの影響
インテグレーションやWebhookが特定のタイプの値でフィルタリングしてノートを識別している場合、影響を受けます。
- メッセージグループタイプ = “I"でフィルタリングしているインテグレーションは、バージョン5.62以降に作成されたノートをすべて見逃してしまいます(エラーが表示されないため気づきにくい点に注意)。
- GET /api/v1/conversations/{id}/messages を読み取るAPI v1利用者は、5.62以降に作成されたノートがメッセージタイプグループ = “I"ではなく"U”、メッセージタイプ = “N"ではなく"M"として返されるのを目にすることになり、これによりノートが通常のメッセージとして表示されてしまう可能性があります。
インテグレーションがメッセージIDを整数として解析・保存している場合、またはID形式について何らかの前提を置いている場合、影響を受けます。
- ノートグループIDを整数にキャストするインテグレーションは、バージョン5.62以降に作成されたノートを処理する際に失敗するか、誤った結果を生成します。
- GET /api/v3/tickets/{id}/messages を読み取るAPI利用者は、バージョン5.62のアップグレード前後の両方のノートを含むチケットについて、同一レスポンス内で整数IDとUUID IDが混在した状態を受け取る可能性があります。
必要な対応
インテグレーション、Webhook、またはカスタムレポートが、チケットのノートを識別するためにメッセージグループタイプやメッセージタイプの値に依存している場合は、新旧両方のタイプの値を処理できるようにコードを更新する必要があります。
また、すべてのメッセージグループID(およびサブメッセージID)を文字列として扱ってください。これが、破壊的変更を発生させることなく、現在および将来のすべてのID形式のバリエーションを正しく処理できる唯一の方法です。
ご自身のインテグレーションが影響を受けるかどうかの確認や、コードの更新方法についてご質問がある場合は、support@liveagent.com までご自身のユースケースの詳細を添えてサポートチームまでお問い合わせください。