Skip to main content
  • Products
    • Overview
    • Features
    • Screen Capture
    • Agent evaluation / score cards
    • Speech Analytics
    • Recording Announcement
    • Videos
    • Online demo
    • Quote
    • Download
  • Solutions
    • Businesses
    • Contact centers
    • Financial institutions
    • Healthcare
    • MiFID II compliance
    • Telecom service providers
    • Traders
  • Compatibility
    • AudioCodes
    • Avaya
    • BroadSoft
    • Cisco
    • Genband
    • IPC
    • Metaswitch
    • Oracle AcmePacket
    • SIPREC recording
    • Sonus
  • Documentation
    • User Guide
    • Administration Guide
    • Developer Guide
    • MiaRec v.3 (old) documentation
    • Resource library
    • Videos
  • Support
    • Submit a request
    • Check your existing requests
    • TeamViewer QuickSupport
  • Blog
  • Company
    • About MiaRec
    • Contact us
    • Our clients
    • Become a partner
    • News
    • Careers
    • Events

MiaRec SOAP API

  • MiaRec SOAP API Programmer's Guide
    • Gettings Started
      • Settings up the development environment
        • Obtaining the WSDL document and generating the stubs
      • Request and response framework
      • Learning from sample code
    • MiaRec Web Services
      • Intended Audience
      • Overview
    • Writing a Client Application
      • Setup
        • The HTTP header
        • The SOAP header
        • Setting the URL of the service to be accessed
      • Objects
        • RecordingFilter
          • RecordingFilterCustomParameter
      • Methods
        • getVersion
        • reloadConfig
        • recordingFilterLoad
        • recordingFilterLoadAll
        • recordingFilterSave
        • recordingFilterValidate
        • recordingFilterDelete
      • Exceptions
        • InvalidParameterException
        • InvalidSyntaxException
        • NotFoundException
    • Debugging
Home › MiaRec SOAP API Programmer's Guide › Writing a Client Application › Objects ›
 

RecordingFilter

The RecordingFilter object represents a configuration of recording filter (condition, action, filename etc).

 

Properties

Name of propertyTypeDescription
namestring

Unique filter name. Name of filter may consits of following characters:

  • Latin letters a-z, A-Z
  • Digits 0-9
  • Dash symbol (-)
  • Underscore symbol (_)
  • Space character ( )

Note 1:

Name is case insensitive. Following names are interpreted as the same:

  • filter1
  • Filter1
  • FILTER1

Note 2:

Special name is used for a default filter ("filter_").

Default filter is executed when no other filters match.

priorityint

Priority of filter. Filters with lower values are executed before the ones with higher values.

Note 1:

It is permitted that two and more filters have the same priority, but in this case order of filters' execution is not determined.

Note 2:

Priority can have negative values.

For example, -1.

actionstring

One of following:

  • record - record the call, which matches a condition
  • ignore - ignore the call, which matches a condition
  • rename - rename audio file of the call, which matches a condition. Note, this action is accepted only inside section "OnCallStop"
  • delete - delete audio file as well as record inside database for the call, which matches a condition. Note, this action is accepted only inside section "OnCallStop". This action may be usefull if very short calls (less than 5 seconds) should be automatically deleted.
conditionstring

Expression string, for example:

caller-number = '123'

Note 1:

Condition is ignored for default filter (with name "default_").

filenamestring

Filename format for calls, that match a condition.

For example:

C:\Sales\%{setup-time#%Y%m%d}\%{call-id}.mp3

Note 1:

This is optional parameter. If it is not specified than a default filename format is used (see parameter FileNameFormat inside MiaRec.ini file).

customParameters[]array of RecordingFilterCustomParameter

Optional custom parameters, which are assigned to call.

This can be used for storing custom data, which is used by third-party applications, like CRM.

 

 

 

Example (in C#)

See example of method recordingFilterSave()

 

 

 

See Also

  • Method recordingFilterLoad
  • Method recordingFilterValidate
  • Method recordingFilterSave
  • Object RecordingFilterCustomParameter

 

Child pages

  • RecordingFilterCustomParameter
‹ Objects up RecordingFilterCustomParameter ›
  • Printer-friendly version
  • Login to post comments
MiaRec, Inc. © 2020. All Rights Reserved. | Terms of Use | Privacy Statement | Cancellation Policy