メインコンテンツへスキップ

Optacy Webhookの開発

OptacyのプライバシーリクエストWebhookのイベントタイプ、ペイロード例、フィールドリファレンスです。

Optacyは現在、次の2つのイベントに対応しています。

privacy_request.received
privacy_request.updated

どちらのイベントにも、プライバシーリクエストの最新の状態が含まれます。Toll-Free Numberからのリクエストの場合、受信後にprivacy_request.updatedイベントを2回受け取ることがあります。1回目は録音が利用可能になったとき、2回目は文字起こしの準備ができたときです。

例:privacy_request.received(ウェブフォーム)

{
  "event_name": "privacy_request.received",
  "signature": {
    "random_token": "b39a5c7ac85ec479f921cdfaae4b4eee",
    "timestamp": "1584300477293",
    "signature": "599a40fb2d25f995a40dc43f725a57be4e8df90"
  },
  "id": "4e2c7dcd-8277-40bb-1082-66c7cb417df2",
  "type": "WebForm",
  "primary_identifier": "john@doe.com",
  "consumer_email": "john@doe.com",
  "email_verified_at": "2025-01-01",
  "acknowledged": true,
  "categorized": false,
  "verified": false,
  "extended": false,
  "completed": false,
  "completed_rights": {
    "data_categories_request": { "completed": false, "completed_at": null },
    "do_not_sell": { "completed": true, "completed_at": "2025-01-01" },
    "erase_my_information": { "completed": false, "completed_at": null },
    "send_me_a_copy_of_information": { "completed": false, "completed_at": null },
    "other": { "completed": false, "completed_at": null }
  },
  "deadline": "2025-07-02",
  "created_at": "2025-05-18T17:36:44.399Z",
  "updated_at": "2025-05-18T17:36:45.187Z",
  "categorized_country": "USA",
  "categorized_state": "California",
  "service_code": {
    "code": 1,
    "name": "Example Brand",
    "created_at": "2024-07-16T20:31:24.915Z",
    "updated_at": "2025-05-18T16:40:19.894Z"
  },
  "jurisdiction_rule": {
    "name": "USA only",
    "description": "Description of applied Jurisdiction Rule",
    "created_at": "2025-05-17T18:48:59.391Z",
    "days_to_process": 45,
    "notes": "Available in the Jurisdictions tab in the dashboard."
  },
  "web_form_session": {
    "id": "904c1b30-2ba8-49cf-a349-46f7c6b29e70",
    "created_at": "2025-05-18T17:36:44.394Z",
    "remote_ip": "24.102.96.226"
  }
}

例:privacy_request.updated(ボイスメール)

{
  "event_name": "privacy_request.updated",
  "signature": {
    "random_token": "a021778c09cdae8897859340d3f0b32f",
    "timestamp": "1584305606907",
    "signature": "201de4703b7ce1eb33878fa29d77d8572ddeb2af"
  },
  "id": "abf78bbb-a152-4f09-90ad-5802f53721d7",
  "type": "Voicemail",
  "primary_identifier": "john@doe.com",
  "consumer_email": "john@doe.com",
  "acknowledged": false,
  "categorized": false,
  "verified": true,
  "extended": false,
  "completed": true,
  "deadline": "2019-11-05",
  "created_at": "2019-09-21 16:31:11 UTC",
  "updated_at": "2020-03-15 20:48:05 UTC",
  "categorized_country": "USA",
  "categorized_state": "California",
  "service_code": {
    "code": "2",
    "name": "test",
    "created_at": "2019-09-21 16:31:11 UTC",
    "updated_at": "2020-01-26 05:59:40 UTC"
  },
  "call_session": {
    "created_at": "2019-09-21 16:31:11 UTC",
    "ended_at": "2019-09-21 16:33:11 UTC",
    "caller_id": "+15555555555",
    "caller_name": "John Smith",
    "caller_state": "CA",
    "recording_status": "completed",
    "mp3_encoded_bytes": "",
    "transcription_status": "completed",
    "transcription_text": "Hello world!"
  }
}

プライバシーリクエストのフィールド

キー説明
event_name文字列(例:privacy_request.received)
signatureランダムトークン、タイムスタンプ(ミリ秒)、署名を含むオブジェクト。ソフトウェアセキュリティを参照
idプライバシーリクエストのUUID
type文字列(例:VoicemailまたはWebForm)
primary_identifierリクエストの主要識別子
consumer_email請求者とのやり取りに使用するメールアドレス
email_verified_atメールアドレスが確認された日時
acknowledgedリクエストの受領通知が済んでいるかどうか
verifiedリクエストが確認済みとしてマークされているかどうか
categorizedリクエストが分類済みかどうか(ウェブフォームの場合は常にtrue)
completedリクエストが完了したかどうか
completed_rights権利のキーと{ completed, completed_at }の対応マップ
extended期限が延長されたかどうか
deadlineJurisdiction Rules、延長、未完了の権利に基づく期限日
created_at / updated_atリクエストのタイムスタンプ
categorized_rights推奨される権利のビュー:回答と権利の設定
categorized_questions_data推奨されるフォーム回答のビュー:値とForm Field Setの設定
categorized_country / categorized_state推奨される法域フィールド(米国外ではstateはnull)

Service Code

キー説明
codeこのリクエストのService Code
nameService Codeの表示名
created_at / updated_atService Codeのタイムスタンプ

通話セッション(Toll-Free Numberからのリクエスト)

キー説明
created_at / ended_at通話の開始時刻と終了時刻
caller_id発信者の電話番号
caller_nameCNAM検索による発信者名
caller_state市外局番から判定した米国の州(判定できる場合)
recording_statusバイトが利用可能な場合はcompleted、失敗した場合はfailed
mp3_encoded_bytesBase64エンコードされたMP3バイト
transcription_status文字起こしの準備ができるとcompleted
transcription_text文字起こしのテキスト

ウェブフォームセッション

キー説明
idウェブフォームセッションのUUID
created_atウェブフォームを受信した日時
remote_ip請求者のIPアドレス
webform_questions_data / rights代わりにcategorized_questions_dataとcategorized_rightsの使用を推奨
country_of_residence / state分類済みの国/州フィールドにコピーされます