Webhook

有人対応への切り替え、新着メッセージ、会話終了、チケット、ドキュメント処理などのイベント通知に加え、署名検証とリトライのルールについて説明します。

管理画面の「ボット設定」で webhook アドレスを入力します。リクエストヘッダー：

ヘッダー説明
X-AICS-Event-Idイベント ID。これで重複を排除します
X-AICS-Timestamp / X-AICS-Signature署名検証の方法は注文照会 APIと同じです

リクエストボディ：{"id", "type", "created_at", "data"}。

イベント発生タイミング
conversation.handoff有人対応への切り替え（切り替え方法で「自分のシステムにプッシュ」または「両方に通知」を選択した場合）
conversation.message有人モードでお客様から新しいメッセージが届いたとき
conversation.closed会話の終了（data.conversation.closed_by で終了した人を確認できます）
conversation.ratedお客様が終了した会話を評価したとき：data.rating、data.comment
ticket.created新しいチケット（オペレーターがオフライン時の、お客様からのメッセージを含む）：data.ticket、data.description
ticket.updatedチケットのステータス、優先度、担当者などの変更：data.changes は {フィールド: [旧, 新]}
ticket.repliedオペレーターがお客様に返信したとき：data.reply
document.ready / document.failedドキュメントの処理が完了または失敗したとき

2xx を返すと成功とみなされます。それ以外の場合は 30 秒、2 分、10 分……最長 12 時間のバックオフで、合計 8 回リトライします。順序は保証されません。

このページは役に立ちましたか?

最終更新: