3. Developing

Table of Contents

We currently support 2 events:

privacy_request.received
privacy_request.updated

Those events contain the latest state of the privacy request data. When a voicemail privacy request comes in, you may receive 2 privacy_request.updated after that – one when the voicemail recording is available, and another once the transcription is ready. Here is an example or privacy_request.received for a webform:

{ event_name: "privacy_request.received",
  signature: {
    random_token: "b39a5c7ac85ec479f921cdfaae4b4eee",
    timestamp: "1584300477293",
    signature: "599a40fb2d25f995a40dc43f725a57be4e8df90d2574f75a498eed0d00bebaeb"
  },
  id: "72236cca-c0ee-4c43-8e10-d90737557a66",
  type: "WebForm",
  acknowledged: "false",
  extended: "false",
  completed: "false",
  deadline: "2020-04-28",
  created_at: "2020-03-14 18:44:40 UTC",
  updated_at: "2020-03-14 18:44:40 UTC",
  service_code: {
    code: "57",
    name: "tes",
    created_at: "2020-01-24 15:58:28 UTC",
    updated_at: "2020-01-31 21:15:24 UTC"
  },
  web_form_session: { 
    id: "560179c2-45f6-4168-b5cd-dd640e0c46b2",
    created_at: "2020-03-14 18:44:40 UTC",
    first_name: "Julian",
    last_name: "Salama",
    email: "admin@privacytollfree.com",
    requester_type: "Job Applicant",
    tell_me: "false",
    delete_me: "false",
    do_not_sell: "true",
    other: "",
    send_me: "false",
    remote_ip: "::1",
    state: "DE",
  }
}

Here is an example of a privacy_request.updated for a voicemail request:

{ event_name: "privacy_request.updated",
   signature: {
    random_token: "a021778c09cdae8897859340d3f0b32f"
    timestamp: "1584305606907"
    signature: "201de4703b7ce1eb33878fa29d77d8572ddeb2affd8e7530397d96c0f652eb90"
  }
  id: "abf78bbb-a152-4f09-90ad-5802f53721d7",
  type: "Voicemail",
  acknowledged: "false",
  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",
  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: ""
    mp3_encoded_bytes: ""
    transcription_status: "completed"
    transcription_text: "Hello world!"
  }
}

Privacy Request

KeyDescription
event_nameString, eg: “privacy_request.received”



signature

Object, with a random token, a timestamp in milliseconds, and a signature. Please refer to the security section to use this
idUUID, the id as a string of the privacy request in our system.
typeString, e.g. “Voicemail”
acknowledgedBoolean, e.g: “false” represent if the privacy request was acknowledged.
completedBoolean, e.g: “true” represent if the privacy request was completed.
extendedBoolean, e.g: “false” represent if the privacy request was extended.
deadlineDate, eg: “2019-11-05”, calculated based on the extennded field, and created_at
created_atTimestamp, the time at which we received this request
updated_atTimestamp, the time at which we updated this request

Service code

KeyDescription
codeString, your service code for this request.
nameString, your service code name for this request
created_atTimestamp at which your created the service code
updated_atTimestamp, the last time this object was updated.

Call Session

KeyDescription
created_atTimestamp at we received the call for this request
ended_atTimestamp when the caller hung up
caller_idString, the phone number we received
caller_nameString CNAM Lookup of the caller name
caller_stateString e.g. “CA” state of the consumer derived from area code of the number
recording_statusString, “completed”, when bytes are available, or “failed”.
mp3_encoded_byesString, a based64 encoded string representing the bytes of the mp3
transcription_statusString, “completed” if we completed the transcription.
transcription_text“Hello world!”

Web From Session

KeyDescription
idUUID of the web form session
created_atTimestamp at we received the webform for this request
first_nameString, first name of the requester
last_nameString, last name of the requester
emailString, email of the requester
stateString State of the requester reported on the webform eg: “DE”
requester_typeString type of requester. e.g.: “Consumer”
send_meBoolean, eg: “true” User request that you send a copy of his information
tell_meBoolean, eg: “false” User request that you tell him more about the information collected and why.
delete_meBoolean, eg: “false” User request that you delete the information collected about him.
do_not_sellBoolean, eg: “true” User Request that you stop selling his information.
otherString, a message from the user.
remote_ip:String, The IP address of the requester
Previous 2. Software Security
Next 4. Automatic and Manual Retries
Table of Contents