Skip to content
HALOWERK

Tonwerk

mandatory notice check

Disclosed German and English cue patterns for five notices with their legal anchor: recording (§ 201 StGB, consent question detected separately), caller identity and commercial purpose at the start of the call (§ 312a (1) BGB), right of withdrawal (§§ 312g, 355 BGB, Art. 246a EGBGB) and data protection information (Art. 13 GDPR); sources gesetze-im-internet.de and EUR-Lex, as of 01.11.2026. Opening notices must appear within opening_s seconds (or the first three company-side turns without.

POST https://ton.halowerk.com/v1/mandatory-notice-check

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
transcriptstring, object, arrayNoTranscript as WebVTT or SRT text (speakers from <v Name> voice tags or "Name:" prefixes), or JSON (text or object) with a list of segments, utterances, turns, cues or words carrying start, end, speaker and text – e.g. the output of medienwerk /v1/stt or /v1/diarize, Whisper, AssemblyAI or Deepgram.
segmentsarrayNoAlternative to transcript: segments with start/end in seconds, speaker and text.
time_unitstringNoUnit of start/end in JSON transcripts; auto treats integer values with a median segment length above 60 as milliseconds.
agent_speakersarrayNoSpeaker labels of the company side (agent, IVR). Rules that concern what the company says are then checked only in these speakers' segments.
noticesarrayNoBuilt-in notices to check (default all five).
custom_noticesarrayNoOwn notices as accepted wordings.
opening_snumberNoOpening window for identity, purpose and recording notices (default 60 s).
min_scorenumberNoMatch score for custom notices (default 0.75).
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transcript": {
      "type": [
        "string",
        "object",
        "array"
      ],
      "minLength": 1,
      "maxLength": 3000000,
      "description": "Transcript as WebVTT or SRT text (speakers from <v Name> voice tags or \"Name:\" prefixes), or JSON (text or object) with a list of segments, utterances, turns, cues or words carrying start, end, speaker and text – e.g. the output of medienwerk /v1/stt or /v1/diarize, Whisper, AssemblyAI or Deepgram."
    },
    "segments": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5000,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "start",
          "end",
          "text"
        ],
        "properties": {
          "start": {
            "type": "number",
            "minimum": 0,
            "maximum": 86400,
            "description": "Start time in seconds."
          },
          "end": {
            "type": "number",
            "minimum": 0,
            "maximum": 86400,
            "description": "End time in seconds."
          },
          "speaker": {
            "type": "string",
            "maxLength": 100,
            "description": "Speaker label as delivered by diarisation, e.g. \"A\", \"SPEAKER_00\" or \"Agent\"."
          },
          "text": {
            "type": "string",
            "maxLength": 5000,
            "description": "Text of the segment."
          }
        }
      },
      "description": "Alternative to transcript: segments with start/end in seconds, speaker and text."
    },
    "time_unit": {
      "type": "string",
      "enum": [
        "auto",
        "s",
        "ms"
      ],
      "default": "auto",
      "description": "Unit of start/end in JSON transcripts; auto treats integer values with a median segment length above 60 as milliseconds."
    },
    "agent_speakers": {
      "type": "array",
      "maxItems": 20,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "description": "Speaker labels of the company side (agent, IVR). Rules that concern what the company says are then checked only in these speakers' segments."
    },
    "notices": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "recording",
          "identity",
          "purpose",
          "withdrawal",
          "privacy"
        ]
      },
      "description": "Built-in notices to check (default all five)."
    },
    "custom_notices": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "phrases"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          },
          "phrases": {
            "type": "array",
            "minItems": 1,
            "maxItems": 10,
            "items": {
              "type": "string",
              "minLength": 3,
              "maxLength": 300
            }
          },
          "within_opening": {
            "type": "boolean",
            "default": false
          }
        }
      },
      "description": "Own notices as accepted wordings."
    },
    "opening_s": {
      "type": "number",
      "minimum": 5,
      "maximum": 600,
      "default": 60,
      "description": "Opening window for identity, purpose and recording notices (default 60 s)."
    },
    "min_score": {
      "type": "number",
      "minimum": 0.4,
      "maximum": 1,
      "default": 0.75,
      "description": "Match score for custom notices (default 0.75)."
    }
  }
}

Open original schema

Published input example

{
  "transcript": "Agent: Good afternoon, this is the renewal team calling from Warehouse Telecom.\nAgent: I'm calling about your contract renewal. This call is recorded for quality purposes, is that okay?\nCustomer: Fine.\nAgent: You have a 14-day right to cancel, and our privacy notice is on our website.",
  "agent_speakers": [
    "Agent"
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →