Skip to content
/ .. / .. /
Access Recordings and Reports





Access Recordings and Reports

Recordings are accessible as:

  • Execution Context Objects (audio recording steps)

  • Call properties (audio recording compound steps)

Recordings are also accessible as report attachments.

Access Recordings and Reports
Access Recordings from Audio Recording Steps (Execution Context Objects)
Access Recordings from Audio Recording Step Details (Call Properties)
Access Reports

Access Recordings from Audio Recording Steps (Execution Context Objects)

When Voice Call Steps are used to produce audio recordings, they are stored in the ExecutionContextObjects that are accessible by using the recordings key. The value corresponding to this key is a map with:

  • The unique name, specified by the stop audio recording step, as the key.

  • The audio file as the value.

Example

1
2
3
4
5
6
7
8
And start audio recording on A
And after 5 seconds, stop audio recording on A and save as Announcement1

And start audio recording on A
And after 5 seconds, stop audio recording on A and save as Announcement2

And start audio recording on B
And after 5 seconds, stop audio recording on B and save as Voice

The recordings generated from the example above will be stored in the Scenario Execution Context, as:

1
2
3
4
5
executionContext["recordings"] = {
   Announcement1 = rec1.wav,
   Announcement2 = rec2.wav,
   Voice = rec3.wav
}

Access ExecutionContextObjects With Voice Call Step Details

Audio recordings created by the Voice Call Compound Step are be accessible as call properties.

Syntax

1
<call Identifier>.recordings.<phone Identifier>.<window Identifier>

Parameters

  • call_id - The identifier of the call compound step

  • phoneId - The identifier of the phone participating in the call

  • window - The identifier of the recording window

    • One of: dial_to_connect, dial_to_disconnect and connect_to_disconnect

Example

1
2
3
4
    And A starts a call to B as MY_CALL:
      * caller records audio from dial to connect
      * caller records audio from connect to disconnect
      * callee records audio from connect to disconnect

In the example above, three recordings will be created and can be accessed as shown below:

1
2
3
4
5
6
// caller recordings
MY_CALL.recordings.A.dial_to_connect
MY_CALL.recordings.A.connect_to_disconnect

// callee recording
MY_CALL.recordings.B.connect_to_disconnect

Note:

  • If the recordings are accessed before they become available, a relevant error message will be logged and the step trying to access them will fail.

  • If an attempt is made to access the recording before recording has started, the message Unable to retrieve file. Recording has not started. will be printed.

  • If an attempt is made to access the recording while recording, the message Unable to retrieve file. Recording is ongoing. will be printed.

Reports

Audio recordings are accessible as report attachments.

Audio Recording Steps - Report Attachment Syntax

The audio files that have been generated by the audio recordings steps are attached to the report using the unique name provided by the user in the stop audio recording step.

Audio Recording Compound Steps - Report Attachment Syntax

Syntax

1
<call Identifier>_<phone Identifier>_<window Identifier>

Parameters

  • call - The identifier assigned to the compound step voice call

  • phone - The identifier of the phone that recorded the audio

  • window - The identifier of the recording window

    • One of: dial_to_connect, dial_to_disconnect and connect_to_disconnect

Example

1
MYCALL_A_connect_to_disconnect

Note: Because Voice Calls with Step Details have unique callIds, their generated recording names will always be unique.