Skip to content

Latest commit

 

History

History
62 lines (56 loc) · 3.83 KB

TranscribeWebhook.md

File metadata and controls

62 lines (56 loc) · 3.83 KB

Freeclimb::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 Integer The size of the recording in bytes. [optional]
recording_format String The media type of the recording. [optional]
recording_duration_ms Integer The duration of the recorded audio in milliseconds. [optional]
term_reason TranscribeTermReason [optional]
record_term_reason 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 Boolean 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 Boolean 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 BargeInReason [optional]
barged_in_prompt_no Integer [optional]
barged_in_prompt_ms Integer duration in ms bargedInPromptNo prompt was executing until barge-in occurred. [optional]
barged_in_prompt_loop_no Integer [optional]
barge_in_time_ms Integer 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 TranscribeReason [optional]
transcription_duration_ms Integer The duration of the audio being transcribed in milliseconds [optional]

Example

require 'freeclimb'

instance = Freeclimb::TranscribeWebhook.new(
  request_type: null,
  account_id: null,
  call_id: null,
  from: null,
  to: null,
  recording_id: null,
  recording_url: null,
  recording_size: null,
  recording_format: null,
  recording_duration_ms: null,
  term_reason: null,
  record_term_reason: null,
  digit: null,
  privacy_for_logging: null,
  privacy_for_recording: null,
  barge_in_reason: null,
  barged_in_prompt_no: null,
  barged_in_prompt_ms: null,
  barged_in_prompt_loop_no: null,
  barge_in_time_ms: null,
  transcript: null,
  transcribe_reason: null,
  transcription_duration_ms: null
)