Files
next-static-site/markdown/docs/webhooks/transcribe.md
Brandon Lee Kitajchuk db94b17829 Latest news + banner, cypress tests, open source copy, general style tweaks (#13)
* Adding latest news and banners

* Adding first draft of cypress specs and github actions workflow

* Adding sticky position for top banner

* Tweak styles for new latest news section

* Tweak styles for text__layout innerHTML

* Fix Cypress homepage test spec

* Fix mobile navi z-index with sticky top banner

* Fix sticky banner z-index bug with mobile navi

* Refactor markdown tools to support pages beyond developer docs

* Adjust TADHACK text max-widths for small mobile

* initial changes for open source copy

* more copy

* more copy

* updated open source structure

* minor

* typo

* more copy

* Adjust styles for Open Source markdown small text

* Update readme and remove floats from docs webhooks markdown

* Add readme notes on Cypress and flesh out navi spec tests

* Fix main navi highlight when on sub-sections of markdown pages

Co-authored-by: Dave Horton <daveh@beachdognet.com>
2021-07-22 12:34:01 -04:00

1.5 KiB

transcribe

The transcribe verb is used to send real time transcriptions of speech to a web callback.

The transcribe command is only allowed as a nested verb within a dial or listen verb. Using transcribe in a dial command allows a long-running transcription of a phone call to be made, while nesting within a listen verb allows transcriptions of recorded messages (e.g. voicemail).

{
  "verb": "transcribe",
  "transcriptionHook": "http://example.com/transcribe",
  "recognizer": {
    "vendor": "Google",
    "language" : "en-US",
    "interim": true
  }
}

You can use the following options in the transcribe command:

option description required
recognizer.dualChannel if true, transcribe the parent call as well as the child call no
recognizer.interim if true interim transcriptions are sent no (default: false)
recognizer.language language to use for speech transcription yes
recognizer.profanityFilter if true, filter profanity from speech transcription. Default: no no
recognizer.vendor speech vendor to use (currently only Google supported) no
transcriptionHook webhook to call when a transcription is received. Due to the richness of information in the transcription an HTTP POST will always be sent. yes

Note

: the dualChannel property is not currently implemented.

Prev: tag