Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Record element records a call or conference and posts the URL of the recording to an action URL.

​
Attributes

action (string) Callback-retry configurable The URL to which recording parameters are sent. See the parameters table below for details. This attribute is required. Allowed values: A fully qualified URL method (string) Callback-retry configurable HTTP method used to send the recording result to the action URL. Allowed values: GET, POST Defaults to POST. fileFormat (string) Specifies the file format of the recording. Allowed values: mp3, wav Defaults to mp3. redirect (boolean) If set to true, the action URL is not fetched; instead, the XML response is retrieved and executed after the recording completes. If set to false, the action URL is fetched and the response is executed immediately, without waiting for the XML response. Allowed values: true, false Defaults to false. timeout (integer) Maximum silence duration in seconds before the recording ends. The timeout does not set a total duration limit on the recording. For recordings that end due to timeout, the RecordingEndReason parameter sent to the action URL is RecordingTimeout. Allowed values: integer > 0 Defaults to 60. maxLength (integer) Maximum length of the recording in seconds. When this limit is reached, the recording ends. For recordings that end due to the maxLength limit, the RecordingEndReason sent to the action URL is maxLength. Allowed values: integer > 0 Defaults to 60. playBeep (boolean) If set to true, a beep plays before the recording begins. Allowed values: true, false Defaults to true. finishOnKey (string) Stops the recording when this key is pressed. For recordings that end this way, the RecordingEndReason sent to the action URL is FinishedOnKey. Allowed values: Any digit, #, * Defaults to 1234567890*#. recordSession (boolean) If set to true, the entire session is recorded, including multiple Play or Speak elements. The recording ends when the call is hung up. For recordings that end this way, the RecordingEndReason sent to the action URL is HungUp. Allowed values: true, false Defaults to false. startOnDialAnswer (boolean) If set to true, the recording starts when the call is answered. Use this for outbound calls where the Record element is nested inside a Dial element. Allowed values: true, false Defaults to false. transcriptionType (string) Specifies the type of transcription service to use. Allowed values: auto, hybrid Defaults to auto. Note: Transcription is available at an additional cost. Refer to the pricing page for details.
  • auto: Transcribes the recording using the default Vobiz transcription service.
    • hybrid: Transcribes the recording using the Vobiz transcription service for the most common languages and a third-party provider for all other languages.
transcriptionUrl (string) Callback-retry configurable A URL to which the transcription is sent. Allowed values: A fully qualified URL transcriptionMethod (string) Callback-retry configurable Specifies the HTTP method to use when requesting the transcriptionUrl. Allowed values: GET, POST Defaults to POST. callbackUrl (string) Callback-retry configurable A URL to which parameters are sent when the recording ends. Similar to the action URL, but the recording file is ready by the time this callback is made. The parameters sent to the callback URL are the same as those sent to the action URL. Allowed values: A fully qualified URL callbackMethod (string) Callback-retry configurable Specifies the HTTP method to use when requesting the callbackUrl. Allowed values: GET, POST Defaults to POST.

​
Parameters sent to the action URL

| RecordUrl | | string | | The URL of the recording file. After receiving this parameter, you may need to wait a few seconds for the file to be available for download. Use the callbackUrl attribute to receive a notification once the file is ready. | | RecordingDuration | | integer | | The duration of the recording in seconds. | | RecordingDurationMs | | integer | | The duration of the recording in milliseconds. | | RecordingStartMs | | integer | | The timestamp when the recording started, in milliseconds. | | RecordingEndMs | | integer | | The timestamp when the recording ended, in milliseconds. | | RecordingID | | string | | A unique identifier for the recording. | | RecordingEndReason | | string | The reason the recording ended. Possible values are:
  • RecordingTimeout: The recording ended due to timeout.
    • maxLength: The recording reached the maxLength limit.
    • FinishedOnKey: The recording ended when finishOnKey was pressed.
    • HungUp: The recording ended when the call was hung up.

​
Parameters sent to the callback URL

The parameters sent to the callback URL are the same as those sent to the action URL.

​
Parameters sent to the transcription URL

| transcription | | string | | The text of the transcription. | | transcription_id | | string | | A unique identifier for the transcription. | | transcription_url | | string | | The URL of the transcription file. | | recording_id | | string | | A unique identifier for the recording. |