This endpoint allows you to search and send calls for speech recognition based on various input filters (like duration, language, phrase, and more), and if transcription is complete, the results are sent automatically to your callback URL. It supports dynamic placeholders in the callback data to include call, speech, user, campaign, and lead details. The response initially provides a speech request ID and call IDs, while the full speech results are sent later to the callback URL.
Expected Input
callback_url: (string) The URL where the callback will be sent. (mandatory)
callback_method: (string) The HTTP method for the callback request. options: POST, PUT. (mandatory)
callback_data: (string) The data of the callback response action, JSON with placeholders. (mandatory)
token(string)
min_duration(integer)
max_duration(integer)
call_status(string)
from(DateTime)
till(DateTime)
language(string)
phrase(string)
summary(string)
rank_description(string)
rank_min(Integer 0-100)
rank_max(Integer 0-100)
limit(integer)
Allowed placeholders for callback_data:
Speech-related:
- {speech_result} - Speech result
- {speech_phrases} - Array of Speech phrases
- {speech_task_state} - Speech task's current state
- {speech_summary} - Text Summary of the call
- {speech_rank} - Rank of the call between 0 to 100
- {speech_rank_description} - Text of the speech recognition rank description
Call-related:
- {call_id} - Call Id
- {caller_user_id} - Caller User Id
- {caller_username} - Caller username
- {start_at} - Call Start At
- {end_at} - Call End At
- {agent_callerid_name} - Agent Caller Id name
- {agent_callerid_number} - Agent Caller Id number
- {call_duration} - Call duration
- {call_bill_duration} - Call bill duration
User and Campaign-related:
- {user_group_id} - User group Id
- {object_id} - Campaign Lead Id
- {weight} - Campaign Lead weight
- {call_after} - Campaign Lead Call After
- {status_id_before} - Campaign Lead Status Id before
- {status_id_after} - Campaign Lead Status Id after
- {status_before} - Campaign Lead Status before
- {status_after} - Campaign Lead Status after
- {campaign_id} - Campaign Id
- {campaign_name} - Campaign name
- {assigned_user_id} - Assigned User Id
- {assigned_username} - Assigned Username
Lead-related:
- {lead_id} - Lead Id
- {country_name} - Lead Country name
- {first_name} - Lead first_name
- {last_name} - Lead last_name
- {phone_normalized} - Lead phone
- {original_identifier} - Lead original identifier (Remote\CRM Id)
- {support_site} - Lead support site
- {purchase_site} - Lead purchase site
- {purchase_date} - Lead purchase date
- {purchase_product_name} - Lead purchase product name
- {purchase_card_name} - Lead purchase card name
- {email} - Lead email
- {birthdate} - Lead birthdate
Expected Output
The response will be in JSON format and may include a speechRequestId and callIds object containing the details of calls that initiate to speech recognition service. while speech transcript will be ready, the request will initiate to your callback_url
**Important: The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results.