POST

Recordings.Transcribe

Start AI transcription for one call recording when the transcription module is enabled. This can take longer than a read route because it uses the existing transcription workflow.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Runs the Recordings.Transcribe function and returns JSON.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

NameTypeSampleExplanation
recording_id
post
int600Recording id.

Optional Parameters

NameTypeSampleWhat it gives
force
post
int0Set to 1 to overwrite an existing transcription.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Recordings.Transcribe",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "recording_id": "600",
        "force": "0"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Recordings.Transcribe",
    "url_domain": "https:\/\/{domain}\/app\/Recordings.Transcribe"
}

Endpoint

POST /app/Recordings.Transcribe
POST https://{user}.bull36.com/app/Recordings.Transcribe
POST https://{domain}/app/Recordings.Transcribe

Sample Output

{
    "success": 1,
    "recording_id": 600,
    "transcription_text": "Call text",
    "transcription_values": {
        "summary": "Customer asked for pricing"
    },
    "tokens_used": 1000,
    "skipped": 0
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ recording_id: '600', force: '0' });
const res = await fetch('/app/Recordings.Transcribe', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Module disabled"
}