​

運用開始までの流れ

1. 貴社にてデータを受けるAPIの開発
2. 当社側で該当テナントのwebhook連携を有効にする
3. 貴社側のシステム管理者権限ユーザーが、webhookの設定を登録

• webhook名称 (任意)
• webhookのエンドポイントURL
• webhookのAPIキー
• 接続テストの実施
• 接続テストが正常に完了すれば、データ連携の準備が整い 連携対象のイベントが実施されたら、データ連携が行われる

​

仕様

​

webhook設定登録時の接続テスト

• エンドポイントURL、APIキーを登録
• 接続に成功した場合のみ、Webhook設定を登録完了
  • ※接続時に、タイムアウト制限の30秒に達した場合は失敗と判定

​

Webhook連携のイベント

1. 通話開始 イベント名：call_start
2. 活動履歴のステータス登録 イベント名：register_call_status
3. 活動履歴のステータス更新 イベント名：update_call_status
4. 活動履歴のメモ更新 イベント名：update_memo
5. 音声ファイル作成完了　※通話があった場合のみ発生 イベント名：created_voice_audio_file
6. ASR正常またはエラー終了　※1分以上の通話があった場合のみ発生 イベント名：asr_completed
7. ChatGTP(要約完了)　※1分以上の通話があった場合のみ発生 イベント名：chatgpt_summarized

​

データ連携のリクエスト

• JSON形式でデータをPOST
• リクエストでのタイムアウト、リトライ
  • タイムアウト制限は30秒
  • リトライ含めたリクエストの最大試行回数は4回
  • リクエスト間の待機時間は3分
  • 初回リクエストから最大回数までリトライした場合の時間は合計11分 この時点で正常にレスポンスが取得できない場合は、障害発生中と判断して 該当のwebhook登録情報を自動で無効化する
  • データPOST時に例外発生、レスポンスのHttp Status Codeが 400番台、500番台の場合も障害発生中と判断して 該当のwebhook登録情報を自動で無効化する

​

履歴連携webhook機能のヘッダー情報

'Accept' => 'application/json',
'Content-type' => 'application/json',
'x-api-key' => {ご登録いただいたAPIキー},

​

データ連携のレスポンス

• JSON形式

​

履歴連携データのサンプル

{"callHistoryId":238,"workgroupName":"test-work-group","projectName":"test-project","staffName":"test-staff","modifierName":"test-modifier","callTime":"2023-09-28T00:30:31.000000Z","callType":"着信","eventName":"call_start","customerName":"test-customer","telNo":"09012345678","callerNumber":null,"counterpartName":"test-counterpart","statusString":"test-status","recallFlag":0,"duration":null,"memo1":"test-memo","audioFileUrl":null,"customerUUID":"9c28dcd0-c306-424e-91bd-dc89e1b0d3c6","srText":"","sumText":null,"customeItem":""}

​

履歴連携データの項目について

​

カスタムパラメータについて

​

障害発生した場合

​

障害によりwebhookが自動無効化になった後の貴社の対応

1. 貴社のシステム障害の復旧措置
2. システム管理者権限ユーザーで、履歴連携webhook画面から 無効になったwebhookで再度接続テストを行う → 正常に完了すれば、webhookが有効になりその後からデータ連携が再開される

​

障害により自動無効化になったwebhookの、無効化になっていた期間のデータを再送するには