インスタントメッセージのセッションのステータスに関するWebhookの設定

インスタントメッセージのセッションのステータスに関するWebhookの設定

インスタントメッセージのセッションのステータスに関するWebhookでは、チャットやインスタントメッセージのセッションのステータスが変更された際に通知を受け取ることができます。セッションのステータスに関して、最新の状態を常に把握することが可能です。
  

インスタントメッセージのセッションのステータスに関するWebhookを通じてできること   

インスタントメッセージのセッションのステータスに関するWebhookを設定することで、顧客とのやりとりを効率よく管理できます。具体的には、チャットのセッションが以下のいずれかに該当した際に、通知を自動で送信することが可能です。
  1. 担当者またはボットによる対応の開始
  2. セッションの保留または終了
  3. セッションの割り当て、ブロック、ステータスの変更（例：未対応から有効）
 
このWebhookの主なメリットは、以下のとおりです。
  1. チーム内部用のワークフローをすぐに実行できます（例：問い合わせの再割り当て、ダッシュボードの更新）
  2. サポートチームのパフォーマンスをリアルタイムで分析できます
  3. 各経路における顧客とのやりとりの状況を把握できます

インスタントメッセージのセッションのステータスに関するWebhookを設定するには   

  1. ［設定］→［開発者向け情報］→［Webhook］の順に移動します。
  2. ［新しいWebhook］をクリックします。
  3. イベントの選択欄から、タブの項目で［インスタントメッセージ］を選択し、［イベント］の項目で［セッションのステータス］を選択します。
  4. ［通知先のURL］の欄で、WebhookのURLを入力します。こちらに入力したURLに通知が送信されます。
  5. ［保存する］をクリックして、テストを実行します。

Webhookの通知で確認できる内容   

 
インスタントメッセージのセッションのステータスが変更されると、指定したURLに対してペイロード情報が送信されます。ペイロード情報の例は、以下のとおりです。
JSON
 [{
  "payload": {
    "currentAssigneeId": "106554156",
    "sessionStatus": "ON_HOLD",
    "replyStatus": "ACCEPTED",
    "sessionOldStatus": "ENDED",
    "sessionId": "65403000000038063",
    "messagesCount": "23",
    "assigneeType": "AGENT",
    "channelId": "65403000000038011"
  },
  "eventTime": "1751022087019",
  "eventType": "IM_Session_Status",
  "orgId": "106553778"
}] 
Webhookの設定方法に関する詳細については、こちらをご参照ください

ペイロードの項目の説明
ペイロードの項目の説明
項目
説明
currentAssigneeId
セッションに対応している担当者またはボットのIDです。
sessionStatus
会話の現在のステータスです（例：ON_PROGRESS、ENDED）。
replyStatus
セッションにおけるメッセージの送受信の可否を表します（詳細については、以下の表をご参照ください）。
sessionOldStatus
セッションの以前のステータスです。変更状況を確認するのに役立ちます。
sessionId
セッション専用のIDです。
messagesCount
これまでに送受信したメッセージの件数の合計です。
assigneeType
現在のセッションの対応者です（担当者：AGENT／ボット：BOT）。
channelId
セッションが開始された経路（チャットサービスやインスタントメッセージサービスの経路）のIDです。
eventTime
イベントが発生した際のタイムスタンプです。
eventType
受信したWebhookのイベントの種類です（例：IM_Session_Status）。
orgId
Zoho Deskの組織IDです。
   

ステータスの値の表示   

