record_call

Record call in the background. Unlike the record method, the record_call method will start the recording and continue executing the SWML script while allowing the recording to happen in the background. To stop call recordings started with record_call, use the stop_call_record method.

record_call

objectrequired

An object that accepts the record_call parameters.

record_call Parameters

record_call.control_id

string

Default: Auto-generated, saved to record_control_id variable

Identifier for this recording, to use with stop_record_call

record_call.stereo

boolean

Default: false

Whether to record in stereo mode

record_call.format

string

Default: wav

Format ("wav", "mp3", or "mp4")

record_call.direction

string

Default: both

Direction of the audio to record: "speak" for what party says, "listen" for what party hears, "both" for what the party hears and says

record_call.terminators

string

Default: ""

String of digits that will stop the recording when pressed. Default is empty (no terminators).

record_call.beep

boolean

Default: false

Whether to play a beep before recording

record_call.input_sensitivity

number

Default: 44.0

How sensitive the recording voice activity detector is to background noise? A larger value is more sensitive. Allowed values from 0.0 to 100.0.

record_call.initial_timeout

number

Default: 0

How long, in seconds, to wait for speech to start?

record_call.end_silence_timeout

number

Default: 0

How much silence, in seconds, will end the recording?

record_call.max_length

number

Maximum length of the recording in seconds.

record_call.status_url

string

HTTP or HTTPS URL to deliver record status events.

Variables

Set by the method:

• record_call_url: (out) the URL of the newly started recording.
• record_call_result: (out) success | failed.
• record_control_id: (out) control ID of this recording.

Examples

Start an MP3 recording of the call

YAML

version: 1.0.0
sections:
  main:
    - record_call:
        format: mp3

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "record_call": {
          "format": "mp3"
        }
      }
    ]
  }
}

Record and play back

Record both sides of the conversation:

YAML

version: 1.0.0
sections:
  main:
    - record_call:
        beep: true
        terminators: '#'
    - play:
        urls:
          - 'say:Leave your message now'
          - 'silence:10'
    - stop_record_call: {}
    - play:
        urls:
          - 'say:Playing back'
          - '${record_call_url}'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "record_call": {
          "beep": true,
          "terminators": "#"
        }
      },
      {
        "play": {
          "urls": [
            "say:Leave your message now",
            "silence:10"
          ]
        }
      },
      {
        "stop_record_call": {}
      },
      {
        "play": {
          "urls": [
            "say:Playing back",
            "${record_call_url}"
          ]
        }
      }
    ]
  }
}

Record only the speaker's side

YAML

version: 1.0.0
sections:
  main:
    - record_call:
        beep: true
        direction: speak
    - play:
        urls:
          - 'say:Leave your message now'
          - 'silence:10'
    - stop_record_call: {}
    - play:
        urls:
          - 'say:Playing back'
          - '${record_call_url}'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "record_call": {
          "beep": true,
          "direction": "speak"
        }
      },
      {
        "play": {
          "urls": [
            "say:Leave your message now",
            "silence:10"
          ]
        }
      },
      {
        "stop_record_call": {}
      },
      {
        "play": {
          "urls": [
            "say:Playing back",
            "${record_call_url}"
          ]
        }
      }
    ]
  }
}