Use the the Send Speech with callback URL if you want to send calls to be transcripted and in additon to send the results to a callback URL. You should add the follwong information as query parameters:
Expected Input
callback_url: The URL where the callback will be sent.
callback_method: The HTTP method for the callback request. options: POST, PUT
callback_data: The data of the callback response action, JSON with placeholders.
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
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
language: The language code for the speech recognition.
token: Authentication token for accessing the service.
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