Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 3.29 KB

File metadata and controls

31 lines (28 loc) · 3.29 KB

# TranscribeWebhook

Properties

Name Type Description Notes
request_type string The context or reason why this request is being made. Will be transcribe - The TranscribeUtterance command has completed and its actionUrl is being invoked. [optional]
account_id string Account ID associated with your account. [optional]
call_id string Unique identifier for this Call, generated by FreeClimb [optional]
from string Phone number of the party that initiated the Call (in E.164 format). [optional]
to string Phone number provisioned to the customer and to which this Call is directed (in E.164 format). [optional]
recording_id string The ID of the recording. If no recording was made due to errors or the 'saveRecording' flag being disabled this field will be set to null. [optional]
recording_url string The URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download the recording file via the REST API. [optional]
recording_size int The size of the recording in bytes. [optional]
recording_format string The media type of the recording. [optional]
recording_duration_ms int The duration of the recorded audio in milliseconds. [optional]
term_reason \FreeClimb\Api\Model\TranscribeTermReason [optional]
record_term_reason \FreeClimb\Api\Model\RecordUtteranceTermReason [optional]
digit string If recordTermReason is digit, this will be the digit that was pressed. Otherwise it will be null. [optional]
privacy_for_logging bool Echo back of the privacyForLogging flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. [optional]
privacy_for_recording bool Echo back of the privacyForRecording flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. [optional]
barge_in_reason \FreeClimb\Api\Model\BargeInReason [optional]
barged_in_prompt_no int [optional]
barged_in_prompt_ms int duration in ms bargedInPromptNo prompt was executing until barge-in occurred. [optional]
barged_in_prompt_loop_no int [optional]
barge_in_time_ms int epoch time in ms [optional]
transcript string Transcribed text of the recording. Can be empty or null. null means there was a failure in transcribing the audio, refer to transcribeReason for detailed failure reason. [optional]
transcribe_reason \FreeClimb\Api\Model\TranscribeReason [optional]
transcription_duration_ms int The duration of the audio being transcribed in milliseconds [optional]

[Back to Model list] [Back to API list] [Back to README]