Professional Documents
Culture Documents
Feature Description
Release 20.0
Document Version 1.5
CallRecordingVideoSupportFD-R200
Market Request Number 148447
Feature Request Numbers 170973, 174268
BroadWorks Guide
Copyright Notice
Copyright 2013 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and
confidential and is considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only.
No part of this publication may be duplicated without the express written permission of
BroadSoft, Inc. 9737 Washingtonian Boulevard, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.
Trademarks
BroadWorks and BroadWorks AssistantEnterprise, BroadWorks Call Center,
BroadWorks Communicator, BroadWorks Receptionist, and BroadWorks
Deployment Studio are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in this document may be trademarks or
registered trademarks of their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
11-BD5812-00
PAGE 2 OF 95
Date
0.1 Draft
Created document.
January 9, 2013
0.2 Draft
0.3 Draft
0.4 Draft
Updated Provisioning Server sections with new systemlevel parameter to control whether video call continues
after call recording failure.
February 6, 2013
0.5 Draft
0.6 Draft
0.7 Draft
0.8 Draft
0.9 Draft
0.10 Draft
March 5, 2013
0.11 Draft
March 5, 2013
0.12 Draft
March 7, 2013
0.13 Draft
March 8, 2013
0.14 Draft
0.15 Draft
Reviewed updates.
0.16 Draft
Reviewed updates.
0.17 Draft
Approved document:
Reviewed updates.
0.19 Draft
0.20 Draft
0.21 Draft
1.0 Approved
Approved document.
1.1
1.2
Edited document.
June 6, 2013
11-BD5812-00
PAGE 3 OF 95
Version
Date
1.3
1.4
1.5
11-BD5812-00
PAGE 4 OF 95
Table of Contents
1
2.1.2
2.1.3
2.1.4
2.1.5
2.1.6
2.1.7
2.1.8
2.1.9
2.3
2.2.2
2.2.3
2.2.4
2.2.5
3.2
3.3
3.4
Configuration Data..................................................................................................................... 56
3.1.1
3.1.2
3.2.2
Summary........................................................................................................................... 57
3.4.2
3.4.3
11-BD5812-00
PAGE 5 OF 95
3.5
Summary........................................................................................................................... 61
3.5.2
Applications/MediaStreaming/Services/Dialog/Security Context................................... 62
3.5.3
Applications/MediaStreaming/Services/IVR Context...................................................... 63
3.5.4
3.5.5
3.5.6
Applications/MediaStreaming/Interfaces/CFW/VideoCodecs Context.......................... 67
3.5.7
3.5.8
Applications/MediaStreaming/Interfaces/MRCP/ASR Context...................................... 69
3.5.9
Summary........................................................................................................................... 74
3.6.2
3.6.3
3.6.4
3.7
3.8
3.9
4.2
4.3
4.4
4.5
5.1.2
11-BD5812-00
PAGE 6 OF 95
5.1.3
5.2
5.3
New Alarms....................................................................................................................... 80
5.2.2
6.2
6.3
6.4
Summary........................................................................................................................... 82
6.3.2
6.3.3
6.3.4
7.2
7.3
8.2
8.3
8.4
8.2.1
8.2.2
8.3.2
8.4.2
8.5
8.6
8.7
Third-Party Software.................................................................................................................. 87
8.8
8.9
8.9.2
8.9.3
11-BD5812-00
PAGE 7 OF 95
9.2
New Time-Outs................................................................................................................. 88
9.1.2
9.2.2
9.3
9.4
9.5
11-BD5812-00
PAGE 8 OF 95
This service introduces an enhancement to the existing Call Recording User service on
BroadWorks by providing the capability to record video in addition to audio. It interfaces
with the Third Party Call Recording platform (3PCR) using SIP to support audio and video
recordings in both single and dual modes. It also interfaces with the BroadWorks Media
Server to enable the streaming of media to the users and the 3PCR platform.
This feature enables support for the recording of three-way and n-way video conferences
in both single and dual modes.
This feature relies on the existing functionality of the Call Recording service that records
audio and does not make any changes to the existing functionality and behavior. The
following figure shows the entities and the interfaces used in recording a call.
Clients
3PCR
Portal
SIP Interface to
provide signaling for
all calls that are to be
recorded
SIP
3PCR
RTP
11-BD5812-00
PAGE 9 OF 95
2.1
2.1.1
Recording Modes
For each of the call recording modes supported, the video recording of the call follows the
existing behavior of audio-only calls when video recording is enabled. No changes are
made by this feature to the behavior for each mode. Therefore, for example:
2.1.2
If the users recording mode is Always, then the Call Recording service automatically
records both audio and video for all calls to the 3PCR platform without the user taking
any action. For any calls that the user originates/receives/joins, the Call Recording
service makes sure that these calls are recorded and saved to the 3PCR platform.
If the users recording mode is On Demand with User Initiated Start, then the video
and audio portions are recorded and paused/resumed according to the existing
functionality.
Recording Behavior
When the call is recorded and for which users in the call it is recorded follows the existing
behavior of audio-only call recordings.
The recording starts after the far-end party answers the call and media negotiation with
both audio and video is completed. A call is considered answered when the far-end party
has sent a 200 OK response to the INVITE message and has received the ACK. Once a
call has been answered, a SIP re-INVITE is sent to both parties to redirect the media
streams to the Media Server for streaming to the Call Recording Server. The call starts
recording after all the media renegotiation completes.
If the 3PCR is already recording video and if the end users in the call make any change to
the video SDP triggering a renegotiation between the users, the 3PCR is also updated
with the changes.
11-BD5812-00
PAGE 10 OF 95
2.1.2.1
2.1.2.2
2.1.2.3
In dual mode, it must support the H.264 and H.263 video codecs and in single mode it
must support H.264 codec.
It must support the same level of resolutions that are offered to it without downgrading
them in the answer.
It must support symmetrical payload numbers, which means that it must respond with
the same payload type number in the answer as in the offer.
The BroadWorks Media Server, which streams the Real-Time Transport Protocol (RTP)
media to the 3PCR platform, does not transcode the video media. It supports transcoding
for audio only. This necessitates that the clients do end-to-end media negotiation first and
the call recording associated renegotiations are all initiated after answer of the call
between the users. Note that to successfully record video, the offer video SDP from the
end user must have at least one video codec format that is supported by the BroadWorks
Media Server.
The following sections describe each of the 3PCR platforms modes and assume that the
call is a two-party call. User A is the originator and User B is the terminator. Note that
only video SDP is described.
2.1.2.3.1
The offer from the Media Server is used as the base SDP, which is filtered to include
only those codecs that were negotiated between User A and User B. From this set,
the codec with the highest preference is selected.
Any fmtp attributes from the SDP of User B associated with the selected codec are
also included.
11-BD5812-00
PAGE 11 OF 95
Any generic video attributes from the SDP of User A are also included. This is the
resulting offer with the label attribute 3 in the SDP sent to 3PCR.
The above three steps are repeated for the SDP of User B and the resulting offer with the
label attribute 4 in the SDP is sent to 3PCR.
This is the video SDP that represents User As and User Bs offer to the 3PCR platform.
SDP to User A and User B
When reconnecting the users for call recording, Users A and B are re-invited by the
BroadWorks Telephony Application Server so that the SDP is streamed through the Media
Server. During the renegotiation, the offer/answer SDP from the Media Server and the
original call between Users A and B is used as the base. The following rules are applied
to arrive at the SDP used in the renegotiation.
Offer to B:
The offer SDP sent to User B is the SDP from the Media Server filtered through the
negotiated SDP from the original call setup with the attributes from SDP B copied as
explained above.
Answer to A:
The answer SDP sent to User A is the answer from the Media Server with the attributes
from the answered SDP User B copied, as explained above.
An example of a video call recording being set up between Users A and B, which shows
the rules described above being applied to the SDP, is described in section 2.1.15.2 Basic
Video Call Recording in Dual Mode.
2.1.2.3.2
11-BD5812-00
PAGE 12 OF 95
2.1.3
2.1.3.1
2.1.4
If in single mode, then two streams are sent, one for audio and one for video. Each of
the streams has all of the participants mixed into a single stream for audio and a
single stream for video.
If in dual mode, then four streams are sent. One stream contains the audio and
another stream contains the video from the user recording the call. Also, another
stream contains the audio, with another video that is sent to the user recording the
call.
Metadata Updates
The BroadWorks Telephony Application Server can send updates to the 3PCR platform if
information in the call recording changes. The updated metadata can be received in an
UPDATE or INVITE message. All of the existing scenarios that send metadata updates
as defined for audio-only calls are also applicable for calls that include video. Only those
cases that also trigger metadata updates due to video are specified here. In general, any
time there is a change in the SDP of the sessions that involve video, the 3PCR is updated
with the changes.
Some typical cases of metadata updates that are triggered specifically for video calls are
as follows:
11-BD5812-00
PAGE 13 OF 95
2.1.5
Subscriber with the Call Recording service is in an audio-only call with recording in
progress and then adds video in the middle of the session. The 3PCR is re-invited to
add video to the session. This applies to various call topologies such as two-party
calls, three-way conference, and n-way conferences.
If the video sessions fail to set up with the Media Server for any reason and the
3PCR sessions are set up with video prior to the failure, then 3PCR is re-invited to
remove video from the session.
If the video session renegotiations fail between the clients for any reason and the
3PCR sessions are set up with video prior to the failure, then 3PCR is re-invited to
remove video from the session.
Subscriber with the Call Recording service is in a video call with recording in progress
and then removes video in the middle of the session. The 3PCR is re-invited to
remove video from the session.
2.1.6
11-BD5812-00
PAGE 14 OF 95
Note that video conferences on the Media Server only support H264. For more
information on the Media Server video conference support, see the Video Conferencing
Support Feature Description [4].
2.1.7
2.1.8
2.1.9
Video Conference
Call recording for three-way and n-way conference calls behaves similar to calls with only
audio except that video is also recorded if the video codec negotiations between the end
users, the Media Server, and the 3PCR platform are successful. If the video negotiations
fail, then only the audio portion may be recorded depending on the configuration settings.
If the user being recorded downgrades from an audio/video stream to an audio-only
stream, the 3PCR is first put on hold while reconnections are made with the Media Server
and then it is re-invited with an updated SDP to indicate the removal of the video streams.
If the conference being recorded downgrades from audio/video stream to an audio-only
stream, the 3PCR is similarly updated with the changes.
To illustrate the above scenario, assume the following:
User A has the Call Recording service and sets up an audio/video conference call
between Users B, C, and D. Users A and C are sending audio and video. Users B
and D are sending only audio.
Note that putting the 3PCR on hold while reconnecting to update the SDP may cause a
pause in the recording; however, this is not included here as it is not expected to be a
significant pause.
The following are the results:
1)
Call between User A and User B Contains the audio between User A and User B
prior to the conference, and then after the conference starts, it contains the audio with
video on the bridge. After two minutes, the recording has audio from User A and
audio from the bridge. After two more minutes, the recording only contains audio.
Then after one minute, the recording has audio from User A and audio/video from the
bridge.
11-BD5812-00
PAGE 15 OF 95
2)
Call between User A and User C Contains the audio with video between User A and
User C prior to the conference, and then after the conference starts, it contains the
audio with video on the bridge. After two minutes, the recording has audio from User
A and audio from the bridge. After two more minutes, the recording stops.
3)
Call between User A and User D Contains the audio between User A and User D
prior to the conference, and then after the conference starts, it contains the audio with
video on the bridge. After two minutes, the recording has audio from User A and
audio from the bridge. After two more minutes, the recording only contains audio.
Then after one minute, the recording has audio from User A and audio/video from the
bridge.
A conference can start out with all participants using audio only and then upgrade to video
if any of the conference participants add video. In this situation, if the call recording is
active for the users, their sessions with the 3PCR are renegotiated to add video so that
video can also be recorded.
There are no changes to how call recording behaves for adding or removing participants
from the audio-only conferences.
Call recording manages Meet-Me conferences similar to how it manages a two-party call,
and as a result, the video recording behavior follows that of a two-party video call.
For a call flow describing a three-way conference, see section 2.1.15.7 Video
Conferencing. For video SDP negotiation failure handling, see section 2.1.15.10 Failure
Cases.
For information on the actual display of video for the conference call, see the Video
Conferencing Support Feature Description [4].
2.1.10 Call Park
The Call Park service allows a user to park a call and then retrieve the call at a later time.
The interaction of the Call Recording service with Call Park for video calls is the same as
that of audio-only calls except that video is also recorded.
2.1.11 Call Transfer
The interaction of the Call Recording service with blind transfer and consultative transfer
for video calls is the same as that of audio-only calls except that video is also recorded.
For a call flow describing blind transfer, see section 2.1.15.8 Blind Transfer.
For a call flow describing consultative transfer, see section 2.1.15.9 Consultative Transfer.
2.1.12 Virtual Subscriber Services
The Call Recording service can be assigned to some virtual users, namely call centers,
route points, and Auto Attendants. This section covers interactions of Call Recording with
virtual subscriber services with video involved in the calls.
2.1.12.1 Auto Attendant
The Call Recording service records the interactions of a caller with the Auto Attendant.
The recording starts shortly after the Auto Attendant answers the call. If the Auto
Attendant is video-capable, then the video and audio portions of the call are recorded.
The recording of the interaction with the Auto Attendant stops when the Auto Attendant
transfers the call to the final destination. Once the call is transferred, a new call recording
may start, but it is dependent on the subscriber, device, or service to which the call is
transferred.
CALL RECORDING VIDEO SUPPORT
11-BD5812-00
PAGE 16 OF 95
If the supportVideoRecording parameter is changed, it does not affect the state of any
call recording sessions already in progress. The changes are only applied to new call
recording sessions once the change takes effect on the Application Server.
Video SDP negotiations with the 3PCR platform or the Media Server may fail.
The renegotiation of video SDP with the end users may fail.
The behavior of the BroadWorks Telephony Application Server when a failure to record
occurs is dictated by the system-level parameters continueCallAfterVideoRecordingFailure
for video and continueCallAfterRecordingFailure for audio. Note that these parameters
are only valid in the Always or Always with Pause/Resume modes.
CALL RECORDING VIDEO SUPPORT
11-BD5812-00
PAGE 17 OF 95
continueCallAfterRecordingFailure = true
When this option is enabled, the continueCallAfterVideoRecordingFailure is ignored.
Any call recording failure, be it audio or video, results in the call continuing between
the end users.
Failure to successfully negotiate video with the 3PCR platform or the Media
Server
Audio streams are recorded. The video is streamed between the users but is not
recorded.
Failure to successfully negotiate audio and video with the 3PCR platform or the
Media Server
The call is continued between the users and media and is streamed directly
between them.
If video negotiation fails at any point in the setup sequence, the audio streams are
recorded and the call continues.
If audio negotiation fails at the 3PCR, Media Server, or users, the call is
terminated.
If the call is rejected entirely by either the Media Server or 3PCR, the call between
the users is terminated as well.
The end users negotiate end-to-end and establish the call with audio and video
successfully.
The BroadWorks Telephony Application Server negotiates with the 3PCR with a
filtered list of codecs based on the offer/answer of the end users and the Media
Server.
The BroadWorks Telephony Application Server then reconnects the end users
through the Media Server.
11-BD5812-00
PAGE 18 OF 95
If there are any changes in the call topology or SDP, the BroadWorks Telephony
Application Server may either send updates or renegotiate with the 3PCR.
2.1.15.1 Messaging Between BroadWorks Telephony Application Server and 3PCR Platform to
Show Metadata
The following messages show the format of the SDP and the metadata sent to the 3PCR
platform for calls with audio and video. Note that the changes due to video are highlighted
in bold.
Application Server to 3PCR platform
INVITE sip:3PCR@recorder.broadsoft.com:5060;user=phone SIP/2.0
Via: SIP/2.0/UDP 10.16.134.101;branch=z9hG4bK26f33f26931B5DED
From: <sip:as1.broadsoft.com>;tag=B6CB9EB1-8AE7B75C
To: sip:3PCR@recorder.broadsoft.com
Call-ID:BW153311499010488569905@10.16.134.17
CSeq:25 INVITE
Contact:<sip:as1.broadsoft.com:5060>;src
Supported:100rel
Recv-Info:
Allow:ACK,BYE,CANCEL,INFO,INVITE,OPTIONS,PRACK,REFER,NOTIFY,UPDATE
Accept:application/media_control+xml,application/sdp,multipart/mixed
Max-Forwards:10
Content-Type: multipart/mixed;boundary=deew341adf13412ferwadq
Content-Length: ...
-- deew341adf13412ferwadq
Content-Type: application/sdp
v=0
o=BroadWorks 783 1 IN IP4 10.16.120.22
s=c=IN IP4 10.16.120.22
t=0 0
m=audio 25980 RTP/AVP 0 8 18 96 9 2 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:18 G729/8000
a=rtpmap:96 AMR/8000
a=rtpmap:9 G722/8000
a=rtpmap:2 G726-32/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=ptime:20
a=sendonly
a=label:1
m=video 25978 RTP/AVP 104
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=sendOnly
a=label:3
m=audio 26042 RTP/AVP 0 8 18 96 9 2 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:18 G729/8000
a=rtpmap:96 AMR/8000
a=rtpmap:9 G722/8000
a=rtpmap:2 G726-32/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
CALL RECORDING VIDEO SUPPORT
11-BD5812-00
PAGE 19 OF 95
a=ptime:20
a=sendonly
a=label:2
m=video 26040 RTP/AVP 104 b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=sendOnly
a=label:4
-- deew341adf13412ferwadq
Content-Type: application/rs-metadata+xml
Content-Disposition: recording-session
<?xml version="1.0" encoding="UTF-8"?>
<recording-metadata xmlns="urn:ietf:params:xml:ns:recording"
id="urn:uuid:34512345-6743-6248-9043897645ab">
<dataMode>complete</dataMode>
<recording id="urn:uuid:894134ab-9800-7844-4456-789451125647">
<requestor>src</requestor>
</recording>
<group id="urn:uuid:abc12785-4788-6654-5455-45def4522375"
recording="urn:uuid:894134ab-9800-7844-4456-789451125647"/>
<session id="urn:uuid:78554655-7844-5564-4568-ef4566246875"
group="urn:uuid:abc12785-4788-6654-5455-45def4522375">
</session>
<participant id="urn:uuid:e0471d38-e2eb-46a2-b486-47cfeda8a45a"
session="urn:uuid: 78554655-7844-5564-4568-ef4566246875">
<aor> north02@rtx.broadsoft.com </aor>
<send>
<id>urn:uuid: 94dwif31-9887-341d-12id-789945621002</id>
</send>
<send>
<id>urn:uuid: 94dwif31-9887-341d-12id-789945621003</id>
</send>
</participant>
<participant id="urn:uuid:e0471d38-e2eb-46a2-b486-47cfeda8a45a"
session="urn:uuid: 78554655-7844-5564-4568-ef4566246875">
<aor> north03@rtx.broadsoft.com </aor>
<send>
<id>urn:uuid: 34123561-7789-341d-12id-78edcaf78945</id>
</send>
<send>
<id>urn:uuid: 34123561-7789-341d-12id-78edcaf78946</id>
</send>
</participant>
<stream id="urn:uuid:94dwif31-9887-341d-12id-789945621002"
session="urn:uuid:78554655-7844-5564-4568-ef4566246875">
<label>1</label>
<mode>mixed</mode>
</stream>
<stream id="urn:uuid:94dwif31-9887-341d-12id-789945621003"
session="urn:uuid:78554655-7844-5564-4568-ef4566246875">
<label>2</label>
<mode>mixed</mode>
</stream>
<stream id="urn:uuid:34123561-7789-341d-12id-78edcaf78945"
session="urn:uuid:78554655-7844-5564-4568-ef4566246875">
<label>3</label>
<mode>mixed</mode>
</stream>
CALL RECORDING VIDEO SUPPORT
11-BD5812-00
PAGE 20 OF 95
<stream id="urn:uuid:34123561-7789-341d-12id-78edcaf78946"
session="urn:uuid:78554655-7844-5564-4568-ef4566246875">
<label>4</label>
<mode>mixed</mode>
</stream>
<extensionData id="urn:uuid:ef45678456-4451-4568-7785-400554586487"
parent="urn:uuid:78554655-7844-5564-4568-ef4566246875">
<broadWorksRecordingMetadata
xmlns="http://schema.broadsoft.com/broadworksCallRecording"
schemaRev="1.0"
xsi:schemaLocation="http://schema.broadsoft.com/broadworksCallRecording"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<extTrackingID>4:1</extTrackingID>
<serviceProviderID>TxASDev</serviceProviderID>
<groupID>North_as90</groupID>
<userID>north02@rtx.broadsoft.com</userID>
<callID> BW153311411129885@10.16.134.17</callID>
<callType>
<origCall>
<callingPartyNumber>north03@broadsoft.com</callingPartyNumber>
<calledPartyNumber>2146415689</calledPartyNumber>
<dialedDigits>2145551212</dialedDigits>
</origCall>
</callType>
<recordingType>demand</recordingType>
</broadWorksRecordingMetadata>
</extensionData>
</recording-metadata>
-- deew341adf13412ferwadq
11-BD5812-00
PAGE 21 OF 95
11-BD5812-00
PAGE 22 OF 95
11-BD5812-00
PAGE 23 OF 95
11-BD5812-00
PAGE 24 OF 95
a=rtpmap:34 H263/90000
a=fmtp:34 QCIF=1;SQCIF=1
11-BD5812-00
PAGE 25 OF 95
11-BD5812-00
PAGE 26 OF 95
a=sendonly
a=label:2
m=video 26040 RTP/AVP 104
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=sendOnly
a=label:4
11-BD5812-00
PAGE 27 OF 95
11-BD5812-00
PAGE 28 OF 95
11-BD5812-00
PAGE 29 OF 95
a=rtpmap:8 PCMA/8000
a=rtpmap:18 G729/8000
a=rtpmap:96 AMR/8000
a=rtpmap:9 G722/8000
a=rtpmap:2 G726-32/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=ptime:20
m=video 26044 RTP/AVP 104
b=AS:512
a=sendrecv
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
11-BD5812-00
PAGE 30 OF 95
a=fmtp:101 0-15
a=ptime:20
m=video 26036 RTP/AVP 109
b=AS:512
a=sendrecv
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00D; packetization-mode=0
11-BD5812-00
PAGE 31 OF 95
11-BD5812-00
PAGE 32 OF 95
11-BD5812-00
PAGE 33 OF 95
11-BD5812-00
PAGE 34 OF 95
11-BD5812-00
PAGE 35 OF 95
11-BD5812-00
PAGE 36 OF 95
11-BD5812-00
PAGE 37 OF 95
11-BD5812-00
PAGE 38 OF 95
11-BD5812-00
PAGE 39 OF 95
11-BD5812-00
PAGE 40 OF 95
11-BD5812-00
PAGE 41 OF 95
11-BD5812-00
PAGE 42 OF 95
11-BD5812-00
PAGE 43 OF 95
11-BD5812-00
PAGE 44 OF 95
11-BD5812-00
PAGE 45 OF 95
11-BD5812-00
PAGE 46 OF 95
11-BD5812-00
PAGE 47 OF 95
11-BD5812-00
PAGE 48 OF 95
11-BD5812-00
PAGE 49 OF 95
11-BD5812-00
PAGE 50 OF 95
11-BD5812-00
PAGE 51 OF 95
2.1.15.10.3 Failure to Successfully Negotiate Audio and Video with 3PCR Platform
The call recording parameters, continueCallAfterVideoRecordingFailure and
continueCallAfterRecordingFailure, are set to true. The video and audio negotiation with
the 3PCR platform fails and the resulting call recording behavior is such that the call is
continued between the users and the media is streamed directly between them.
11-BD5812-00
PAGE 52 OF 95
2.1.15.10.4 Failure to Successfully Negotiate Audio and Video with Media Server
The call recording parameters, continueCallAfterVideoRecordingFailure and
continueCallAfterRecordingFailure, are set to true. The video and audio negotiation with
the Media Server fails and the resulting call recording behavior is such that the call is
continued between the users and the media is streamed directly between them.
11-BD5812-00
PAGE 53 OF 95
2.1.16 Logging
A new logging input channel is introduced on the Media Server. The videostreammixerbe
input channel captures logs generated by the video relay process.
2.2
2.2.1
2.2.2
2.2.3
2.2.4
1)
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
4)
The audio and video portions of the entire call are automatically recorded and saved
to the 3PCR platform without any user interaction.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
4)
The user adds video by re-inviting the other user and the re-invite transaction
completes successfully between the clients. Now both the users are streaming video.
5)
6)
The 3PCR platform is offered the new SDP to add video and updated metadata.
7)
8)
The existing call recording continues with audio and video from the call.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
4)
5)
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
4)
The Auto Attendant plays a video announcement and then transfers the call to
another user who streams video as well.
11-BD5812-00
PAGE 54 OF 95
2.2.5
2.3
5)
The first call recording captures both audio and video between the user and the Auto
Attendant.
6)
The second call recording captures the audio and video between the two users.
2)
User A is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
User A terminates the call to User B. They use a video codec (for example, H263)
not supported by the 3PCR platform.
4)
The Call Recording service re-invites the 3PCR with the negotiated codec (H263).
The 3PCR accepts the audio codec but rejects the video.
5)
The video continues to be streamed between the users and only audio is recorded.
Provisioning Steps
Following are the feature provisioning steps:
2.4
To determine whether a call recording for a video call is supported, provision the
system-level supportVideoRec recording platform parameter.
11-BD5812-00
PAGE 55 OF 95
Provisioning Impacts
3.1
Configuration Data
3.1.1
Name
supportVideoRec
3.1.2
Field Type
Required?
Validation
Values
Default Value
Boolean
Yes
True, False
False
Name
Field Type
Required?
Validation
Values
Default Value
continueCallAfterVideoRecordingFailure
Boolean
Yes
True, False
True
3.2
3.2.1
Data Types
There is no impact.
3.2.2
3.2.2.1
3.2.2.1.1
videoCodecs
Collection keys: type
Name
Type
Content
restrictions
Type
String
h264,
h263-1998,
h263-2000
3.2.2.2
Default
Value
Description
This
parameter
specifies the
video codec
type.
11-BD5812-00
PAGE 56 OF 95
3.3
3.4
3.4.1
Level
Commands
CallRecording
get
set
Platform
get
add
set
CallRecording
Platform
3.4.2
CallRecording/Platform Context
1)
AS_CLI/Service/CallRecording/Platform/get
Command Format:
get
Example:
11-BD5812-00
PAGE 57 OF 95
$ AS_CLI/Service/CallRecording/Platform>get
System default Call Recording platform = dualTest
Name
Net Address
Port Transport Type Media Stream Schema Version Support Video Rec
Description
==============================================================================================
dualTest
15.16.57.11 5070 Unspecified
dual
2.0
true
desktop dual
singleTest
15.16.5.27
5080 Unspecified
single
1.0
false
desktop single sipp
2)
AS_CLI/Service/CallRecording/Platform/add
Command Format:
add
Add
<name>, String {1 to 80 characters}
<netAddress>, IP address | host | domain (1 to 80
chars)
<port>, Integer {1 to 65535}
<transportType>, Choice = {udp, tcp, unspecified}
<mediaStream>, Choice = {dual, single}
<schemaVersion>, Choice = {1.0, 2.0}
<supportVideoRecording>, Choice = {false, true}
[<attribute>, Multiple Choice = {description}]
<description>, String (1 to 80 characters)
Example:
$ AS_CLI/Service/CallRecording/Platform>add
dualTest 15.16.57.11 5070 unspecified dual 2.0
true description desktop dual sipp script
Done
11-BD5812-00
PAGE 58 OF 95
3)
AS_CLI/Service/CallRecording/Platform/set
Command Format:
set
set
<name>, String {1 to 80 characters}
<attribute>, Multiple Choice = {netAddress, port, transportType,
mediaStream, systemDefault, schemaVersion, supportVideoRecording,
description}
<netAddress>, IP address | host | domain (1 to
80 chars)
<port>, Integer {1 to 65535}
<transportType>, Choice = {udp, tcp,
unspecified}
<mediaStream>, Choice = {dual, single}
<systemDefault>, String = true
<schemaVersion>, Choice = {1.0, 2.0}
<supportVideoRecording>, Choice = {false,
true}
<description>, String (1 to 80 characters)
Example:
$ AS_CLI/Service/CallRecording/Platform>set
dualTest supportVideoRecording true
Done
3.4.3
AS_CLI/Service/CallRecording/get
Command Format:
get
11-BD5812-00
PAGE 59 OF 95
Example:
$ AS_CLI/Service/CallRecording>get
continueCallAfterRecordingFailure = false
maxConsecutiveFailures = 1
maxResponseWaitTimeMilliseconds = 3000
refreshPeriodSeconds = 10
continueCallAfterVideoRecordingFailure = false
2)
AS_CLI/Service/CallRecording/set
Command Format:
set
set
<attribute>, Multiple Choice = {
continueCallAfterRecordingFailure, refreshPeriodSeconds,
maxConsecutiveFailures, maxResponseWaitTimeMilliSeconds,
continueCallAfterVideoRecordingFailure}
<continueCallAfterRecordingFailure>, Choice = {false, true}
<maxConsecutiveFailures>, Integer = {1 to 10}
<maxResponseWaitTimeMilliseconds>, Integer = {100 to
10000}
<refreshPeriodSeconds>, Integer = {10 to 300}
<continueCallAfterVideoRecordingFailure>, Choice = {false,
true}
Example:
$ AS_CLI/Service/CallRecording> set
continueCallAfterVideoRecordingFailure false
...Done
11-BD5812-00
PAGE 60 OF 95
3.5
3.5.1
Level
Commands
Security
get
set
IVR
get
set
Conferencing
get
set
CFW
get
set
VideoCodecs
get
add
delete
SIP
get
set
ASR
get
set
TTS
get
set
GeneralSettings
get
set
MediaStreaming
Services
Dialog
Security
IVR
Conferencing
Interfaces
CFW
VideoCodecs
SIP
MRCP
ASR
TTS
GeneralSettings
Figure 26 MS_CLI Call Recording Platform Changes
11-BD5812-00
PAGE 61 OF 95
3.5.2
Applications/MediaStreaming/Services/Dialog/Security Context
1)
MS_CLI/Applications/MediaStreaming/Services/Dialog/Security/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Services/Dialog/Security > get
maxVxmlTransitionCount = 100
maxHttpPostCount = 25
maxHttpGetCount = 25
maxHttpGetTimeoutInSeconds = 6
maxDownloadedSizeInMB = 50
maxRecordedSizeInMB = 300
maxDepthOfEcmaScriptRecursion = 10
maxDepthOfSubDialogRecursion = 10
2)
MS_CLI/Applications/MediaStreaming/Services/Dialog/Security/set
Command Format:
set
Set
<attribute>, Multiple Choice = {maxVxmlTransitionCount,
maxHttpPostCount, maxHttpGetCount,
maxHttpGetTimeoutInSeconds, maxDownloadedSizeInMB,
maxRecordedSizeInMB, maxDepthOfEcmaScriptRecursion,
maxDepthOfSubDialogRecursion}
<maxVxmlTransitionCount>, Integer {1 to 1000}
<maxHttpPostCount>, Integer {1 to 1000}
<maxHttpGetCount>, Integer {1 to 1000}
<maxHttpGetTimeoutInSeconds>, Integer {1 to 120}
<maxDownloadedSizeInMB>, Integer {1 to 100}
<maxRecordedSizeInMB>, Integer {1 to 600}
<maxDepthOfEcmaScriptRecursion>, Integer {1 to 100}
<maxDepthOfSubDialogRecursion>, Integer {1 to 100}
11-BD5812-00
PAGE 62 OF 95
Example:
$MS_CLI/Applications/MediaStreaming/Services/Dialog/Security > set
maxHttpGetTimeoutInSeconds 6
...Done
3.5.3
Applications/MediaStreaming/Services/IVR Context
1)
MS_CLI/Applications/MediaStreaming/Services/IVR/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Services/IVR> get
ivrResourcesRatio = 75
memorySizeInMB =
audioDbUserId =
audioDbPassword =
intraFrameRestartTimeoutInMilliseconds = 500
2)
MS_CLI/Applications/MediaStreaming/Services/IVR/set
Command Format:
11-BD5812-00
PAGE 63 OF 95
set
set
<attribute>, Multiple Choice = {ivrResourcesRatio,
memorySizeInMB, audioDbUserId, audioDbPassword,
intraFrameRestartTimeoutInMilliseconds}
<ivrResourcesRatio>, Integer {5 to 95}
<memorySizeInMB>, Integer {1 to 100000}
<audioDbUserId>, String {0 to 255 characters}
<audioDbPassword>, String {0 to 255 characters}
<intraFrameRestartTimeoutInMilliseconds>, Integer {0 to 500}
Example:
$MS_CLI/Applications/MediaStreaming/Services/IVR > set memorySizeInMB
500
...Done
3.5.4
Applications/MediaStreaming/Services/Conferencing Context
1)
MS_CLI/Applications/MediaStreaming/Services/Conferencing/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Services/Conferencing > get
jitterBufferSizeInMilliseconds = 60
11-BD5812-00
PAGE 64 OF 95
2)
MS_CLI/Applications/MediaStreaming/Services/Conferencing/set
Command Format:
set
set
<attribute>, Multiple Choice =
{jitterBufferSizeInMilliseconds}
<jitterBufferSizeInMilliseconds>, Integer {20 to 160}
Example:
$MS_CLI/Applications/MediaStreaming/Services/Conferencing > set
jitterBufferSizeInMilliseconds 80
...Done
3.5.5
Applications/MediaStreaming/Interfaces/CFW Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/get
Command Format:
get
Example:
11-BD5812-00
PAGE 65 OF 95
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW> g
listeningPort = 7575
enableCfw = true
enableStrictMscIvrValidation = false
enableStrictMscMixerValidation = false
enableStrictSrgsValidation = false
maxRecordingSizeInMB = 200
activeTalkerEnergyWindowInMilliseconds = 500
activeTalkerEnergyThreshold = 50
2)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/set
Command Format:
set
set
<attribute>, Multiple Choice = {listeningPort,
enableCfw, enableStrictMscIvrValidation,
enableStrictMscMixerValidation,
enableStrictSrgsValidation,
maxRecordingSizeInMB,
activeTalkerEnergyWindowInMilliseconds,
activeTalkerEnergyThreshold}
<listeningPort>, Integer {1024 to 65535}
<enableCfw>, Choice = {false, true}
<enableStrictMscIvrValidation>, Choice = {false, true}
<enableStrictMscMixerValidation>, Choice = {false, true}
<enableStrictSrgsValidation>, Choice = {false, true}
<maxRecordingSizeInMB>, Integer {5 to 1000}
<activeTalkerEnergyWindowInMilliseconds>, Integer {20 to 5000}
<activeTalkerEnergyThreshold>, Integer {1 to 1000}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW> set
maxRecordingSizeInMB 500
...Done
11-BD5812-00
PAGE 66 OF 95
3.5.6
Applications/MediaStreaming/Interfaces/CFW/VideoCodecs Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs> get
Type
===========
h264
h263-1998
2 entries found.
2)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs/add
Command Format:
add
add
<type>, Choice = {h263-1998, h263-2000, h264}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs> add h264
...Done
11-BD5812-00
PAGE 67 OF 95
3)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs/delete
Command Format:
delete
delete
<type>, Choice = {h263-1998, h263-2000, h264}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs> delete
h263-1998
...Done
3.5.7
Applications/MediaStreaming/Interfaces/SIP Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/SIP/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/SIP> get
listeningPort = 5060
retransmissionDelay200OKInMilliseconds = 500
maxRetransmission200OK = 3
t1 = 500
t2 = 4000
supportTCP = false
acceptDTMFRelay = false
routeAdvanceTimeoutInSeconds = 5
CALL RECORDING VIDEO SUPPORT
11-BD5812-00
PAGE 68 OF 95
2)
MS_CLI/Applications/MediaStreaming/Interfaces/SIP/set
Command Format:
set
set
<attribute>, Multiple Choice = {listeningPort,
retransmissionDelay200OKInMilliseconds,
maxRetransmission200OK,
t1, t2, supportTCP, acceptDTMFRelay,
routeAdvanceTimeoutInSeconds}
<listeningPort>, Integer {1024 to 65535}
<retransmissionDelay200OKInseconds>, Integer {100 to
10000}
<maxRetransmission200OK>, Integer {0 to 20}
<t1>, Choice = {500, 1000, 2000, 5000, 7000, 9000}
<t2>, Choice = {4000, 6000, 8000, 10000}
<supportTCP>, Choice = {false, true}
<acceptDTMFRelay>, Choice = {false, true}
<routeAdvanceTimeoutInSeconds>, Integer {0 to 64}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/SIP> set
routeAdvanceTimeoutInSeconds 2
*** Warning: Broadworks needs to be restarted for the changes to take
effect ***
3.5.8
Applications/MediaStreaming/Interfaces/MRCP/ASR Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR/get
Command Format:
get
11-BD5812-00
PAGE 69 OF 95
This command is used to view the current Media Resource Control Protocol
(MRCP) session parameters that are used to communicate with the
Automated Speech Recognition (ASR) server
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR> get
channelType = TCP
sessionAuditPeriodInSeconds = 60
sessionAuditTimeoutInSeconds = 10
vendor = default
2)
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR/set
Command Format:
set
Set
<attribute>, Multiple Choice = {channelType,
sessionAuditPeriodInSeconds,
sessionAuditTimeoutInSeconds,
vendor}
<channelType>, Choice = {TCP, TLS}
<sessionAuditPeriodInSeconds>, Integer {0 to 600}
<sessionAuditTimeoutInSeconds>, Integer {0 to 600}
<vendor>, Choice = {default, lumenvox, loquendo}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR> set
sessionAuditTimeoutInSeconds 2
...Done
3.5.9
Applications/MediaStreaming/Interfaces/MRCP/TTS Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS/get
11-BD5812-00
PAGE 70 OF 95
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS> get
channelType = TCP
sessionAuditPeriodInSeconds = 60
sessionAuditTimeoutInSeconds = 10
speakerProfile =
fetchHint = none
vendor = default
2)
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS/set
Command Format:
set
set
<attribute>, Multiple Choice = {channelType,
sessionAuditPeriodInSeconds,
sessionAuditTimeoutInSeconds,
speakerProfile, fetchHint, vendor}
<channelType>, Choice = {TCP, TLS}
<sessionAuditPeriodInSeconds>, Integer {0 to 600}
<sessionAuditTimeoutInSeconds>, Integer {0 to 600}
<speakerProfile>, String {0 to 255 characters}
<fetchHint>, Choice = {none, prefetch, safe}
<vendor>, Choice = {default, loquendo, nuance_v8,
nuance_v9}
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS> set
sessionAuditTimeoutInSeconds 2
...Done
11-BD5812-00
PAGE 71 OF 95
MS_CLI/Applications/MediaStreaming/GeneralSettings/get
Command Format:
get
Example:
$MS_CLI/Applications/MediaStreaming/GeneralSettings> get
smtpTimeoutInSeconds = 30
mxRecordLookup = false
maxCacheFiles = 50
numAudioProcesses =
numVideoProcesses =
recycleHttpConnections = true
offerSdpIpAddressType = ipv4
httpTimeoutInSeconds = 30
2)
MS_CLI/Applications/MediaStreaming/GeneralSettings/set
Command Format:
Set
Set
<attribute>, Multiple Choice = {smtpTimeoutInSeconds,
mxRecordLookup, maxCacheFiles, numAudioProcesses,
numVideoProcesses, recycleHttpConnections,
offerSdpIpAddressType, httpTimeoutInSeconds}
<smtpTimeoutInSeconds>, Integer {0 to 180}
<mxRecordLookup>, Choice = {false, true}
<maxCacheFiles>, Integer {1 to 999}
<numAudioProcesses>, Integer {3 to 4}
<numVideoProcesses>, Integer {0 to 4}
<recycleHttpConnections>, Choice = {false, true}
<offerSdpIpAddressType>, Choice = {ipv4, ipv6,
altcIpv4Legacy}
<httpTimeoutInSeconds>, Integer {1 to 600}
11-BD5812-00
PAGE 72 OF 95
Example:
$MS_CLI/Applications/MediaStreaming/GeneralSettings> set
httpTimeoutInSeconds 2
...Done
11-BD5812-00
PAGE 73 OF 95
3.6
3.6.1
Summary
The following new command has been added:
SystemCallRecordingAddPlatformRequest20
SystemCallRecordingGetPlatformListRequest
SystemCallRecordingModifyPlatformRequest
SystemCallRecordingGetRequest
SystemCallRecordingModifyRequest
3.6.2
3.6.2.1
SystemCallRecordingAddPlatformRequest19
Command Impacts
SystemCallRecordingGetPlatformListRequest
Authorization level: Group
XML Schema file: OCISchemaServiceCallRecording.xsd
<xs:complexType name="SystemCallRecordingGetPlatformListRequest">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Get list of Call Recording platforms.
The response is either SystemCallRecordingGetPlatformListResponse or
ErrorResponse.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIRequest">
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SystemCallRecordingGetPlatformListResponse">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Response to SystemCallRecordingGetPlatformListRequest.
Contains the default system Call Recording platform and a table with
columns headings "Name", "Net Address", "Port", "Transport Type",
"Media Stream", "Description", "Schema Version", "Support Video Rec".
The system default recording platform also appears in the table
with the other platforms.
The possible values for Support Video Rec can be either true or
false.
11-BD5812-00
PAGE 74 OF 95
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIDataResponse">
<xs:sequence>
<xs:element name="systemDefault" type="CallRecordingPlatformName"
minOccurs="0"/>
<xs:element name="callRecordingPlatformTable" type="core:OCITable"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
3.6.2.2
SystemCallRecordingAddPlatformRequest20
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
<xs:complexType name="SystemCallRecordingAddPlatformRequest20">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Add a Call Recording platform.
The response is either a SuccessResponse or an ErrorResponse.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIRequest">
<xs:sequence>
<xs:element name="name" type="CallRecordingPlatformName"/>
<xs:element name="netAddress" type="NetAddress"/>
<xs:element name="port" type="Port"/>
<xs:element name="mediaStream" type="MediaStream"/>
<xs:element name="transportType" type="TransportProtocol"/>
<xs:element name="description"
type="CallRecordingPlatformDescription" minOccurs="0"/>
<xs:element name="schemaVersion"
type="CallRecordingPlatformSchemaVersion"/>
<xs:element name="supportVideoRecording" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
3.6.2.3
SystemCallRecordingModifyPlatformRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
<xs:complexType name="SystemCallRecordingModifyPlatformRequest">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Modify the specified Call Recording platform.
The response is either a SuccessResponse or an ErrorResponse.
11-BD5812-00
PAGE 75 OF 95
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIRequest">
<xs:sequence>
<xs:element name="name" type="CallRecordingPlatformName"/>
<xs:element name="netAddress" type="NetAddress" minOccurs="0"/>
<xs:element name="port" type="Port" minOccurs="0"/>
<xs:element name="mediaStream" type="MediaStream" minOccurs="0"/>
<xs:element name="becomeSystemDefault" type="xs:boolean"
fixed="true" minOccurs="0"/>
<xs:element name="transportType" type="TransportProtocol"
minOccurs="0"/>
<xs:element name="description"
type="CallRecordingPlatformDescription" minOccurs="0"
nillable="true"/>
<xs:element name="schemaVersion"
type="CallRecordingPlatformSchemaVersion" minOccurs="0"/>
<xs:element name="supportVideoRecording" type="xs:boolean"
minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
3.6.2.4
SystemCallRecordingGetRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
<xs:complexType name="SystemCallRecordingGetRequest">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Request the system level data associated with Call Recording.
The response is either a SystemCallRecordingGetResponse or an
ErrorResponse.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIRequest">
<xs:sequence>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SystemCallRecordingGetResponse">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Response to SystemCallRecordingGetRequest.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIDataResponse">
<xs:sequence>
<xs:element name="continueCallAfterRecordingFailure" type="xs:boolean"/>
<xs:element name="refreshPeriodSeconds"
11-BD5812-00
PAGE 76 OF 95
type="RecordingRefreshPeriodSeconds"/>
<xs:element name="maxConsecutiveFailures"
type="RecordingMaxConsecutiveFailures"/>
<xs:element name="maxResponseWaitTimeMilliseconds"
type="RecordingMaxResponseWaitTimeMilliseconds"/>
<xs:element name=continueCallAfterVideoRecordingFailure"
type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
3.6.2.5
SystemCallRecordingModifyRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
<xs:complexType name="SystemCallRecordingModifyRequest">
<xs:annotation>
<xs:appinfo>
<asDataModeSupported>true</asDataModeSupported>
<hssDataModeSupported>false</hssDataModeSupported>
</xs:appinfo>
<xs:documentation>
Modify the system level data associated with Call Recording.
The response is either a SuccessResponse or an ErrorResponse.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="core:OCIRequest">
<xs:sequence>
<xs:element name="continueCallAfterRecordingFailure" type="xs:boolean"
minOccurs="0"/>
<xs:element name="refreshPeriodSeconds"
type="RecordingRefreshPeriodSeconds" minOccurs="0"/>
<xs:element name="maxConsecutiveFailures"
type="RecordingMaxConsecutiveFailures" minOccurs="0"/>
<xs:element name="maxResponseWaitTimeMilliseconds"
type="RecordingMaxResponseWaitTimeMilliseconds"
minOccurs="0"/>
<xs:element name="continueCallAfterVideoRecordingFailure"
type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
3.6.3
3.6.4
Deprecated Commands
Command:
SystemCallRecordingAddPlatformRequest19
Replaced By:
SystemCallRecordingAddPlatformRequest20
Behavior Impacts:
Reporting Impacts
There is no impact.
11-BD5812-00
PAGE 77 OF 95
3.7
3.8
3.9
3.18 Treatments
There is no impact.
11-BD5812-00
PAGE 78 OF 95
4
4.1
Accounting Impacts
Summary of Changes
This feature does not make any changes to the accounting records created by the Call
Recording feature. Accounting records are created to record calls with video in a manner
similar to that of audio-only calls. The accounting records created for call recording with
audio and video do not differ from the records created for audio-only calls.
4.2
4.3
4.4
4.5
Related Call ID
This is not applicable.
4.6
Example
There is no example.
11-BD5812-00
PAGE 79 OF 95
5.1
5.1.1
BW-Execution.mib
enterprises.broadsoft.broadworks.executionServer.services.callrecording
The number of video calls that are recorded.
Type:
Counter32
Access:
read/write
Incremented:
Name:
MIB:
Module:
enterprises.broadsoft.broadworks.executionServer.services.callrecording
Description:
The number of video calls that are recorded for users in the given service
provider.
Type:
Counter32
Access:
read/write
Incremented:
Name:
MIB:
Module:
enterprises.broadsoft.broadworks.executionServer.services.callrecording
Description:
The number of video calls that are recorded for users in the given group.
Type:
Counter32
Access:
read/write
Incremented:
5.1.2
bwCallRecordingVideoRecordings
Modified Counters
There is no impact.
5.1.3
5.2
5.2.1
11-BD5812-00
PAGE 80 OF 95
5.2.2
Modified Alarms
There is no impact.
5.3
5.4
11-BD5812-00
PAGE 81 OF 95
6.1
6.2
6.3
6.3.1
6.3.2
6.3.3
6.3.4
Message Example
There is no impact.
6.4
6.4.1
Service Interactions
Service Precedence
This feature uses the existing Call Recording service. The Call Recording service that
runs on the originating call half has a precedence of 5400. It falls between
com.broadsoft.services.automaticcallback.AutomaticCallbackService and
com.broadsoft.services.treatments.TreatmentsService.
The Call Recording service that runs on the terminating call half has a precedence of
17000. It falls between com.broadsoft.services.musiconhold.MusicOnHoldService and
com.broadsoft.services.calltimerpolicy.CallTimerPolicyService.
6.4.2
Service Interactions
Most of the service interactions for video call recording are the same as those for audioonly call recording. They are all listed in this section for completeness.
The following table of service interactions assumes that the user with the Call Recording
service has the service enabled in the Always recording mode.
Service
Interaction
Answer Confirmation
Auto Attendant
BroadWorks Anywhere
11-BD5812-00
PAGE 82 OF 95
Service
Interaction
BroadWorks Mobility
Calls to and from a user with the BroadWorks Mobility service are
recorded. This includes calls to and originated from the
subscribers mobile number provisioned in the BroadWorks
Mobility service.
Call Center
Call Park
Call Pickup
If a user who picks up the call has Call Recording, then the call is
recorded.
Call Me Now
Call Transfer
Music On Hold
Push To Talk
Remote Office
Route Point
Sequential Ringing
Simultaneous Ringing
Three-Way Calling,
N-Way Calling
11-BD5812-00
PAGE 83 OF 95
Service
Interaction
Music/Video On Hold
Video Add-On
11-BD5812-00
PAGE 84 OF 95
7.1
OCI-P/CAP Impacts
There is no impact.
7.2
7.3
7.3.1
Window Impacts
Configuration Dialog Impacts
There is no impact.
7.3.2
11-BD5812-00
PAGE 85 OF 95
Deployment/Operational Impacts
8.1
8.2
8.2.1
Installation Impacts
Application Server Installation Impacts
The system call recording parameter defined in section 3.1.2 System Call Recording
Parameter is added with its default value.
8.2.2
8.3
8.3.1
Upgrade Impacts
Application Server Upgrade Impacts
The system-level recording platform parameter defined in section 3.1.1 Recording
Platform Parameter is added with its default value set to each existing recording platform
instance.
The system-level call recording parameter defined in section 3.1.2 System Call Recording
Parameter is added with its default value.
8.3.2
8.4
8.4.1
Rollback Impacts
Application Server Rollback Impacts
The system-level recording platform parameter defined in section 3.1.1 Recording
Platform Parameter is removed from all existing recording platform instances.
The system-level call recording parameter defined in section 3.1.2 System Call Recording
Parameter is removed.
8.4.2
8.5
Security Impacts
There is no impact.
8.6
Scheduled Tasks
There is no impact.
11-BD5812-00
PAGE 86 OF 95
8.7
Third-Party Software
There is no impact.
8.8
Videostreammixerbe (new)
Applies To
Description
The video stream mixer back end provides the video relay functionality.
The videostreammixerbe input channel is enabled to view logs generated
by the video stream mixer (back end).
Special Configuration
8.9
8.9.1
8.9.2
Configuration Impacts
There is no impact.
8.9.3
8.9.4
11-BD5812-00
PAGE 87 OF 95
9.1
Processing Impacts
The Call Recording service uses three to four media connections for each originating or
terminating user who is recording the call. This is the same as the existing usage when
only audio is recorded. Recording video does not use any additional connections.
Recording an audio and video call results in 35 messages in and out of the Application
Server for each user who invokes this feature.
9.1.1
New Time-Outs
There are no new time-outs being introduced by this feature.
9.1.2
New Threads
A new single-threaded back-end process is introduced to handle the video relay function
on the Media Server. The process is named videostreammixerbe and is started by the
Media Server front-end (MSFE) process. The process is owned and the user ID is set
(SUID) by root so the type of service (TOS) bit can be set.
9.2
9.2.1
Memory Impacts
Application Server Memory Impacts
There is no significant additional memory used by this feature beyond what is used by the
existing Call Recording service.
9.2.2
9.3
9.4
9.5
Hardware Impacts
There is no impact.
9.6
11-BD5812-00
PAGE 88 OF 95
11-BD5812-00
PAGE 89 OF 95
11-BD5812-00
PAGE 90 OF 95
AAC
Account/Authorization Code
ABNF
ACD
ACL
ACR
Admin
Administrator
AMS
API
AS
Application Server
AVP
BCCT
BW
BroadWorks
CAP
CBF
CCRS
CDR
CDS
CFA
CFB
CFNA
CFNR
CFS
CFW
CIF
CLI
CLID
Calling Line ID
CORBA
CPL
CPU
CRS
CS
Conferencing Server
11-BD5812-00
PAGE 91 OF 95
CSCF
CSTA
CSV
CTI
CWT
dBm
The power ratio in decibel (dB) of the measured power referenced to one
milliwatt (mW).
dBm0
The level of a signal as specified in dBm0, is the level of that signal (in
dBm) as measured at the reference point of the network.
DBS
Database Server
DN
Directory Number
DND
Do Not Disturb
DPUBI
DTMF
Dual-Tone Multi-Frequency
EMS
EOCP
EV
ExtraView
FAC
FQDN
FR
Feature Request
FS
Functional Specification
FTP
HCB
HD
High Definition
HTML
HTTP
Hz
Hertz
ICP
IDR
IMAP
IMS
IP Multimedia Subsystem
IP
Internet Protocol
IVR
KB
Kilobyte
LO
Local
LPS
LSSGR
11-BD5812-00
PAGE 92 OF 95
MB
Megabyte
MGCP
MIB
MOC
MR
Market Request
MS
Media Server
NCOS
NE
Network Element
NS
Network Server
NSSync
OAM&P
OCI
OCI-C
OCI-P
OCI-R
OCP
OCS
ODP
OID
Object Identifier
OOTB
Out-of-the-Blue
OS
Operating System
OSS
PBX
PCV
P-Charging-Vector
PM
Performance Measurement
PS
Provisioning Server
PSTN
PTT
Push To Talk
RAM
RFC
RTP
SAC
SBC
SCA
SCA
11-BD5812-00
PAGE 93 OF 95
SCR
SDP
SDR
SIP
SMAP
SMDI
SMPP
SMS-C
SMTP
SNMP
SOAP
SP
Service Pack
SRV
Service Locator
SSH
Secure Shell
SUID
TAS
TCP/IP
TDM
TO
Toll
TPS
URI
URL
VMS
VoIP
WebDAV
WS
Web Server
XML
XS
Execution Server
XSD
Xsi
Xsp
11-BD5812-00
PAGE 94 OF 95
References
[1] BroadSoft, Inc. 2011. BroadWorks Call Recording Interface Guide, Release 18.0.
Handley, M., and Schooler, E., SIP: Session Initiation Protocol, RFC 3261, Internet
Engineering Task Force, June 2002. Available from http://www.ietf.org.
[8] Levin, O., Camarillo, G., The Session Description Protocol (SDP) Label Attribute,
11-BD5812-00
PAGE 95 OF 95