Latest Legacy

Session recording callback

Configure the “recording callback URL” to receive these events.

SessionRecordingInitiated

Triggered when the first party and the second party are connected via the virtual phone number and the recording begins.
SessionRecordingCompleted

Triggered when one of the parties disconnects the call.
SessionRecordingFailed

Triggered when the record attribute is set to true for a masking session but the recording could not be started.

Recording callback attributes

For each event, the below attributes will be posted to your web server

EventName (string)

Event that triggered this callback. This parameter will have one of the values from the list of events above.
EventTimestamp (string)

Timestamp at which the event occurred.
SessionUUID (string)

Unique ID of the masking session.
FirstParty (string)

The real phone number of the first party used for the interaction.
SecondParty (string)

The real phone number of the second party used for the interaction.
VirtualNumber (string)

The VTS virtual phone number used for the interaction.
RecordingDuration (string)

Duration of recording in seconds.
RecordingEndTime (string)

UTC Timestamp at which the recording ended.
RecordingStartTime (string)

UTC Timestamp at which the recording started.
RecordingFormat (string)

Format of the recording.
RecordingResourceURL (string)

Complete URL path to the recorded file.
RecordingUUID (string)

Unique identifier to identify the file.
SequenceNumber (string)

Indicates the sequence of the callback. Helpful to sort the callback events posted to the recording_callback_url.

Example Request 

1
2
3
4
5

import vts

client = vts.RestClient(auth_id='<auth_id>', auth_token='<auth_token>')
response = client.masking_sessions.delete_masking_session("session_uuid")
print(response)

1
2
3
4
5
6
7
8
9
10
11
12
13

var vts = require('vts');

(function main() {
    'use strict';

    var client = new vts.Client("<auth_id>", "<auth_token>");
    client.maskingSession.deleteMaskingSession("SessionUUID"
    ).then(function (response) {
        console.log(response);
    }, function (err) {
        console.error(err);
    });
})();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<?php
/**
 * Example for Delete Session
 */
require 'vendor/autoload.php';
use vts\RestClient;
use vts\Exceptions\VTSRestException;
$client = new RestClient("<auth_id>", "<auth_token>");
try {
    $response = $client->maskingSessions->deleteMaskingSession(
        'SessionUUID'
    );

    print_r($response);
}
catch (VTSRestException $ex) {
    print_r($ex);
}

1
2

curl -X DELETE "https://api.vtscom.net/v1/Account/{Auth ID}/Masking/Session/abcd-1234-ab12-cd34" \
-H "Content-Type: application/json" \

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

package main

import (
       "fmt"
       "github.com/vts/vts-go/v7"
)

func main() {
       client, err := vts.NewClient("<auth_id>", "<auth_token>", &vts.ClientOptions{})
       if err != nil {
               fmt.Print("Error", err.Error())
               return
       }
       response, err := client.MaskingSession.DeleteMaskingSession("SessionUUID")
       if err != nil {
               fmt.Print("Error", err.Error())
               return
       }
       fmt.Printf("Response: %#v\n", response)
}