SYSTEM INTEGRATION · API 1.7

API連携・データ管理ガイド

CSVファイルを介さず、自社システムから必要な情報を連携。
登録から結果取得、電話帳の個人情報削除までを自動化できます。

ファイルの書き出し・メール添付・手作業による取り込みを減らし、連携用キーの権限や有効期限を用途ごとに管理できます。

1. 必要な情報を送る自社システム → HTTPS / JSON → オトコル
2. 結果を取り込む発信・SMS・AI通話などの結果を自社システムへ
3. 不要な電話帳情報を消す連絡先IDを指定し、個人情報を削除

連携できる操作

操作内容
連絡先の登録・更新氏名・電話番号・メモ・任意項目をJSONで連携。電話帳の管理APIからの登録・更新では発信やSMS送信を行いません。
連絡先の取得一覧・1件の詳細取得、電話番号の完全一致検索、更新日時での絞り込み。1ページは最大200件です。
発信・SMSの実行設定済みの発信APIに連絡先を送信すると、指定の動作を実行します。1リクエスト最大200件、発信APIごとに毎分60リクエストまで。再送時は同じ重複防止キーを指定します。
結果の取得通常発信・SMS・AI通話・プレディクティブコールの結果を取得できます。結果の内容や必要な契約は機能によって異なります。
電話帳の個人情報削除連絡先IDを指定して氏名・電話番号・メモ・任意項目を消去。通話や請求の参照に必要なIDと削除状態は残します。

APIのご利用はBusiness以上が対象です。プレディクティブコールなど個別機能のご利用条件については、ご契約内容と合わせてご案内します。

必要な操作だけを許可する

APIキーはアカウント単位で発行します。「発信・SMSの実行」「結果の取得」「連絡先の取得」「連絡先の登録・更新」「連絡先の削除」から、必要な権限を選べます。例えば、結果を取り込むシステムには結果取得だけを許可し、削除処理には別のキーを使えます。

ログに複製する情報を減らす

発信APIの編集画面で「受信本文・氏名・電話番号を保存する」をOFFにすると、それ以後の発火ログには、日時・結果・件数・対象IDを残します。受信本文・氏名・電話番号・タイトル・エラー詳細は保存せず、発火通知にも含めません。

画面で新しく作る発信APIはこの設定がOFFです。既存の発信APIは設定を変更するまで従来どおり保存します。過去に保存したログには変更が及びません。発火ログの保持期間は90日です。

アクセス監査には、利用したキーID・操作・結果を記録します。APIキーの値やリクエスト本文は含めません。連絡先管理・発火の入力値はアプリケーションのリクエストパラメータログでも伏せます。

削除する情報・残る情報

保存先・情報連絡先削除APIの対象
電話帳の個人情報削除します。氏名・電話番号・メモ1〜3・任意項目の値を消去し、タグとの紐付けを外します。
電話帳のID・削除状態通話や請求の参照を維持するため残します。削除済みの連絡先は通常のAPI取得結果に出ません。
通話記録・録音・文字起こし・AI抽出結果このAPIでは削除しません。電話帳とは別に保存されるデータです。
SMS本文・送信先・過去の発火ログ・外部同期の対応表・除外リストこのAPIでは削除しません。連絡先の削除と発信禁止は別の操作です。
外部通知先・連携先・バックアップこのAPIの削除対象外です。各保存先の管理・保持条件を別途確認する必要があります。
削除APIは、すべての保存先から個人情報を消去する機能ではありません。通話記録を含む一括消去や保存期間経過後の自動削除は、このAPIには含まれません。ご契約前に、必要な保存期間と削除対象をすり合わせます。

削除前に送信元の同期・予約・実行中処理を停止してください。削除は発信キャンセルではなく、同じ情報を再送すると新しい連絡先として登録されます。同じ連絡先IDを再び削除しても安全に完了応答を返します。

導入時の確認事項

  1. 送る項目を決める。架電に必要な電話番号、識別に使う名称、必要な差し込み項目に絞ります。氏名を呼びかけに使わない運用では、名称欄に社内管理用のラベルを使うこともできます。
  2. キーと保存方針を設定する。権限・有効期限・発火ログ保存のON/OFFを設定します。重複防止キーにも氏名や電話番号を入れず、連携処理ごとの識別子を使います。
  3. 合成データで一連の処理を確認する。連絡先の登録・更新・結果取得・削除を確認します。電話帳管理APIは発信しませんが、発火APIは設定に従って実際に電話やSMSを送るため、試験用の宛先と動作を設定します。
  4. 再送と障害時の動作を決める。発火には同じ重複防止キーを使います。連絡先の登録で409が返った場合は電話番号で照合します。通知は取りこぼす可能性があるため、結果取得APIによる照合も組み合わせます。

API連携によってファイルの複製や手作業を減らせますが、業務処理に必要なデータはオトコル側にも保存されます。連携先のアクセス制御・ログ・バックアップも含めて運用を設計してください。