Twilio.Calls.Transcriptions (twilio v0.2.0)

Copy Markdown

API calls: create, update.

Summary

Functions

Stop a Transcription using either the SID of the Transcription resource or the name used when creating the resource

Functions

create(call_sid, params \\ %{}, opts \\ [])

@spec create(String.t(), map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.RealtimeTranscription.t()}
  | {:error, Infusion.Runtime.Error.t()}

Create a Transcription

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json

Path parameters

  • call_sid (required) - The SID of the Call the Transcription resource is associated with.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • conversation_configuration - The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service
  • conversation_id - The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service
  • enable_automatic_punctuation - The provider will add punctuation to recognition result
  • enable_provider_data - Whether the callback includes raw provider data.
  • hints - A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them.
  • inbound_track_label - Friendly name given to the Inbound Track
  • intelligence_service - The SID or unique name of the Intelligence Service for persisting transcripts and running post-call Language Operators
  • language_code - Language code used by the transcription engine, specified in BCP-47 format
  • name - The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
  • outbound_track_label - Friendly name given to the Outbound Track
  • partial_results - Indicates if partial results are going to be sent to the customer
  • profanity_filter - indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks
  • speech_model - Recognition model used by the transcription engine, among those supported by the provider
  • status_callback_method - The http method for the status_callback (one of GET, POST).
  • status_callback_url - Absolute URL of the status callback.
  • track
  • transcription_configuration_id - The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go.
  • transcription_engine - Definition of the transcription engine to be used, among those supported by Twilio

create!(call_sid, params \\ %{}, opts \\ [])

Like create/3, but returns the result or raises Infusion.Runtime.Error.

update(call_sid, sid, params \\ %{}, opts \\ [])

Stop a Transcription using either the SID of the Transcription resource or the name used when creating the resource

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json

Path parameters

  • call_sid (required) - The SID of the Call the Transcription resource is associated with.
  • sid (required) - The SID of the Transcription resource, or the name used when creating the resource

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • status (required)

update!(call_sid, sid, params \\ %{}, opts \\ [])

Like update/4, but returns the result or raises Infusion.Runtime.Error.