Search transcribed calls and deliver each result to a callback URL you provide.

When to use. Automate delivery of speech recognition results into your own system. Matching calls are acknowledged immediately, and each finished transcription is posted to your callback URL as it becomes ready. To fetch one call's transcription directly instead, use GET /speech-recognition/{call_id}.

Parameters.

• callback_url (required): where each result is delivered.
• callback_method (required): POST or PUT.
• callback_data (required): a JSON template containing placeholders (see below).
• token (required): authorizes the request. To obtain a token, contact your account manager.
• min_duration, max_duration (integer): restrict by recording length in seconds.
• call_status (string): restrict by call status.
• from, till (date-time): restrict to calls created within this range.
• language (string): restrict by transcription language.
• phrase (string): match calls whose transcription contains this phrase.
• summary (string): match calls whose summary contains this text.
• rank_description (string): match by rank description.
• rank_min, rank_max (integer): rank range, 0 to 100.
• limit (integer): page size, max 50, default 50.
• offset (integer): page offset.

Placeholders for callback_data. Replaced with the call's values before the callback is sent.

Speech:

• {speech_result}: transcription text
• {speech_phrases}: array of detected phrases
• {speech_task_state}: current transcription state
• {speech_summary}: text summary of the call
• {speech_rank}: call rank, 0 to 100
• {speech_rank_description}: text describing the rank

Call:

• {call_id}, {caller_user_id}, {caller_username}
• {start_at}, {end_at}
• {agent_callerid_name}, {agent_callerid_number}
• {call_duration}, {call_bill_duration}

User and campaign:

• {user_group_id}, {object_id} (campaign lead ID), {weight}, {call_after}
• {status_id_before}, {status_id_after}, {status_before}, {status_after}
• {campaign_id}, {campaign_name}, {assigned_user_id}, {assigned_username}

Lead:

• {lead_id}, {country_name}, {first_name}, {last_name}, {phone_normalized}
• {original_identifier} (remote or CRM ID), {email}, {birthdate}
• {support_site}, {purchase_site}, {purchase_date}, {purchase_product_name}, {purchase_card_name}

Returns. { "speechRequestId": "...", "callIds": [ ... ] } acknowledging the matched calls. The full transcriptions arrive later at your callback URL.

Note. Only the token used to submit a call can later retrieve that call's transcription.