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

 

RecordingFilterCustomParameter

The RecordingFilterCustomParameter object represents a custom value, which is assigned to a call instance.

This custom value can be used for integration with third-party applications, like CRM, Salesforce Automation, Predictive Dialer etc.

For example, each call record inside database may store Marketing Campaign Id, which is used later to select all calls, that were made for a particular campaign.

 

Properties

Name of propertyTypeDescription
namestring

Unique name of the parameter. Name of parameter may consits of following characters:

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

Note 1:

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

  • param1
  • Param1
  • PARAM1

Note 2:

Following names are reserved and should not be used:

  • action
  • condition
  • filename
  • priority
valuestringValue of the custom parameter.

 

Example (in C#)

See example of method recordingFilterSave()

 

See Also