gabrielmoreira Configure Native Voice Recording & Transcription (headless)
Turn call recording and call transcription for Native Voice (Thunderbird Voice) on or off on an org, programmatically, so the change takes effect for headless / API-driven support sessions that never touch the Service Console UI. Recording and transcription are two separate preferences — this skill can set either or both to the requested state (leaving the other untouched) and returns a structured JSON confirmation.
Scope
- In scope: setting
enableCallRecordingand/orenableCallTranscriptionto a requested state —true(enable) orfalse(disable) — on theThunderbirdVoiceSettingsmetadata via an sf CLI Metadata API deploy (the genericSettingscontainer, memberThunderbirdVoice); returning a JSON confirmation of the resulting configuration. A preference the user does not name is left at its current value. - Out of scope: changing any other
ThunderbirdVoiceSettingsboolean (e.g. call-recording redaction, SIP recording) — siblings are read only to be preserved, never set or reported; redacting/scrubbing PII from existing recordings or transcripts; transcribing a supplied audio file; provisioning the Native Voice / Thunderbird channel itself; authoring Flow, Apex, or permission sets. These are outside this skill's scope — handle them separately.
Required Inputs
Gather or infer before proceeding:
- Target org — an org alias or username the sf CLI is authenticated to. The deploy
uses this existing
sflogin; no session id or access token is requested. Default: the org's default target. Confirm connectivity withsf org display -o <alias>. - Which preferences — recording, transcription, or both. Default: both, since headless capture typically needs recording and transcription. If the user named just one, target only that one and leave the other at its current value.
- Desired state — enable (
on/true) or disable (off/false) for each named preference. Default: enable, unless the user asks to turn something off. Honor a disable request literally — never re-enable a preference the user asked to turn off.
Workflow
All steps are sequential. Do not skip or reorder. If blocked, stop and ask for the missing org context.
Confirm the two preferences are modeled separately. Recording (
enableCallRecording) and transcription (enableCallTranscription) are distinct booleans on the same metadata type — never collapse them into one combined flag. The final confirmation must report each independently.Run the configure script. Run
scripts/enable-recording-transcription.sh --target-org <alias>with the desired state per preference:--recording on|offand/or--transcription on|off. With no preference flags it defaults to turning both on. Examples: turn both off →--recording off --transcription off; enable recording only →--recording on(transcription left as-is); disable transcription only →--transcription off. The script retrievesThunderbirdVoiceSettings(via theSettingscontainer), checks the org-perm gate, sets only the named flag(s) to the requested value while preserving every other field, validates with a dry-run deploy, deploys, and verifies by round-trip. Use--dry-runto retrieve + validate without persisting. Runscripts/enable-recording-transcription.sh --helpfor all options.For the Metadata API contract, read
references/thunderbird-voice-settings.md— it documents the type, the two booleans, theSettings-container manifest, the v68.0+ version floor, and the retrieve-first gate check. The manifest template the script generates isassets/package.xml.This uses the sf CLI Metadata API deploy, not a raw SOAP call. The member is the mdApiType without the
Settingssuffix (ThunderbirdVoice), and the manifest version MUST be >= 68.0 — the fields are not exposed at any lower version.Change only the named target field(s), to the requested state. The deployed settings file sets exactly the preference(s) the user named —
enableCallRecordingand/orenableCallTranscription— to the requested value (trueto enable,falseto disable); every otherThunderbirdVoiceSettingsboolean, INCLUDING a target preference the user did not name, keeps its retrieved value. Do not add or flip other booleans, and never coerce a disable request back totrue— they are out of this skill's scope or contrary to the request.Return the confirmation JSON. Emit a single JSON object matching
assets/confirmation-output.json: the metadatatypeandfullName, that it was applied via a headless/API deploy, and — for each of the two preferences separately — its field name and its resulting enabled state (true/false, as it now stands after the deploy, whether it was changed or left as-is), plus an overallstatus(ENABLED,DISABLED, orCONFIGURED). It also includes apreservedarray echoing every sibling boolean (e.g.enableCallRecRedaction,enableSipRecording) with the value it was retrieved with — this attests the siblings were carried through unchanged, which compliance callers need as explicit "nothing else moved" assurance. Reporting a sibling's value is NOT changing it. On a successful run the script prints this object on stdout; surface it verbatim as the deliverable — do not strip thepreservedblock.
Rules / Constraints
| Constraint | Rationale |
|---|---|
| Model recording and transcription as two separate preferences | They are distinct booleans (enableCallRecording, enableCallTranscription); collapsing them loses the ability to enable one without the other and fails the output contract. |
Deploy through the generic Settings container with member ThunderbirdVoice |
ThunderbirdVoiceSettings is not a retrievable top-level type name; the Settings container (member = mdApiType minus the Settings suffix) is the sf CLI path and uses the org's sf login — no session id. |
| Manifest version must be >= 68.0 | ThunderbirdVoiceSettings fields are only exposed at API v68.0+; below that the retrieve returns the type empty/absent. |
| Retrieve before deploy; preserve all sibling fields | The deploy is a full-file replace — starting from the retrieved file keeps other prefs intact and lets the gate be checked. |
Report the preserved siblings in a preserved block, but never change them |
Compliance callers need explicit "nothing else moved" assurance; the confirmation echoes each sibling's retrieved value unchanged. Echoing a value is not setting it — the deployed file changes only the named target field(s). |
Honor the requested state literally — enable means true, disable means false |
A disable request that silently re-enables the preference (or reports success while leaving it on) is a correctness failure; set exactly what was asked and report the value the org actually returns. |
| Verify by round-trip before reporting the status | A "Succeeded" deploy is not proof; only report the resulting state after a re-retrieve returns each named preference at its requested value. |
| Output must be a single valid JSON object | The confirmation is consumed programmatically by headless callers; prose-only answers are not usable. |
| Do not include a session id, access token, phone number, recording URL, or transcript content in the output | These are secrets / PII; the confirmation reports configuration state only. |
Gotchas
| Issue | Resolution |
|---|---|
Property 'enableCallRecording' not valid in version <N> / Settings type 'ThunderbirdVoice' is unknown |
API version too low. The fields are only exposed at v68.0+. Raise --api-version to 68.0 or higher — this is NOT a feature gate. |
Retrieve returns an empty <ThunderbirdVoiceSettings/> (no fields) |
Org-perm gate orgHasNativeVoiceAllowed is off — Native Voice is not provisioned. Enable via provisioning/Blacktab; metadata cannot flip an unprovisioned feature. |
Trying to retrieve ThunderbirdVoiceSettings as the type name |
Use the Settings container with member ThunderbirdVoice (mdApiType minus the Settings suffix); the full type name is not a retrievable member. |
Collapsing both prefs into one toggle (e.g. recordingAndTranscription: true) |
Keep two distinct entries in both the deployed file and the confirmation JSON. |
| Deploying a partial settings file | Start from the retrieved file so sibling prefs keep their values; a partial file can reset them. |
Missing jq / sf |
The script depends on them; install or run in an environment that has them (declared in metadata.cliTools). |
Output Expectations
Deliverables:
- A single JSON confirmation object on stdout, shaped per
assets/confirmation-output.json— the metadata target, the headless/API deploy path, each of the two preferences reported separately with its enabled state, apreservedarray echoing every sibling boolean (unchanged) so callers can confirm nothing else moved, and an overallstatus.
No files are written to the org's source tree — the script works in a temporary SFDX project and reports the result.
Reference File Index
| File | When to read |
|---|---|
scripts/enable-recording-transcription.sh |
Step 2 — run to retrieve → set named field(s) → validate → deploy → verify (supports --recording on|off, --transcription on|off, --dry-run, --api-version, --help; defaults to both on). |
references/thunderbird-voice-settings.md |
Step 3 — for the metadata type, the two booleans, the Settings manifest, the v68.0+ floor, and the gate check. |
assets/package.xml |
Step 3 — the Metadata API manifest template the script generates; read to understand or hand-build the retrieve/deploy. |
assets/confirmation-output.json |
Step 5 — the exact shape of the JSON confirmation to return. |