Webhook連携について

Webhookとコールコネクトの連携方法についてご案内します。

コールコネクト上で通話し、メモを保存した際に、設定したURLに対してHTTPのPOSTでデータを送信します。
Webhook連携により、例えば外部チャットサービス、もしくはご自身でデータを蓄積するなど、あらゆるサービスへ通話履歴を取得・保存できます。

設定方法

1. コールコネクトの[管理]>[連携]より、Webhookを選択します。

2. Webhook先のURL (https:)を入力します。

3. 録音テキスト変換にチェックを入れると、録音のテキスト変換が完了次第、Webhookが送信されます。録音のテキスト変換の詳細は、録音のテキスト変換についてをご参照ください。

4. どのタイミングで通知を送るかを指定します。詳細は 通知イベントの詳細について をご参照ください。

5. [連携]ボタンをクリックし、連携を完了させます。

送信データ

以下のようなデータを指定したURLに対して HTTP POST で送信します。

項目		例
Content-Type	application/x-www-form-urlencoded
contact[id]	顧客情報の ID 。https://www.callconnect.jp/console/?contacts/{ID} で対象の顧客へアクセスできます。	150
contact[name]	顧客の氏名	電話　太郎
contact[number]	電話番号	0120-994-132
contact[company]	顧客の会社名	株式会社コールコネクト
contact[email]	顧客のメールアドレス	[e-mail]
contact[address]	顧客の住所	東京都新宿区
contact[memo]	顧客に対してのメモ	メモです。
contact[created_at]	顧客の作成日時	2017-10-06T21:56:12.897+09:00
contact[external_id]	顧客の外部連携先のID	20851
contact[external_info]	顧客の外部連携情報	hubspot|111222
record[id]	通話のid	22232
record[status]	200: 発信通話, 201: 着信通話, 400: 外線不在, 401: 着信不在, 402: 営業時間外着信	200
record[voice_url]	録音のURL。保留や取次などを繰り返すと、カンマ"," で区切られた複数のURLが格納されます。	https://~~~
record[transcribes]	録音テキスト変換結果	{ "RE~~": [...] } 詳細
record[transcribe_direction]	発言者の表示区分	outbound_operator_right
record[duration]	通話時間	35
record[memo]	通話メモ	通話メモです。
record[tags]	通話タグ	["お問い合わせ","顧客"]
record[direction]	通話の向き(inbound or outbound)	inbound
record[post_process_duration]	通話後の後処理(メモ保存)から終了までの時間	45
record[wait_time]	キューイングON時の待ち時間[Proプラン限定]	20
record[created_at]	通話終了日時	2017-10-06T21:56:12.897+09:00
used[id]	利用した電話番号 ID	52
used[number]	利用した電話番号	050-1222-4444
used[friendly_name]	利用した番号の名前	受付窓口
user[id]	担当者のユーザーID	153
user[name]	担当者名	西川
user[role]	担当者の権限 (30:管理者, 20: 書き込み, 10: 読み込み)	30
user[email]	担当者メールアドレス	[e-mail]
user[image_url]	担当者の画像URL	https://~~/~.png

仕様

登録された情報がない場合、空文字を送信します。
また、顧客情報が登録されていない通話の場合、contactはnumberのみが登録された状態で送信します。

テストアカウントが必要な場合は、改めて別のメールアドレスで無料トライアルを始めてください。
2週間以上開発に時間がかかる場合には、その無料トライアルを延期する作業も可能ですのでご連絡ください。

実装

Webhook確認方法

1. 外部サービス Webhook.site にて取得したWebhookURL をCallConnectのWebhook連携へコピー&ペーストします。
2. CallConnect側で通話します。
3. Webhook.siteでどのようなデータが送られるかの確認ができます。

Node.js, AWS Lambda サンプルコード

const querystring = require('querystring');

exports.handler = async (event) => {
    const decoded = decodeURI(Buffer.from(event.body, 'base64').toString());
    const data = querystring.parse(decoded);
    // data['record[wait_time]'] などでデータ取得できます。
}