Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 2.95 KB

GetSpeechWebhook.md

File metadata and controls

50 lines (44 loc) · 2.95 KB

Freeclimb::GetSpeechWebhook

Properties

Name Type Description Notes
request_type String Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked. [optional]
call_id String Unique ID for this Call, generated by FreeClimb. [optional]
account_id String Account ID associated with your account. [optional]
from String Phone number of the party that initiated the Call (in E.164 format). [optional]
to String Phone number provisioned to you and to which this Call is directed (in E.164 format). [optional]
call_status CallStatus [optional]
direction CallDirection [optional]
conference_id String Unique ID of the Conference. [optional]
queue_id String This is only populated if the request pertains to a Queue. Otherwise, it is set to null. [optional]
reason GetSpeechReason [optional]
recognition_result String Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by 'xxxxx' when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit. [optional]
confidence Integer Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition. [optional]
parent_call_id String ID of the Call that created this leg (child call). [optional]
completion_reason String Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition. [optional]
completion_cause String Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition. [optional]
mrcp_code Integer Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification. [optional]
mrcp_diagnostic String Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification. [optional]

Example

require 'freeclimb'

instance = Freeclimb::GetSpeechWebhook.new(
  request_type: null,
  call_id: null,
  account_id: null,
  from: null,
  to: null,
  call_status: null,
  direction: null,
  conference_id: null,
  queue_id: null,
  reason: null,
  recognition_result: null,
  confidence: null,
  parent_call_id: null,
  completion_reason: null,
  completion_cause: null,
  mrcp_code: null,
  mrcp_diagnostic: null
)