Transcript
Call Recording Video Support
Feature Description
Release 20.0
Document Version 1.5
CallRecordingVideoSupportFD-R200
Market Request Number 148447
Feature Request Numbers 170973, 174268
9737 Washingtonian Boulevard, Suite 350
Gaithersburg, MD 20878
Tel +1 301.977.9440
WWW.BROADSOFT.COM
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 Assistant–Enterprise™, 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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 2 OF 95
Document Revision History
Version
Reason for Change
Date
0.1 Draft
Created document.
January 9, 2013
0.2 Draft
Updated Provisioning Server sections.
January 10, 2013
0.3 Draft
Updated Functional Specification (FS) with comments
from Provisioning Server interface review.
January 17, 2013
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
Updated FS with comments from second Provisioning
Server interface review.
February 11, 2013
0.6 Draft
Updated Media Server command line interface (CLI).
February 20, 2013
0.7 Draft
Added Provisioning Server interface approval and
Element Management System (EMS) snapshot.
February 22, 2013
0.8 Draft
Documented upgrade/rollback behavior with respect to
video codecs.
February 22, 2013
0.9 Draft
Made updates to Application Server (AS) information.
February 23, 2013
0.10 Draft
Made updates to Media Server (MS) information (added
more CLI contexts).
March 5, 2013
0.11 Draft
Made updates to Application Server information.
March 5, 2013
0.12 Draft
Made updates to Media Server information in sections
2.1.5 Video Fast Update Support, 9.4 Port Usage
Impacts, and 9.5 Hardware Impacts.
March 7, 2013
0.13 Draft
Made updates to Application Server information.
March 8, 2013
0.14 Draft
Made updates to Application Server information.
March 12, 2013
0.15 Draft
Reviewed updates.
March 14, 2013
0.16 Draft
Reviewed updates.
March 15, 2013
0.17 Draft
Approved document:
March 15, 2013
Added section 3.5.6
Applications/MediaStreaming/Interfaces/CFW/VideoCod
ecs Context.
Updated release notes with modified CLI attributes.
0.18 Draft
Reviewed updates.
March 16, 2013
0.19 Draft
Updated sections 3.5 Media Server CLI Impacts and 9.4
Port Usage Impacts.
March 18, 2013
0.20 Draft
Updated section 2.1.2.3 Video Codec Selection for
Recording and section 9 System Engineering Impacts.
March 19, 2013
0.21 Draft
Updated the call flows.
March 20, 2013
1.0 Approved
Approved document.
March 26, 2013
1.1
Added processing, memory, and logging impacts for the
new videostreammixerbe process.
April 26, 2013
1.2
Edited document.
June 6, 2013
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 3 OF 95
Version
Reason for Change
Date
1.3
Approved editing changes.
July 30, 2013
1.4
Made a few small changes and finalized document.
August 22, 2013
1.5
Finalized and published document.
October 31, 2013
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 4 OF 95
Table of Contents
1
Feature Overview and Purpose ......................................................................................................9
2
Detailed Feature Description........................................................................................................ 10
2.1
Detailed Functional Description ................................................................................................ 10
2.1.1
Recording Modes ............................................................................................................. 10
2.1.2
Recording Behavior .......................................................................................................... 10
2.1.3
Call Recording Platform Interface Changes.................................................................... 13
2.1.4
Metadata Updates ............................................................................................................ 13
2.1.5
Video Fast Update Support.............................................................................................. 14
2.1.6
Video Codec Negotiation ................................................................................................. 14
2.1.7
Music/Video On Hold Service .......................................................................................... 15
2.1.8
Video Add-On Service ...................................................................................................... 15
2.1.9
Video Conference ............................................................................................................. 15
2.1.10 Call Park ............................................................................................................................ 16
2.1.11 Call Transfer...................................................................................................................... 16
2.1.12 Virtual Subscriber Services .............................................................................................. 16
2.1.13 Mid-Call Provisioning Changes........................................................................................ 17
2.1.14 Video Recording Failure Handling ................................................................................... 17
2.1.15 Call Flows.......................................................................................................................... 18
2.1.16 Logging ............................................................................................................................ 54
2.2
2.3
Execution Use Cases ................................................................................................................ 54
2.2.1
Basic Video Call Recording ............................................................................................. 54
2.2.2
Mid-Session Video Call Recording .................................................................................. 54
2.2.3
Video Recording Disabled ............................................................................................... 54
2.2.4
Video Auto Attendant ....................................................................................................... 54
2.2.5
Video Negotiation Failure ................................................................................................. 55
Provisioning Steps ..................................................................................................................... 55
2.4 Client Interaction Use Cases .................................................................................................... 55
3
Provisioning Impacts..................................................................................................................... 56
3.1
3.2
3.3
3.4
Configuration Data..................................................................................................................... 56
3.1.1
Recording Platform Parameter ........................................................................................ 56
3.1.2
System Call Recording Parameter .................................................................................. 56
Centralized Configuration Data................................................................................................. 56
3.2.1
Data Types ........................................................................................................................ 56
3.2.2
Media Server Subsystem ................................................................................................. 56
Web Portal Impacts ................................................................................................................... 57
Application Server CLI Impacts ................................................................................................ 57
3.4.1
Summary........................................................................................................................... 57
3.4.2
CallRecording/Platform Context ...................................................................................... 57
3.4.3
Call Recording Context .................................................................................................... 59
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 5 OF 95
3.5
Media Server CLI Impacts ........................................................................................................ 61
3.5.1
Summary........................................................................................................................... 61
3.5.2
Applications/MediaStreaming/Services/Dialog/Security Context................................... 62
3.5.3
Applications/MediaStreaming/Services/IVR Context...................................................... 63
3.5.4
Applications/MediaStreaming/Services/Conferencing Context ..................................... 64
3.5.5
Applications/MediaStreaming/Interfaces/CFW Context ................................................. 65
3.5.6
Applications/MediaStreaming/Interfaces/CFW/VideoCodecs Context.......................... 67
3.5.7
Applications/MediaStreaming/Interfaces/SIP Context .................................................... 68
3.5.8
Applications/MediaStreaming/Interfaces/MRCP/ASR Context...................................... 69
3.5.9
Applications/MediaStreaming/Interfaces/MRCP/TTS Context ...................................... 70
3.5.10 Applications/MediaStreaming/GeneralSettings Context ................................................ 72
3.6
Open Client Interface-Provisioning (OCI-P) Impact................................................................. 74
3.6.1
Summary........................................................................................................................... 74
3.6.2
Command Impacts ........................................................................................................... 74
3.6.3
Deprecated Commands ................................................................................................... 77
3.6.4
Reporting Impacts ............................................................................................................ 77
3.7
Application Server Query User/Query Group Impacts ............................................................ 78
3.8
Application Server Enterprise Migration Tool Impacts ............................................................ 78
3.9
External Authentication Impacts ............................................................................................... 78
3.10 Application Server Portal API Impacts ..................................................................................... 78
3.11 Network Server Location API Impacts ..................................................................................... 78
3.12 NSSync API Impacts ................................................................................................................. 78
3.13 Application Server Dump Impacts ............................................................................................ 78
3.14 BroadCloud Dump Impacts....................................................................................................... 78
3.15 Service Details and Licensing ................................................................................................... 78
3.16 Service License Reporting Impact ............................................................................................ 78
3.17 Call Detail Server SOAP Interface............................................................................................ 78
3.18 Treatments ................................................................................................................................. 78
3.19 Media Announcements (Audio and Video) .............................................................................. 78
3.20 BCCT Impacts ........................................................................................................................... 78
4
5
3.21 Device Management Impacts ................................................................................................... 78
Accounting Impacts....................................................................................................................... 79
4.1
Summary of Changes ............................................................................................................... 79
4.2
Generation of Accounting Records .......................................................................................... 79
4.3
Impact to Accounting Fields (CDR) .......................................................................................... 79
4.4
Original Called Reason and Redirection Reason .................................................................... 79
4.5
Related Call ID ........................................................................................................................... 79
4.6 Example ..................................................................................................................................... 79
System Management Impacts...................................................................................................... 80
5.1
Performance Management Impacts ......................................................................................... 80
5.1.1
New Counters ................................................................................................................... 80
5.1.2
Modified Counters ............................................................................................................ 80
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 6 OF 95
5.1.3
5.2
5.3
Deleted Counters or Module ............................................................................................ 80
Fault Management Impacts ...................................................................................................... 80
5.2.1
New Alarms....................................................................................................................... 80
5.2.2
Modified Alarms ................................................................................................................ 81
Scripts and Tools ....................................................................................................................... 81
5.4 EMS Integration Impacts ........................................................................................................... 81
6
Execution/Call Processing Impacts ............................................................................................ 82
6.1
CAP Interface Impact ................................................................................................................ 82
6.2
Xtended Services Interface (Xsi) Impact .................................................................................. 82
6.3
6.4
SIP/MGCP Interface Impact ..................................................................................................... 82
6.3.1
Summary........................................................................................................................... 82
6.3.2
SIP Header/MGCP Command ........................................................................................ 82
6.3.3
SIP Parameter/MGCP Signal/Event................................................................................ 82
6.3.4
Message Example ............................................................................................................ 82
Service Interactions ................................................................................................................... 82
6.4.1
7
6.4.2 Service Interactions .......................................................................................................... 82
Client Application Impacts ........................................................................................................... 85
7.1
OCI-P/CAP Impacts .................................................................................................................. 85
7.2
Call Control Impacts .................................................................................................................. 85
7.3
Window Impacts ........................................................................................................................ 85
7.3.1
8
Service Precedence ......................................................................................................... 82
Configuration Dialog Impacts ........................................................................................... 85
7.3.2 Supplemental Interface Impacts ...................................................................................... 85
Deployment/Operational Impacts ............................................................................................... 86
8.1
Configuration File Impacts ........................................................................................................ 86
8.2
Installation Impacts .................................................................................................................... 86
8.3
8.4
8.2.1
Application Server Installation Impacts............................................................................ 86
8.2.2
Media Server Installation Impacts.................................................................................... 86
Upgrade Impacts ....................................................................................................................... 86
8.3.1
Application Server Upgrade Impacts ............................................................................... 86
8.3.2
Media Server Upgrade Impacts ....................................................................................... 86
Rollback Impacts ....................................................................................................................... 86
8.4.1
Application Server Rollback Impacts ............................................................................... 86
8.4.2
Media Server Rollback Impacts ....................................................................................... 86
8.5
Security Impacts ........................................................................................................................ 86
8.6
Scheduled Tasks ....................................................................................................................... 86
8.7
Third-Party Software.................................................................................................................. 87
8.8
Server Logging Impacts ............................................................................................................ 87
8.9
Client Application Impacts ......................................................................................................... 87
8.9.1
Deployment Studio Impacts ............................................................................................. 87
8.9.2
Configuration Impacts ...................................................................................................... 87
8.9.3
Host Application Impacts.................................................................................................. 87
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 7 OF 95
9
8.9.4 Third-Party Integration Impacts........................................................................................ 87
System Engineering Impacts ....................................................................................................... 88
9.1
9.2
Processing Impacts ................................................................................................................... 88
9.1.1
New Time-Outs................................................................................................................. 88
9.1.2
New Threads .................................................................................................................... 88
Memory Impacts ........................................................................................................................ 88
9.2.1
Application Server Memory Impacts................................................................................ 88
9.2.2
Media Server Memory Impacts........................................................................................ 88
9.3
Disk Usage Impacts .................................................................................................................. 88
9.4
Port Usage Impacts ................................................................................................................... 88
9.5
Hardware Impacts ..................................................................................................................... 88
9.6 Client Application Messaging Impacts...................................................................................... 88
10 Service Patch Information ............................................................................................................ 89
11
Restrictions and Limitations ........................................................................................................ 90
Acronyms and Abbreviations ............................................................................................................... 91
References ............................................................................................................................................... 95
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 8 OF 95
1
Feature Overview and Purpose
Applicable Telephony Application Server (TAS)
Application Server (AS)
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 provide a button for ondemand recording
3PCR provides a portal to
manage recordings – retrieve,
delete, listen, and so on
Clients
3PCR
Portal
Xsi-Actions (on demand recording)
3PCR Interface
SIP Interface to
provide signaling for
all calls that are to be
recorded
SIP
3PCR
RTP for recording calls
RTP
Figure 1 BroadWorks Call Recording Layout
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 9 OF 95
2
Detailed Feature Description
2.1
Detailed Functional Description
The Call Recording service creates connections to a Third Party Call Recording (3PCR)
platform for a recording to be made of a user’s call. This service uses the BroadWorks
Telephony Application Server in combination with the BroadWorks Media Server and a
Third Party Call Recording platform to record a user’s calls. Currently the Call Recording
service supports recording the audio portion of the call only. This feature extends the
existing functionality to also record the video portion of the calls.
All of the existing generic provisioning and configuration features for audio call recording
apply to video recording as well. An additional provisioning control is introduced to enable
or disable the recording of the video portion of the calls. This control is disabled by default.
When enabled, both audio and video portions of a call are recorded. Note that when
video is recorded, it is always recorded in conjunction with audio and never by itself
without audio.
The video sent to the 3PCR platform uses the existing provisioning for the streaming
mode and is sent in a single stream (single) or in two separate streams (dual). The mode
is configured when the platform is provisioned on the BroadWorks system. In dual mode
there are two streams, the video from the user who is recording the call is in one stream
and the video received by the user is in the other stream.
The Third Party Call Recording platform is also referred to as the Call Recording platform
is this document.
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 user’s 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 user’s 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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 10 OF 95
2.1.2.1
Calls Originated by Recording User
When the recording user originates a call, the call recording starts after the remote party
answers. Any early media in the call is not recorded.
2.1.2.2
Calls Received by Recording User
An inbound call is a call that the user who has the Call Recording service is answering.
The recording of these inbound calls starts after the user has answered the call. Any
media provided prior to the user answering the inbound call is not recorded.
2.1.2.3
Video Codec Selection for Recording
The codec selected for the recording is dependent on the capabilities of the 3PCR
platform and the end-user devices. It also depends on the codecs that the Media Server
supports. For dual mode, the Media Server (MS) supports H.264 and H.263 codecs. In
single mode, it supports only the H.264 codec. For more information on the codecs
supported by the BroadWorks Media Server and configuring them, see the BroadWorks
Media Server EMS Configuration Management Guide [2].
The 3PCR must adhere to the following rules when handling video SDP to successfully
record video calls:
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 platform’s 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
Video Codec Selection in Dual Mode
SDP to Call Recording Platform
The SDP sent to the Call Recording platform is based on the SDP from the end users and
the codecs supported on the Media Server
To compute this list of codecs, the following filtering is applied:
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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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 A’s and User B’s 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
Video Codec Selection in Single Mode
In single mode the SDP sent to the 3PCR is the offer SDP from the Media Server. Unlike
dual mode, the SDP is not manipulated since the Media Server mixes the output from the
users and regenerates the video stream sent to the 3PCR. If multiple codecs are offered
by the Media Server, the codecs are reordered to match as close as possible to the
original negotiated codec list between Users A and B.
The offer from the Media Server sent to User B is reordered in a manner that is similar to
that shown above. Note that for this release, the Media Server only supports H.264 codec
for single mode and as a result, there is no reordering involved.
For the call flow for single mode call recording, see section 2.1.15.3 Messaging to Show
SDP Negotiation.
Recording Platform Provisioning for Video
Call Recording platform provisioning includes new parameters to configure the support for
video recording.
The supportVideoRecording parameter is used to enable/disable the video recording
functionality. This parameter is defined at the Call Recording platform level and is
disabled by default. This parameter needs to be enabled to process video calls for
recording. When this parameter is disabled, the video media is blocked between the end
users and only the audio is streamed.
The continueCallAfterVideoRecordingFailure parameter is used to define the behavior
when video recording is enabled and video recording fails for any reason. This parameter
is defined at the Call Recording service level and is disabled by default. When disabled, if
the video recording fails for any reason, the call between the users is also terminated. If
enabled, the call between the users is allowed to continue without video being recorded.
For more information, see section 2.1.14 Video Recording Failure Handling.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 12 OF 95
2.1.3
Call Recording Platform Interface Changes
The interface to the 3PCR platform now includes the video SDP information and follows
the same format as that used for the audio SDP. Each video stream in the SDP has an
associated label similar to the audio stream. The BroadWorks Telephony Application
Server sends information in the message body of the INVITE in the form of XML-based
metadata during the setup of the call recording session. Video SDP stream information is
added to the metadata for each participant in the call being recorded. The metadata
format is the same as that used for the audio streams. For more information on the
existing interface, see the BroadWorks Call Recording Interface Guide [1].
Since the media connection for call recording is one way, the 3PCR platform is expected
to use the recvonly attribute for the video SDP as well, in all of its SDP descriptions. The
BroadWorks Telephony Application Server sends the sendonly attribute to the 3PCR
platform. The only exception to these rules is if the recording needs to be paused, in
which case, the BroadWorks Telephony Application Server sends inactive, and it is
expected that the 3PCR platform should send the same inactive attribute in the response.
When the recording resumes, the BroadWorks Telephony Application Server sends
sendonly and expects the 3PCR to respond with recvonly.
For more information on the messaging showing the metadata changes, see the
examples in section 2.1.15 Call Flows.
2.1.3.1
RFC 4574 − Session Description Protocol Label Attribute
Each media description sent by the BroadWorks Telephony Application Server is identified
by a label as described in RFC 4574 [8]. The 3PCR platform must accept and start
recordings for each of the media streams. The 3PCR system should use the information
in the metadata to index and store these recordings.
In addition, the SDP responses sent by the 3PCR platform must identify the media
descriptions using the same labels. Additional information on the usage of the labels can
be found in section 5.2 of draft-portman-siprec-protocol-03 [5]. Note that the BroadWorks
implementation sends at most four streams to the Call Recording platform when audio and
video are being recorded.
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:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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.
Video Fast Update Support
The BroadWorks Telephony Application Server proxies a SIP INFO request that includes
a picture_fast_update primitive as defined in RFC 5168 [16] to the clients, when
renegotiations take place between the users and call recording setup is completed. This
forces the clients to send a video refresh, thus minimizing the period where no image is
displayed at the far end. The following is an example of a SIP INFO that includes a
picture_fast_update primitive.
INFO sip:
[email protected]:5060 SIP/2.0
Via: SIP/2.0/UDP 192.168.200.205:5060;branch=z9hG4bK-BroadWorks-MS329699111
From:
;tag=89314878
To: ;tag=499861f78d7f218c
Call-ID: [email protected]
CSeq: 435582615 INFO
Content-Type: application/media_control+xml
Max-Forwards: 70
Content-Length:
169
2.1.6
Video Codec Negotiation
The list of video codecs used by the Media Server for Control Channel Framework (CFW)
services is now configurable independently from other Interactive Voice Response (IVR)
services. Prior to this feature, the Media Server shared the list of supported video codecs
with other Interactive Voice Response services. A new CLI context allows adding and
removing video codecs that can be negotiated with Control Channel Framework services.
The following video codecs are configurable.
H264
H263-1998
H263-2000
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Music/Video On Hold Service
The Music/Video On Hold service allows a user or administrator to configure a music and
a video source to be played to callers of held or parked calls. The behavior of call
recording if Video On Hold is active is the same as it is for Music On Hold except that the
video portion of the call is also recorded in addition to the music.
2.1.8
Video Add-On Service
The Video Add-On service enables the use of video media in conjunction with regular
audio media. If a user’s primary device does not support video, this service can be used
to configure a video-capable device to deliver the video portion of their call. When the
user receives a multimedia call, BroadWorks divides the call, directing the audio portions
of the call to the primary device and the video portions of the call to the video add-on
device.
If call recording is enabled on such a call with a video add-on device, the video portion of
the call is also recorded in addition to the audio.
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.
After two minutes, User A drops the video.
After two more minutes, User C drops the call.
After one minute, Users A and B add the video.
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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 16 OF 95
2.1.12.2 Call Center
Calls that are routed to a BroadWorks Call Center can be recorded. When a call is
received by a call center, the policies of the call center determine how the call is handled.
Typically, call center calls are placed in a queue and then offered to an agent upon being
received by a call center. In general, the call center calls are recorded shortly after the call
center answers the call and until the call is answered by an agent.
For more information on the Call Center service, see BroadWorks Call Center Solution
Guide [10].
The interaction of Call Recording with Call Center service has been detailed in the
BroadWorks Call Recording Interface Guide [1] for handling audio. The call center can
also be configured to play video announcements and treatments for all the same
scenarios in which audio is configured. If video is streamed in any of these scenarios, the
video is also recorded along with the audio.
2.1.12.3 Route Point
The Route Point service is similar to the Call Center service in its interaction with the Call
Recording service. The route point queries a third-party server for its queuing decisions,
rather than the logic running on the BroadWorks Telephony Application Server. For more
information on the Route Point service, see the BroadWorks Network CTI Integration
Feature Description [14].
The interaction of Call Recording with Route Point service has been detailed in the
BroadWorks Call Recording Interface Guide [1] for handling audio. A route point can also
be configured to play video announcements and treatments for all the same scenarios
configured for audio. If video is streamed in any of these scenarios, the video is also
recorded along with the audio.
2.1.13 Mid-Call Provisioning Changes
It is possible for a user or an administrator to change the provisioning of call recording
parameters while a call is being recorded.
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.
If the continueCallAfterVideoRecordingFailure 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.
2.1.14 Video Recording Failure Handling
The BroadWorks Telephony Application Server may be unable to successfully record
video for the following reasons:
Video SDP negotiations with the 3PCR platform or the Media Server may fail.
The Media Server may fail to join the video streams.
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
©
2013 BROADSOFT, INC.
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 renegotiate video with the end users
The 3PCR platform is re-invited to record audio streams only.
−
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.
For call flows, see section 2.1.15.10 Failure Cases.
continueCallAfterVideoRecordingFailure = “true”; continueCallAfterRecordingFailure =
“false”
−
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.
continueCallAfterVideoRecordingFailure = “false”; continueCallAfterRecordingFailure
= “false”
If audio, video, or the entire call is rejected, the call is terminated and resources are
released.
2.1.15 Call Flows
This section shows some of the basic call flows that involve video. In the call flows, the
100 trying messages are skipped for the sake of brevity. For this same reason, only
headers that are important to the call flows are shown. This means some mandatory SIP
headers are missing. The call flows highlight the headers that are important for the
interface to the Call Recording platform. For more information on the XML schema for the
BroadWorks-Recording-metadata, see the section that describes the metadata in
BroadWorks Call Recording Interface Guide [1]
These call flows all have a generic pattern that involve the following steps:
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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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:[email protected]:5060;user=phone SIP/2.0
Via: SIP/2.0/UDP 10.16.134.101;branch=z9hG4bK26f33f26931B5DED
From: ;tag=B6CB9EB1-8AE7B75C
To: sip:[email protected]
Call-ID:[email protected]
CSeq:25 INVITE
Contact:;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
©
2013 BROADSOFT, INC.
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
complete
src
[email protected]
urn:uuid: 94dwif31-9887-341d-12id-789945621002
urn:uuid: 94dwif31-9887-341d-12id-789945621003
[email protected]
urn:uuid: 34123561-7789-341d-12id-78edcaf78945
urn:uuid: 34123561-7789-341d-12id-78edcaf78946
mixed
mixed
mixed
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 20 OF 95
mixed
4:1
TxASDev
North_as90
[email protected]
[email protected]
[email protected]
2146415689
2145551212
demand
-- deew341adf13412ferwadq
3PCR Platform to Application Server
SIP/2.0 200 OK
Via: SIP/2.0/UDP 10.16.134.101;branch=z9hG4bK26f33f26931B5DED
From: ;tag=B6CB9EB1-8AE7B75C
To: sip:[email protected];tag=45DEF34123412DF
Call-ID: [email protected]
CSeq:25 INVITE
Contact:;srs
Recv-Info: x-broadworks-callrecording
Allow:ACK,BYE,CANCEL,INFO,INVITE,OPTIONS,PRACK,REFER,NOTIFY,UPDATE
Content-Type: application/sdp
Content-Length: 500
v=0
o=SIPP 144 0 IN IP4 10.16.134.17
s=Call Recording SDP
t=0 0
m=audio 6008 RTP/AVP 0 18 9
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:1
m=video 6004 RTP/AVP 104
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:3
m=audio 6010 RTP/AVP 0 18 9
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 21 OF 95
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:2
m=video 6006 RTP/AVP 104
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:4
Application Server to 3PCR Platform
ACK sip:recorder.broadsoft.com SIP/2.0
Via: SIP/2.0/UDP 10.16.134.101;branch=z9hG4bK26ff4f268799455
From: ;tag= B6CB9EB1-8AE7B75C
To: sip:[email protected];tag=45DEF34123412DF
Call-ID: [email protected]
CSeq:25 ACK
Contact:;src
Content-Length: 0
2.1.15.2 Basic Video Call Recording in Dual Mode
The call flow shows a basic two-party call with video in dual mode.
The call is established between Users A and B with the SDP negotiated for audio and
video end to end. The BroadWorks Telephony Application Server then establishes
connections for the Call Recording (CR) platform on the Media Server and reconnects the
users through the Media Server. Sessions are also established on the Media Server for
Users A and B.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 22 OF 95
Figure 2 Basic Video Recording in Dual Mode (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 23 OF 95
Figure 3 Basic Video Recording in Dual Mode (b)
2.1.15.3 Messaging to Show SDP Negotiation
Note that only the messages relevant for SDP negotiation are shown here and messages
such as provisional responses, ACK without SDP, and so on are not shown (for clarity).
Initial Offer from User A
v=0
o=- 1360011625 1360011625 IN IP4 10.16.134.101
s=Polycom IP Phone
c=IN IP4 10.16.134.101
t=0 0
a=sendrecv
m=audio 2228 RTP/AVP 9 0 8 18 127
a=rtpmap:9 G722/8000
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:18 G729/8000
a=fmtp:18 annexb=no
a=rtpmap:127 telephone-event/8000
m=video 2224 RTP/AVP 109 110 34
b=AS:512
a=sendrecv
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00C; packetization-mode=0
a=rtpmap:110 H264/90000
a=fmtp:110 profile-level-id=42800d;max-mbps=40500;max-fs=1344
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 24 OF 95
a=rtpmap:34 H263/90000
a=fmtp:34 QCIF=1;SQCIF=1
Answer from User B to User A
v=0
o=- 1360011671 1360011671 IN IP4 10.16.134.100
s=Polycom IP Phone
c=IN IP4 10.16.134.100
t=0 0
a=sendrecv
m=audio 2230 RTP/AVP 0 127
a=rtpmap:0 PCMU/8000
a=rtpmap:127 telephone-event/8000
m=video 2226 RTP/AVP 109 110 34
b=AS:512
a=sendrecv
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00D; packetization-mode=0
a=rtpmap:110 H264/90000
a=fmtp:110 profile-level-id=42800d;max-mbps=40500;max-fs=1344
a=rtpmap:34 H263/90000
a=fmtp:34 QCIF=1;SQCIF=2
Message 1: Application Server to Media Server
INVITE cfw-media (No SDP)
Message 2: Answer from Media Server to Application Server
200 OK(MS SDP3)
v=0
o=BroadWks 14658 0 IN IP4 10.16.120.22
s=Media Server SDP
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
m=video 25978 RTP/AVP 104 105 106 107
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42000C
a=rtpmap:105 H264/90000
a=ftmp:105 profile-level-id=42800a
a=rtpmap:106 H264/90000
a=fmtp:106 profile-level-id=42800c
a=rtpmap:107 H263/90000
a=fmtp:107 QCIF=1;SQCIF=1
Message 3: Application Server to Media Server
INVITE cfw-media (No SDP)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 25 OF 95
Message 4: 200 OK (Media Server SDP4)
v=0
o=BroadWks 14659 0 IN IP4 10.16.120.22
s=Media Server SDP
c=IN IP4 10.16.120.22
t=0 0
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
a=ptime:20
m=video 26040 RTP/AVP 104 105 106 107
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42000C
a=rtpmap:105 H264/90000
a=ftmp:105 profile-level-id=42800a
a=rtpmap:106 H264/90000
a=fmtp:106 profile-level-id=42800c
a=rtpmap:107 H263/90000
a=fmtp:107 QCIF=1;SQCIF=1
Message 5: Offer to 3PCR
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=0a=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
a=ptime:20
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Message 6: Answer from 3PCR (CrSDP3/CrSDP4)
v=0
o=SIPP 144 0 IN IP4 10.16.134.17
s=Call Recording SDP
t=0 0
m=audio 6008 RTP/AVP 0 18 9
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:1
m=video 6004 RTP/AVP 104 b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:3
m=audio 6010 RTP/AVP 0 18 9
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:2
m=video 6006 RTP/AVP 104
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:4
Message 8: Answer to Media Server (CrSDP3)
v=0
o=BroadWorks 785 1 IN IP4 10.16.134.17
s=t=0 0
m=audio 6008 RTP/AVP 0 18 9
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:1
m=video 6004 RTP/AVP 104
c=IN IP4 10.16.134.17
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:2
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 27 OF 95
Message 9: Answer to Media Server (CrSDP4)
v=0
o=BroadWorks 785 1 IN IP4 10.16.134.17
s=t=0 0
m=audio 6010 RTP/AVP 0 18 9
c=IN IP4 10.16.134.17
a=rtpmap:0 PCMU/8000
a=rtpmap:18 G729/8000
a=rtpmap:9 G722/8000
a=ptime:20
a=label:3
m=video 6006 RTP/AVP 104
c=IN IP4 10.16.134.17
b=AS:512
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
a=label:4
Message 10: Application Server to User A
INVITE A (No SDP)
Message 11: Offer from User A
v=0
o=- 1360011625 1360011626 IN IP4 10.16.134.101
s=Polycom IP Phone
c=IN IP4 10.16.134.101
t=0 0
m=audio 2228 RTP/AVP 0 127
a=rtpmap:0 PCMU/8000
a=rtpmap:127 telephone-event/8000
m=video 2224 RTP/AVP 109 110 34
b=AS:512
a=sendrecv
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00C; packetization-mode=0
a=rtpmap:110 H264/90000
a=fmtp:110 profile-level-id=42800d;max-mbps=40500;max-fs=1344
a=rtpmap:34 H263/90000
a=fmtp:34 QCIF=1;SQCIF=1
Message 12: Offer to Media Server
v=0
o=- 1360011625 1360011626 IN IP4 10.16.134.101
s=Polycom IP Phone
c=IN IP4 10.16.134.101
t=0 0
m=audio 2228 RTP/AVP 0 127
a=rtpmap:0 PCMU/8000
a=rtpmap:127 telephone-event/8000
m=video 2224 RTP/AVP 109 110
b=AS:512
a=sendrecv
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00C; packetization-mode=0
a=rtpmap:110 H264/90000
a=fmtp:110 profile-level-id=42800d;max-mbps=40500;max-fs=1344
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 28 OF 95
Message 13: Answer from Media Server (MSSDP1)
v=0
o=BroadWks 14661 0 IN IP4 10.16.120.22
s=Media Server SDP
c=IN IP4 10.16.120.22
t=0 0
m=audio 26038 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
m=video 26036 RTP/AVP 109
a=rtpmap:109 H264/90000
a=fmtp:109 profile-level-id=42E00C; packetization-mode=0
Message 15: Application Server to Media Server
INVITE to MS (NO SDP)
Message 16: Answer from Media Server (MSSDP2)
v=0
o=BroadWks 14660 0 IN IP4 10.16.120.22
s=Media Server SDP
c=IN IP4 10.16.120.22
t=0 0
m=audio 26046 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
m=video 26044 RTP/AVP 104 105 106 107
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00C; packetization-mode=0
a=rtpmap:105 H264/90000
a=ftmp:105 profile-level-id=42800a
a=rtpmap:106 H264/90000
a=fmtp:106 profile-level-id=42800c
a=rtpmap:107 H263/90000
a=fmtp:107 QCIF=1;SQCIF=1
Message 17: INVITE to User B (SDPA with MSSDP2 address/port)
v=0
o=BroadWorks 787 1 IN IP4 10.16.120.22
s=c=IN IP4 10.16.120.22
t=0 0
m=audio 26046 RTP/AVP 0 8 18 96 9 2 101
a=rtpmap:0 PCMU/8000
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Message 18: Answer from User B (SDPB)
v=0
o=- 1360011671 1360011672 IN IP4 10.16.134.100
s=Polycom IP Phone
c=IN IP4 10.16.134.100
t=0 0
m=audio 2230 RTP/AVP 0 101
a=rtpmap:0 PCMU/8000
a=rtpmap:101 telephone-event/8000
m=video 2226 RTP/AVP 104
b=AS:512
a=sendrecv
a=rtpmap: 104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
Message 20: Answer to Media Server (SDPB)
v=0
o=BroadWorks 782 2 IN IP4 10.16.134.100
s=c=IN IP4 10.16.134.100
t=0 0
m=audio 2230 RTP/AVP 0 101
a=rtpmap:0 PCMU/8000
a=rtpmap:101 telephone-event/8000
m=video 2226 RTP/AVP 104
b=AS:512
a=sendrecv
a=rtpmap:104 H264/90000
a=fmtp:104 profile-level-id=42E00D; packetization-mode=0
Message 21: Answer to User A with SDPB and MSSDP1
v=0
o=BroadWorks 786 1 IN IP4 10.16.120.22
s=c=IN IP4 10.16.120.22
t=0 0
m=audio 26038 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
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
2.1.15.4 Basic Video Call Recording in Single Mode
Following is the call flow for basic single mode video call recording.
The call is established between Users A and B with the SDP negotiated for audio and
video from end to end with the resulting video codec being H.264. The BroadWorks
Telephony Application Server then establishes slow start sessions on the Media Server,
which are then sent to the 3PCR platform, but with the video SDP information from Users
A and B. The audio codec information sent to the 3PCR is ordered to contain the
negotiated codec as the first element on the list. The video codec is also updated to have
H.264 as the only one on the list as received from the Media Server.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 31 OF 95
Figure 4 Video Recording in Single Mode (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 32 OF 95
Figure 5 Video Recording in Single Mode (b)
2.1.15.5 Video Add Mid-Session in Dual Mode
When an audio recording is already in progress, video can be negotiated between the end
users, and if call recording is already active on that call, then video is also added to the
same call recording session.
At this point in the call, Users A and B are already connected through the Media Server for
call recording. Then User A decides to add video to the call and re-invites User B with
video added to the SDP. The offer is accepted by User B and video is streamed directly
between Users A and B while audio is being streamed through the Media Server. The
Call Recording service puts the 3PCR on hold and reconnects to add video media to the
same call recording session so that both audio and video are streamed through the Media
Server.
The following figures show the call flow for video added mid-session in dual mode.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 33 OF 95
Figure 6 Video Add Mid-Session in Dual Mode (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 34 OF 95
Figure 7 Video Add Mid-Session in Dual Mode (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 35 OF 95
2.1.15.6 Video Add Mid-Session in Single Mode
This is the call flow for adding video mid-session in single mode. Note that in this situation,
the existing sessions with the 3PCR are not released. They are re-invited to add video to
the recording sessions.
Figure 8 Video Add Mid-Session in Single Mode (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 36 OF 95
Figure 9 Video Add Mid-Session in Single Mode (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 37 OF 95
2.1.15.7 Video Conferencing
Following is the call flow for a three-way conference call in dual mode that is deviceinitiated with Call Recording service for User A.
User A is in a call with User B and call recording is active. User A then puts this call on
hold and calls User C. User C answers and call recording is also active for this call. Now
User A creates a conference by invoking conferencing on the BroadWorks Telephony
Application Server. This results in a conference being created on the Media Server and
the users are connected to it.
There are two parts to this call. One is to set up the conference between the users and
the Media Server. The second is where call recording connections are set up between the
user being recorded and the Call Recording platform through the Media Server using the
conference bridge from the first part of the call. The first part of the call follows the generic
conference call flow on the Application Server. In the second part of the call, User A is
connected to the conference.
There are two call recordings created, one for the User A-B call and another for the User
A-C call.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 38 OF 95
Figure 10 Three-Way Conference Call in Dual Mode (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 39 OF 95
Figure 11 Three-Way Conference Call in Dual Mode (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 40 OF 95
Figure 12 Three-Way Conference Call in Dual Mode (c)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 41 OF 95
Figure 13 Three-Way Conference Call in Dual Mode (d)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 42 OF 95
2.1.15.8 Blind Transfer
In a blind transfer, a user is transferred to another party, and the user performing the
transfer does this without talking to the party who is receiving the call. In the following call
flow, User B is transferring the call with User A to User C. User A has call recording active
and has two call recordings associated with it. One is before the transfer for the call
between User A and User B and one is after the transfer between User A and User C.
Figure 14 Blind Transfer (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 43 OF 95
Figure 15 Blind Transfer (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 44 OF 95
Figure 16 Blind Transfer (c)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 45 OF 95
2.1.15.9 Consultative Transfer
In a consultative transfer, the user transferring the call talks to the target of the transfer
prior to completing the transfer. Following is a call flow for a consultative transfer in which
all users have call recording active before the transfer. For clarity, only the transactions for
User A are shown in the call flow. User B is in calls with User A and User C. User B then
“consult transfers” User A to User C. Once the transfer is complete, the 3PCR, User A,
and User C are reconnected to record audio and video.
Figure 17 Consultative Transfer (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 46 OF 95
Figure 18 Consultative Transfer (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 47 OF 95
2.1.15.10 Failure Cases
2.1.15.10.1 Failure to Successfully Negotiate Video with 3PCR Platform
The call recording parameters, continueCallAfterVideoRecordingFailure and
continueCallAfterRecordingFailure, are set to “true”. The video negotiation with the
3PCR platform fails and the resulting call recording behavior is as shown.
Audio streams are recorded.
The video is streamed between the users; however, it is not recorded.
Figure 19 Video Failure at 3PCR (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 48 OF 95
Figure 20 Video Failure at 3PCR (b)
2.1.15.10.2 Failure to Successfully Negotiate Video with Media Server
The call recording parameters, continueCallAfterVideoRecordingFailure and
continueCallAfterRecordingFailure, are set to “true”. The video negotiation with the
Media Server fails and the resulting call recording behavior is as shown.
Audio streams are recorded.
The video is streamed between the users; however, it is not recorded.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 49 OF 95
Figure 21 Video Failure at Media Server (a)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 50 OF 95
Figure 22 Video Failure at Media Server (b)
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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.
Figure 23 Audio and Video Failure at 3PCR Platform
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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.
Figure 24 Audio and Video Failure at Media Server
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Execution Use Cases
Basic Video Call Recording
For this use case, the user recording the call has the Call Recording service set to
“Always”.
2.2.2
2.2.3
2.2.4
1)
The 3PCR platform is set to record video.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
The user originates a call or receives a call with video.
4)
The audio and video portions of the entire call are automatically recorded and saved
to the 3PCR platform without any user interaction.
Mid-Session Video Call Recording
1)
The 3PCR platform is set to record video.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
The user is in an audio-only call with call recording active.
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)
The 3PCR platform is put on hold.
6)
The 3PCR platform is offered the new SDP to add video and updated metadata.
7)
The 3PCR platform answers and accepts the video SDP.
8)
The existing call recording continues with audio and video from the call.
Video Recording Disabled
1)
The 3PCR platform is set to record audio only.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
The user originates or terminates an audio and video call.
4)
The video is not streamed end to end between the users.
5)
Only the audio portion of the call is streamed and recorded.
Video Auto Attendant
1)
The 3PCR platform is set to record video.
2)
The user is assigned the Call Recording service and the service is enabled so that it
always records calls.
3)
The user terminates a call to the Auto Attendant with video.
4)
The Auto Attendant plays a video announcement and then transfers the call to
another user who streams video as well.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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.
Video Negotiation Failure
1)
The 3PCR platform is set to record video.
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 video call is allowed to continue in the event of a call
recording failure, provision the system-level continueCallAfterVideoRecordingFailure
call recording parameter.
To determine whether a call recording for a video call is supported, provision the
system-level supportVideoRec recording platform parameter.
Client Interaction Use Cases
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 55 OF 95
3
Provisioning Impacts
3.1
Configuration Data
3.1.1
Recording Platform Parameter
Name
supportVideoRec
3.1.2
Field Type
Required?
Validation
Values
Default Value
Boolean
Yes
True, False
False
System Call Recording Parameter
Name
Field Type
Required?
Validation
Values
Default Value
continueCallAfterVideoRecordingFailure
Boolean
Yes
True, False
True
3.2
Centralized Configuration Data
3.2.1
Data Types
There is no impact.
3.2.2
Media Server Subsystem
3.2.2.1
Add videoCodecs to CFW Level
A new level, videoCodecs, is added to the CFW level.
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.
Add videostreammixerbe to Input Channels Level
The videostreammixerbe input channel is added. It is enabled and has no default severity.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 56 OF 95
3.3
Web Portal Impacts
There is no impact.
3.4
3.4.1
Application Server CLI Impacts
Summary
AS_CLI
Service
Level
Commands
CallRecording
get
set
Platform
get
add
set
CallRecording
Platform
Figure 25 AS_CLI Call Recording Platform Changes
3.4.2
CallRecording/Platform Context
1)
AS_CLI/Service/CallRecording/Platform/get
Location within CLI Tree:
AS_CLI/Service/CallRecording/Platform
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view the list of recording platforms and their
attributes.
Example:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Location within CLI Tree:
AS_CLI/Service/CallRecording/Platform
Command Format:
add
Add
, String {1 to 80 characters}
, IP address | host | domain (1 to 80
chars)
, Integer {1 to 65535}
, Choice = {udp, tcp, unspecified}
, Choice = {dual, single}
, Choice = {1.0, 2.0}
, Choice = {false, true}
[, Multiple Choice = {description}]
, String (1 to 80 characters)
Command Definition and Usage:
This command is used to add a recording platform to the system.
Parameter Definitions (include default value, if any):
supportVideoRecording
This parameter determines if video call recording is
supported.
Example:
$ AS_CLI/Service/CallRecording/Platform>add
dualTest 15.16.57.11 5070 unspecified dual 2.0
true description “desktop dual sipp script”
… Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 58 OF 95
3)
AS_CLI/Service/CallRecording/Platform/set
Location within CLI Tree:
AS_CLI/Service/CallRecording/Platform
Command Format:
set
set
, String {1 to 80 characters}
, Multiple Choice = {netAddress, port, transportType,
mediaStream, systemDefault, schemaVersion, supportVideoRecording,
description}
, IP address | host | domain (1 to
80 chars)
, Integer {1 to 65535}
, Choice = {udp, tcp,
unspecified}
, Choice = {dual, single}
, String = true
, Choice = {1.0, 2.0}
, Choice = {false,
true}
, String (1 to 80 characters)
Command Definition and Usage:
This command is used to modify the recording platform attribute.
Parameter Definitions (include default value, if any):
supportVideoRecording
This parameter determines if video call recording is
supported.
Example:
$ AS_CLI/Service/CallRecording/Platform>set
dualTest supportVideoRecording true
… Done
3.4.3
Call Recording Context
1)
AS_CLI/Service/CallRecording/get
Location within CLI Tree:
AS_CLI/Service/CallRecording
Command Format:
get
get takes no parameters
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 59 OF 95
Command Definition and Usage:
This command is used to view the Call Recording service attributes.
Example:
$ AS_CLI/Service/CallRecording>get
continueCallAfterRecordingFailure = false
maxConsecutiveFailures = 1
maxResponseWaitTimeMilliseconds = 3000
refreshPeriodSeconds = 10
continueCallAfterVideoRecordingFailure = false
2)
AS_CLI/Service/CallRecording/set
Location within CLI Tree:
AS_CLI/Service/CallRecording/set
Command Format:
set
set
, Multiple Choice = {
continueCallAfterRecordingFailure, refreshPeriodSeconds,
maxConsecutiveFailures, maxResponseWaitTimeMilliSeconds,
continueCallAfterVideoRecordingFailure}
, Choice = {false, true}
, Integer = {1 to 10}
, Integer = {100 to
10000}
, Integer = {10 to 300}
, Choice = {false,
true}
Command Definition and Usage:
This command is used to modify the Call Recording service attributes.
Parameter Definitions (include default value, if any):
continueCallAfterVideoRecordingFailure
This parameter allows a video call to
continue after an attempt to record
the call has failed.
Example:
$ AS_CLI/Service/CallRecording> set
continueCallAfterVideoRecordingFailure false
...Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 60 OF 95
3.5
3.5.1
Media Server CLI Impacts
Summary
MS_CLI
Applications
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
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/Dialog/Security
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view DialogSecurity-related attributes.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/Dialog/Security
Command Format:
set
Set
, Multiple Choice = {maxVxmlTransitionCount,
maxHttpPostCount, maxHttpGetCount,
maxHttpGetTimeoutInSeconds, maxDownloadedSizeInMB,
maxRecordedSizeInMB, maxDepthOfEcmaScriptRecursion,
maxDepthOfSubDialogRecursion}
, Integer {1 to 1000}
, Integer {1 to 1000}
, Integer {1 to 1000}
, Integer {1 to 120}
, Integer {1 to 100}
, Integer {1 to 600}
, Integer {1 to 100}
, Integer {1 to 100}
Command Definition and Usage:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 62 OF 95
This command is used to modify DialogSecurity-related attributes.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/IVR
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view Interactive Voice Response (IVR)related
attributes, such as the memory size of the IVR.
Example:
$MS_CLI/Applications/MediaStreaming/Services/IVR> get
ivrResourcesRatio = 75
memorySizeInMB =
audioDbUserId =
audioDbPassword =
intraFrameRestartTimeoutInMilliseconds = 500
2)
MS_CLI/Applications/MediaStreaming/Services/IVR/set
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/IVR
Command Format:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 63 OF 95
set
set
, Multiple Choice = {ivrResourcesRatio,
memorySizeInMB, audioDbUserId, audioDbPassword,
intraFrameRestartTimeoutInMilliseconds}
, Integer {5 to 95}
, Integer {1 to 100000}
, String {0 to 255 characters}
, String {0 to 255 characters}
, Integer {0 to 500}
Command Definition and Usage:
This command is used to modify Interactive Voice Response (IVR) related
attributes, such as memory size of the IVR and the maximum number of
ports allotted to the IVR.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/Conferencing
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view conferencing-related attributes, such as the
jitter buffer size.
Example:
$MS_CLI/Applications/MediaStreaming/Services/Conferencing > get
jitterBufferSizeInMilliseconds = 60
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 64 OF 95
2)
MS_CLI/Applications/MediaStreaming/Services/Conferencing/set
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Services/Conferencing
Command Format:
set
set
, Multiple Choice =
{jitterBufferSizeInMilliseconds}
, Integer {20 to 160}
Command Definition and Usage:
This command is used to modify conferencing-related attributes.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/CFW
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view the Control Channel Framework (CFW)-related
attributes.
Example:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/CFW
Command Format:
set
set
, Multiple Choice = {listeningPort,
enableCfw, enableStrictMscIvrValidation,
enableStrictMscMixerValidation,
enableStrictSrgsValidation,
maxRecordingSizeInMB,
activeTalkerEnergyWindowInMilliseconds,
activeTalkerEnergyThreshold}
, Integer {1024 to 65535}
, Choice = {false, true}
, Choice = {false, true}
, Choice = {false, true}
, Choice = {false, true}
, Integer {5 to 1000}
, Integer {20 to 5000}
, Integer {1 to 1000}
Command Definition and Usage:
This command is used to modify CFW-related attributes, such as the CFW
port range and type of service. In addition this command
is used to set CFW session parameters for negotiating
with a remote CFW device.
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW> set
maxRecordingSizeInMB 500
...Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view the list of video codecs that can be used
for Real-Time Transport Protocol (RTP) streaming with the Control
Channel Framework (CFW) service, in order of preference.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs
Command Format:
add
add
, Choice = {h263-1998, h263-2000, h264}
Command Definition and Usage:
This command is used to add a video codec to the list of video codecs
that can be used for Real-Time Transport Protocol (RTP) streaming with
the Control Channel Framework (CFW) service, in order of preference.
New video codecs are added to the end of the list.
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs> add h264
...Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 67 OF 95
3)
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs/delete
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/CFW/VideoCodecs
Command Format:
delete
delete
, Choice = {h263-1998, h263-2000, h264}
Command Definition and Usage:
This command is used to delete a video codec from the list of codecs
used for Real-Time Transport Protocol (RTP) streaming with the Control
Channel Framework (CFW) service.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/SIP
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view Session Initiation Protocol (SIP) related
attributes.
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
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 68 OF 95
2)
MS_CLI/Applications/MediaStreaming/Interfaces/SIP/set
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/SIP
Command Format:
set
set
, Multiple Choice = {listeningPort,
retransmissionDelay200OKInMilliseconds,
maxRetransmission200OK,
t1, t2, supportTCP, acceptDTMFRelay,
routeAdvanceTimeoutInSeconds}
, Integer {1024 to 65535}
, Integer {100 to
10000}
, Integer {0 to 20}
, Choice = {500, 1000, 2000, 5000, 7000, 9000}
, Choice = {4000, 6000, 8000, 10000}
, Choice = {false, true}
, Choice = {false, true}
, Integer {0 to 64}
Command Definition and Usage:
This command is used to modify Session Initiation Protocol (SIP)
related attributes, such as the Real-Time Transport Protocol (RTP)
port range and type of service.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR
Command Format:
get
get takes no parameters
Command Definition and Usage:
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/ASR
Command Format:
set
Set
, Multiple Choice = {channelType,
sessionAuditPeriodInSeconds,
sessionAuditTimeoutInSeconds,
vendor}
, Choice = {TCP, TLS}
, Integer {0 to 600}
, Integer {0 to 600}
, Choice = {default, lumenvox, loquendo}
Command Definition and Usage:
This command is used to modify 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> set
sessionAuditTimeoutInSeconds 2
...Done
3.5.9
Applications/MediaStreaming/Interfaces/MRCP/TTS Context
1)
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS/get
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 70 OF 95
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view the current Media Resource Control Protocol
(MRCP) session parameters that are used to communicate with the Text-toSpeech (TTS) server.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS
Command Format:
set
set
, Multiple Choice = {channelType,
sessionAuditPeriodInSeconds,
sessionAuditTimeoutInSeconds,
speakerProfile, fetchHint, vendor}
, Choice = {TCP, TLS}
, Integer {0 to 600}
, Integer {0 to 600}
, String {0 to 255 characters}
, Choice = {none, prefetch, safe}
, Choice = {default, loquendo, nuance_v8,
nuance_v9}
Command Definition and Usage:
This command is used to modify the Media Resource Control Protocol (MRCP)
session parameters that are used to communicate with the Text-to-Speech
(TTS) server.
Example:
$MS_CLI/Applications/MediaStreaming/Interfaces/MRCP/TTS> set
sessionAuditTimeoutInSeconds 2
...Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 71 OF 95
3.5.10 Applications/MediaStreaming/GeneralSettings Context
1)
MS_CLI/Applications/MediaStreaming/GeneralSettings/get
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/GeneralSettings
Command Format:
get
get takes no parameters
Command Definition and Usage:
This command is used to view the general settings for media streaming,
such as the logging behavior of the Media Server, the length of the
Simple Mail Transfer Protocol (SMTP) timeout, and the maximum number
of cache files to maintain.
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
Location within CLI Tree:
MS_CLI/Applications/MediaStreaming/GeneralSettings
Command Format:
Set
Set
, Multiple Choice = {smtpTimeoutInSeconds,
mxRecordLookup, maxCacheFiles, numAudioProcesses,
numVideoProcesses, recycleHttpConnections,
offerSdpIpAddressType, httpTimeoutInSeconds}
, Integer {0 to 180}
, Choice = {false, true}
, Integer {1 to 999}
, Integer {3 to 4}
, Integer {0 to 4}
, Choice = {false, true}
, Choice = {ipv4, ipv6,
altcIpv4Legacy}
, Integer {1 to 600}
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 72 OF 95
Command Definition and Usage:
This command is used to modify the system-related attributes, such as
the log level. NOTE: To activate a modified value of IVRResourcesRatio
attribute, restart the Media Server.
Example:
$MS_CLI/Applications/MediaStreaming/GeneralSettings> set
httpTimeoutInSeconds 2
...Done
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 73 OF 95
3.6
Open Client Interface-Provisioning (OCI-P) Impact
3.6.1
Summary
The following new command has been added:
SystemCallRecordingAddPlatformRequest20
The following commands have been modified:
SystemCallRecordingGetPlatformListRequest
SystemCallRecordingModifyPlatformRequest
SystemCallRecordingGetRequest
SystemCallRecordingModifyRequest
The following command has been deprecated:
3.6.2
3.6.2.1
SystemCallRecordingAddPlatformRequest19
Command Impacts
SystemCallRecordingGetPlatformListRequest
Authorization level: Group
XML Schema file: OCISchemaServiceCallRecording.xsd
true
false
Get list of Call Recording platforms.
The response is either SystemCallRecordingGetPlatformListResponse or
ErrorResponse.
true
false
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.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 74 OF 95
3.6.2.2
SystemCallRecordingAddPlatformRequest20
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
true
false
Add a Call Recording platform.
The response is either a SuccessResponse or an ErrorResponse.
3.6.2.3
SystemCallRecordingModifyPlatformRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
true
false
Modify the specified Call Recording platform.
The response is either a SuccessResponse or an ErrorResponse.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 75 OF 95
3.6.2.4
SystemCallRecordingGetRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
true
false
Request the system level data associated with Call Recording.
The response is either a SystemCallRecordingGetResponse or an
ErrorResponse.
true
false
Response to SystemCallRecordingGetRequest.
3.6.2.5
SystemCallRecordingModifyRequest
Authorization level: System
XML Schema file: OCISchemaServiceCallRecording.xsd
true
false
Modify the system level data associated with Call Recording.
The response is either a SuccessResponse or an ErrorResponse.
3.6.3
3.6.4
Deprecated Commands
Command:
SystemCallRecordingAddPlatformRequest19
Replaced By:
SystemCallRecordingAddPlatformRequest20
Behavior Impacts:
The supportVideoRecording parameter is set to “false”.
Reporting Impacts
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 77 OF 95
3.7
Application Server Query User/Query Group Impacts
There is no impact.
3.8
Application Server Enterprise Migration Tool Impacts
There is no impact.
3.9
External Authentication Impacts
There is no impact.
3.10 Application Server Portal API Impacts
There is no impact.
3.11 Network Server Location API Impacts
There is no impact.
3.12 NSSync API Impacts
There is no impact.
3.13 Application Server Dump Impacts
There is no impact.
3.14 BroadCloud Dump Impacts
There is no impact.
3.15 Service Details and Licensing
There is no impact. This feature enhances the existing Call Recording service to support
video call recordings.
3.16 Service License Reporting Impact
There is no impact.
3.17 Call Detail Server SOAP Interface
There is no impact.
3.18 Treatments
There is no impact.
3.19 Media Announcements (Audio and Video)
There is no impact.
3.20 BCCT Impacts
There is no impact.
3.21 Device Management Impacts
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
Generation of Accounting Records
There is no impact.
4.3
Impact to Accounting Fields (CDR)
There is no impact.
4.4
Original Called Reason and Redirection Reason
This is not applicable.
4.5
Related Call ID
This is not applicable.
4.6
Example
There is no example.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 79 OF 95
5
System Management Impacts
5.1
5.1.1
Performance Management Impacts
New Counters
The counters in the table that follow are added with this activity.
Name:
MIB:
Module:
Description:
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:
Whenever a user’s call recording records video.
bwCallRecordingSPVideoRecordings
BW-Execution.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:
Whenever users in the service provider record video calls.
bwCallRecordingGroupVideoRecordings
BW-Execution.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
Whenever users in a group record video calls.
Modified Counters
There is no impact.
5.1.3
Deleted Counters or Module
There is no impact.
5.2
5.2.1
Fault Management Impacts
New Alarms
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 80 OF 95
5.2.2
Modified Alarms
There is no impact.
5.3
Scripts and Tools
There is no impact.
5.4
EMS Integration Impacts
The Element Management System (EMS) panel for CFW is modified to include a new
Video Codecs collection.
Figure 27 CFW – Video Codecs
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 81 OF 95
6
Execution/Call Processing Impacts
6.1
CAP Interface Impact
There is no impact.
6.2
Xtended Services Interface (Xsi) Impact
There is no impact.
6.3
6.3.1
SIP/MGCP Interface Impact
Summary
There is no impact.
6.3.2
SIP Header/MGCP Command
There is no impact.
6.3.3
SIP Parameter/MGCP Signal/Event
There is no impact.
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
The call recording starts after the Answer Confirmation service
accepts the call.
Auto Attendant
For information, see section 2.1.12.1 Auto Attendant.
BroadWorks Anywhere
Calls terminating to a BroadWorks Anywhere subscriber are
recorded on behalf of the BroadWorks Anywhere user, even if the
call is answered by the BroadWorks Anywhere location.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
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
subscriber’s mobile number provisioned in the BroadWorks
Mobility service.
Call Center
For information, see section 2.1.12.2 Call Center.
Call Forwarding Always
If the call terminates to a user with the Call Forwarding Always
service active, the call is not recorded for the subscriber with Call
Forwarding Always active.
Call Park
For information, see section 2.1.10 Call Park.
Call Pickup
If a user who picks up the call has Call Recording, then the call is
recorded.
Call Me Now
All calls that terminate to a BroadWorks Call-Me-Now subscriber
are recorded after the subscriber answers the call.
Call Transfer
For information, see section 2.1.11 Call Transfer.
Music On Hold
If a user with the Call Recording service is placed on hold, the
call continues to be recorded.
Push To Talk
If a user with the Call Recording service instantiates a one-way
voice path Push-To-Talk call, then that is one recording.
If the other party involved in the one-way voice path Push-ToTalk conversation wants to instantiate voice path in the other
direction, then that is another recording.
Remote Office
Calls terminating to a remote office subscriber are recorded on
behalf of the remote office user, even if the call is answered by a
remote office location.
Route Point
For information, see section 2.1.12.3 Route Point.
Sequential Ringing
If the terminating subscriber has Sequential Ringing and Call
Recording services, the call is only recorded for the subscriber if
that subscriber answers the call.
If one of the sequential ring destinations answers the call, it is not
recorded for the sequential ring subscriber.
If the destination that answers the call has the Call Recording
service, then the call is recorded for the answering party.
Shared Call Appearance
Calls terminating to a shared call appearance subscriber are
recorded on behalf of the shared call appearance user, even if
the call is answered by a shared call appearance location.
An alternate shared call appearance location of a subscriber who
created an n-way conference call would not be allowed to bridge
into the conference call when the bridging subscriber has the Call
Recording service enabled.
Simultaneous Ringing
If the terminating subscriber has the Simultaneous Ringing and
Call Recording services, the call is only recorded for the
subscriber if that subscriber answers the call.
If one of the simultaneous ring destinations answers the call, it is
not recorded for the simultaneous ring subscriber.
If the destination that answers the call has the Call Recording
service, then the call is recorded for the answering party.
Three-Way Calling,
N-Way Calling
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
For information, see section 2.1.9 Video Conference.
11-BD5812-00
PAGE 83 OF 95
Service
Interaction
Music/Video On Hold
If a user with the Call Recording service is placed on hold with
video, the call continues to be recorded with the addition of video.
For more information, see section 2.1.7 Music/Video On Hold
Service.
Video Add-On
If a user with the Call Recording service uses Video Add-On to
terminate video to a separate device, that video is recorded.
For more information, see section 2.1.8 Video Add-On Service.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 84 OF 95
7
Client Application Impacts
7.1
OCI-P/CAP Impacts
There is no impact.
7.2
Call Control Impacts
There is no impact.
7.3
7.3.1
Window Impacts
Configuration Dialog Impacts
There is no impact.
7.3.2
Supplemental Interface Impacts
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 85 OF 95
8
Deployment/Operational Impacts
8.1
Configuration File Impacts
There is no impact.
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
Media Server Installation Impacts
On the Media Server, a new process named videostreammixerbe implements the video
relay function. This process is owned by root and “set owner user ID” (SUID). The file is
located in /usr/local/broadworks/apps/MediaStreaming_/bin along with other
executables.
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
Media Server Upgrade Impacts
The new centralized configuration attributes described in section 3.2.2 Media Server
Subsystem are added. The default values are as specified in that section.
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
Media Server Rollback Impacts
The new centralized configuration attributes added on an upgrade are removed on a
rollback.
8.5
Security Impacts
There is no impact.
8.6
Scheduled Tasks
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 86 OF 95
8.7
Third-Party Software
There is no impact.
8.8
Server Logging Impacts
The videostreammixerbe input channel is added.
Channel Names
Videostreammixerbe (new)
Applies To
Media Server centralized configuration
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
There is no special configuration.
Client Application Impacts
Deployment Studio Impacts
There is no impact.
8.9.2
Configuration Impacts
There is no impact.
8.9.3
Host Application Impacts
There is no impact.
8.9.4
Third-Party Integration Impacts
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 87 OF 95
9
System Engineering Impacts
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
Media Server Memory Impacts
The videostreammixerbe process allocates approximately ~140 KB of memory per
session. On a 4000-port Media Server, the amount of memory used by
videostreammixerbe is approximately 500 MB. This represents 30 RTP packets per
session or enough to buffer one 4-Common Intermediate Format (CIF) instantaneous
decoder refresh (IDR) frame while receiving another one for each session.
9.3
Disk Usage Impacts
There is no impact.
9.4
Port Usage Impacts
When video is negotiated with a device, the Media Server uses one generic port for video,
with uLaw being one generic port resource when the video resolution being relayed is
below 720p HD. Otherwise, two generic ports are used. This is in addition to resources
acquired for audio.
9.5
Hardware Impacts
There is no impact.
9.6
Client Application Messaging Impacts
There is no impact.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 88 OF 95
10 Service Patch Information
This feature is not being patched.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 89 OF 95
11 Restrictions and Limitations
The limitation on the video codecs available for recording is explained in section 2.1.2.3
Video Codec Selection for Recording.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 90 OF 95
Acronyms and Abbreviations
This section lists the acronyms and abbreviations found in this document. The acronyms
and abbreviations are listed in alphabetical order along with their meanings.
3PCR
Third Party Call Recording
AAC
Account/Authorization Code
ABNF
Augmented Backus-Naur Form
ACD
Automatic Call Distribution
ACL
Access Control List
ACR
Anonymous Call Rejection
Admin
Administrator
AMS
Access Mediation Server
API
Application Programming Interface
AS
Application Server
AVP
Attribute Value Pair
BCCT
BroadWorks Common Communication Transport
BW
BroadWorks
CAP
Client Application Protocol
CBF
Communication Barring – Fixed
CCRS
Call Center Reporting Server
CDR
Call Detail Record
CDS
Call Detail Server
CFA
Call Forwarding Always
CFB
Call Forwarding Busy
CFNA
Call Forwarding No Answer
CFNR
Call Forwarding Not Reachable
CFS
Call Forwarding Selective
CFW
Control Channel Framework
CIF
Common Intermediate Format
CLI
Command Line Interface
CLID
Calling Line ID
CORBA
Common Object Request Broker Architecture
CPL
Call Processing Language
CPU
Central Processing Unit
CRS
Call Recording Server
CS
Conferencing Server
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 91 OF 95
CSCF
Call Session Control Function
CSTA
Computer Supported Telecommunications Applications
CSV
Comma Separated Value
CTI
Computer Telephony Integration
CWT
Call Waiting Tone
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
Directed Call Pickup with Barge-in
DTMF
Dual-Tone Multi-Frequency
EMS
Element Management System
EOCP
Enhanced Outgoing Calling Plan
EV
ExtraView
FAC
Feature Access Code
FQDN
Fully Qualified Domain Name
FR
Feature Request
FS
Functional Specification
FTP
File Transfer Protocol
HCB
Hierarchical Communication Barring
HD
High Definition
HTML
Hypertext Markup Language
HTTP
Hypertext Transfer Protocol
Hz
Hertz
ICP
Incoming Calling Plan
IDR
Instantaneous Decoder Refresh
IMAP
Internet Message Access Protocol
IMS
IP Multimedia Subsystem
IP
Internet Protocol
IVR
Interactive Voice Response
KB
Kilobyte
LO
Local
LPS
Local Premium Service
LSSGR
LATA Switching Systems Generic Requirements
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 92 OF 95
MB
Megabyte
MGCP
Media Gateway Control Protocol
MIB
Management Information Base
MOC
Microsoft Office Communications
MR
Market Request
MS
Media Server
NCOS
Network Class of Service
NE
Network Element
NS
Network Server
NSSync
Network Server Synchronization
OAM&P
Operations, Administration, Management, and Provisioning
OCI
Open Client Interface
OCI-C
Open Client Interface-Call Control
OCI-P
Open Client Interface-Provisioning
OCI-R
Open Client Interface-Reporting
OCP
Outgoing Calling Plan
OCS
Open Client Server
ODP
Outgoing Digit Plan
OID
Object Identifier
OOTB
Out-of-the-Blue
OS
Operating System
OSS
Operations Support System
PBX
Private Branch Exchange
PCV
P-Charging-Vector
PDF
Portable Document Format
PM
Performance Measurement
PS
Provisioning Server
PSTN
Public Switched Telephone Network
PTT
Push To Talk
RAM
Random Access Memory
RFC
Request for Comments
RTP
Real-Time Transport Protocol
SAC
Session Admission Control
SBC
Session Border Controller
SCA
Shared Call Appearance
SCA
Selective Call Acceptance
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 93 OF 95
SCR
Selective Call Rejection
SDP
Session Description Protocol
SDR
Session Data Replication
SIP
Session Initiation Protocol
SMAP
Software Management Application Protocol
SMDI
Simplified Message Desk Interface
SMPP
Short Message Peer-to-Peer Protocol
SMS-C
Short Message Service Center
SMTP
Simple Mail Transfer Protocol
SNMP
Simple Network Management Protocol
SOAP
Simple Object Access Protocol
SP
Service Pack
SRV
Service Locator
SSH
Secure Shell
SUID
Set Owner User ID
TAS
Telephony Application Server
TCP/IP
Transmission Control Protocol/Internet Protocol
TDM
Time Division Multiplexing
TO
Toll
TPS
Toll Premium Services
URI
Uniform Resource Identifier
URL
Uniform Resource Locator
VMS
Voice Mail System
VoIP
Voice Over Internet Protocol
WebDAV
Web-based Distributed Authoring and Versioning
WS
Web Server
XML
eXtensible Markup Language
XS
Execution Server
XSD
XML Schema Definition
Xsi
Xtended Services Interface
Xsp
Xtended Services Platform
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 94 OF 95
References
[1] BroadSoft, Inc. 2011. BroadWorks Call Recording Interface Guide, Release 18.0.
Available from BroadSoft at xchange.broadsoft.com.
[2] BroadSoft, Inc. 2012. BroadWorks Media Server EMS Configuration Management
Guide, Release 19.0. Available from BroadSoft at xchange.broadsoft.com.
[3] BroadSoft, Inc. 2013. BroadWorks Call Recording – Start/Stop/Pause/Resume User
Control Feature Description, Release 20.0. Available from BroadSoft at
xchange.broadsoft.com.
[4] BroadSoft, Inc. 2013. Video Conferencing Support Feature Description, Release
20.0. Available from BroadSoft at xchange.broadsoft.com.
[5] Portman, L., Lum, H., Johnston, A., Hutton, A., “The SIP-based Media Recording
Protocol (SIPREC)”, draft-portman-siprec-protocol-03, Internet Engineering Task
Force, March 1, 2011. Available from http://www.ietf.org.
[6] Ravindranath, R., Ravindran, P., Kyzivat, P., “Session Initiation Protocol (SIP)
Recording Metadata Format”, draft-ram-siprec-metadata-format-01, Internet
Engineering Task Force, March 8, 2011. Available from http://www.ietf.org.
[7] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J, Sparks R.,
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”,
RFC 4574, August 2006. Available from http://www.ietf.org.
[9] Holmberg, C., Burger, E., Kaplan, H., “Session Initiation Protocol (SIP) INFO Method
and Package Framework”, RFC 6086, January 2011. Available from
http://www.ietf.org.
[10] Schulzrinne, H., Petrack, S., “RTP Payload for DTMF Digits, TelephoneTones and
Telephony Signals”, RFC 2833, May 2000. Available from http://www.ietf.org.
[11] Schulzrinne, H., Taylor, T., “RTP Payload for DTMF Digits, TelephoneTones and
Telephony Signals”, RFC 4733, December 2006. Available from http://www.ietf.org.
[12] Schulzrinne, H., Taylor, T., “Definition of Events for Modem Fax, and Text Telephony
Signals”, RFC 4734, December 2006. Available from http://www.ietf.org.
[13] BroadSoft, Inc. 2013. BroadWorks Call Center Solution Guide, Release 19.0.
Available from BroadSoft at xchange.broadsoft.com.
[14] BroadSoft, Inc. 2010. BroadWorks Network CTI Integration Feature Description,
Release 17.0. Available from BroadSoft at xchange.broadsoft.com.
[15] BroadSoft, Inc. 2013. BroadWorks Call Recording Interface Feature Description,
Release 18.0. Available from BroadSoft at xchange.broadsoft.com.
[16] Levin, O., Even, R., Hagendorf, P., “XML Schema for Media Control”, RFC 5168,
March, 2008. Available from http://www.ietf.org.
CALL RECORDING VIDEO SUPPORT
©
2013 BROADSOFT, INC.
11-BD5812-00
PAGE 95 OF 95