セッションのステータス
返信のステータス
セッションのステータス
値
説明
CREATED
チャットの利用者によって会話が開始されたことを表します。
OPEN
担当者またはボットの対応待ちの状態を表します。
ON_PROGRESS
セッションにおいて、担当者またはボットによって対応が行われていることを表します。
ON_HOLD
対応対象として選択された後、返信が送信されていないことを表します。
ENDED
担当者またはボットによってセッションが終了されたことを表します。
BLOCKED
セッションがブロックされたことを表します。このステータスでは、メッセージのやりとりを行うことはできません。
返信のステータス
値
意味
ACCEPTED
メッセージのやりとりを行うことができます。
CHANNEL_INACTIVE
経路が無効です。メッセージを送信できません。
CHANNEL_REVOKED
経路が取り消されました。メッセージを送信できません。
SESSION_ENDED
セッションが終了し、やりとりが完了しました。
SESSION_BLOCKED
担当者によってブロックされました。メッセージを送信できません。
SESSION_EXPIRED
セッションの期限が切れました。再開するには、チャットの利用者によるメッセージの送信が必要です。
UNASSIGNED
誰にも割り当てられていません。
NOT_AN_ASSIGNEE
担当者またはボットが該当のセッションに割り当てられていません。
CREDIT_EXHAUSTED
メッセージのクレジットがなくなったため、メッセージを送信できません。
ACCESSTOKEN_EXPIRED
（Facebook、Instagramのみ）アクセストークンの期限が切れたため、再認証が必要です。
PERMISSION_REVOKED
（Facebook、Instagramのみ）ページの権限が取り消されました。
UNEXPECTED_ERROR
メッセージを送信する際にエラーが発生しました。設定が正しく行われていない可能性があります。
PAGE_REMOVED
ページ／経路が削除されているか、無効になっています。
SANDBOX_LIMIT_REACHED
テスト環境における1日あたりのメッセージの件数の上限に達しました。
CHANNEL_DELETED
経路が削除されています。メッセージ機能が無効です。
ENDUSER_OFFLINE
（ZBMのセッション）チャットの利用者が無効です。メッセージの受信のみ可能です。
CONFIG_SKIPPED_CHANNEL
設定がスキップされています。
OUTGOING_LIMIT_REACHED
送信可能なメッセージの件数の上限に達しました。
ASSIGNED_TO_OTHER_SERVICE
別のZohoサービスにおいて処理が行われています。


使用例   

  1. リアルタイムでの担当者の割り当て：特定のステータス（例：保留中）の状態が続く場合に、ボットの代わりに担当者を割り当てることができます。
  2. パフォーマンスの確認：終了したセッションに関して、サービスの品質を確認できます。
  3. 待機状態の把握：セッションが未対応の状態で、かつ担当者が割り当てられていない場合に、管理者に対して通知を送信できます。
  4. 複数の対応経路における総合的な分析：セッションIDや経路IDをもとにチャットの対応に関するデータを各経路のデータに関連付けて、対応状況を総合的に分析できます。

設定と連携の例   

エスカレーションの自動化
  1. Webhookと問い合わせ管理システムを連携できます。
  2. ブロックされたセッション、未完了のセッション、途中終了のセッションに関して、自動でエスカレーションするように設定することが可能です。
分析ダッシュボード
  1. Webhookのデータをダッシュボードに反映させることで、セッションの傾向、担当者の対応負荷、チャットの利用者との会話状況に関する最新の情報を確認できます。

通知のカスタマイズ
  1. ペイロード情報のデータをもとに、メール、SMS、アプリ内通知によるチーム向けの通知を作成できます。
  2. ステータスが「BLOCKED」、「CREDIT_EXHAUSTED」のセッションに関する通知を送信し、会話への対応漏れを防ぐことが可能です。


ヒントと留意事項  

  1. ステータスの遷移の記録：対応状況をわかりやすく把握するために、各ステータスの遷移を記録することをお勧めします。
  2. ステータスの定期確認：新しくステータスが追加されているかどうか定期的に確認しましょう。
  3. テストの実行：本番環境でWebhookを実行する前に、テスト環境ですべてのセッションの状態やステータスにおいてWebhookのテストを実行することをお勧めします。
  4. 通知先のURLの確認：データを保護するために、通知先のURLで認証設定を行ってください。

トラブルシューティングのガイドとよくある質問（FAQ）

Webhookのイベントを受信できません。なぜですか？
  1. 宛先のURLが正しく入力されていることをご確認くださいURLがアクセス可能であり、POSTリクエストを受信するためのものであり、JSON形式のデータの受信に対応していることをご確認ください
  2. Webhookのエンドポイントが保護されている場合、認証とファイアウォールの設定をご確認ください
Webhookによる受信データが適切ではありません。なぜですか？
  1. すべてのステータス（例：BLOCKED、SESSION_EXPIRED）に関して、内容をご確認ください
  2. アプリでセッションのステータスと返信のステータスの値を関連付けて、セッションの状態が正しく反映されるように設定してください。
WhatsApp、Facebook、InstagramでこのWebhookを使用できますか？
  1. はい、できます。ペイロードには、ソーシャルメディアの経路に関するステータスの情報が含まれています。Facebook／Instagram連携の場合、「ACCESSTOKEN_EXPIRED」や「PERMISSION_REVOKED」などの返信のステータスを確認することも可能です。