Skip to main content
任意のシステムにComdesk Leadから活動履歴のデータをWebhookを用いて連携が可能です。 ※Webhookご利用のお申込みが別途必要となります。

​
運用開始までの流れ

  1. 貴社にてデータを受けるAPIの開発
  2. 当社側で該当テナントのwebhook連携を有効にする
  3. 貴社側のシステム管理者権限ユーザーが、webhookの設定を登録
  • webhook名称 (任意)
  • webhookのエンドポイントURL
  • webhookのAPIキー
  • 接続テストの実施
  • 接続テストが正常に完了すれば、データ連携の準備が整い 連携対象のイベントが実施されたら、データ連携が行われる

​
仕様

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

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

​
Webhook連携のイベント

以下、7種類
  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":""}

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

表-1. 活動履歴のデータ項目一覧
No項目名説明属性サンプル値
1callHistoryId活動履歴のIDNumber1
2workgroupNameワークグループ名Stringテストワークグループ名
3projectNameプロジェクト名Stringテストプロジェクト名
4staffNameユーザー名Stringスタッフ太郎
5modifierName担当営業名String営業花子
6callTime発着信日時String2023-09-25T07:50:23.000000
7callTypeコール種別String着信
8eventNameイベント名Stringcall_start
9customerName顧客名String顧客二郎
10telNo電話番号String03-1234-5678
11callerNumber発信元番号String03-9876-5432
12counterpartName応対者名String応対三郎
13statusString最新コールステータスString不在
14recallFlag再コールフラグnumber0
15duration通話時間String00:01:30
16memo1メモ1Stringめも
17録音ファイルURLString利用には個別契約が必要となります
18customerUUID顧客UUIDString9c28dcd0-c306-424e-91bd-dc89e1b0d3c6
19srText通話全体のテキストString通話内容
20sumText通話の要約String通話内容の要約
21customItemカスタムパラメータString”abc-5es2f-xyz”
22callHistoryUrl活動履歴URLString

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

ClicktoCall用途において、URLパラメータで指定された値をバトンすることが可能です。 自社CRMなどで発信のタイミングで任意の文字列を渡したい際などにご利用ください。 ① comdesktoプロトコルでリンク化 <a href=“comdeskto://comdesk.com/call?number=&crm_object_id=“></a> ②Comdesk Desktopが立ち上がり電話が発信される（crm_object_idに保存される） ③切断をトリガーにcrm_object_idの任意の値がwebhookのcustomItemで渡される。

​
障害発生した場合

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

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

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

障害による自動無効化されていた期間の連携データを残しておく専用のログファイルがある。 そのファイルから復旧対象となる部分を抽出して、復旧を行うスクリプトに渡して手動実行する。 （自動で復旧は無い、Widsley側の対応） ※ webhookの無効化には、障害による自動無効化とは別に 　システム管理者権限ユーザーが、履歴連携webhook画面上でwebhookのON/OFF を切替できる。 　システム管理者権限ユーザーが特定のwebhookをOFFにした場合、その間のデータ連携は行われない。 かつ、OFFになっている間のwebhookは復旧用のログも残していないため 　後からのデータ連携の復旧は行えない。