By using the Aculab site, you agree with our use of cookies.

classify callee

This controls parameters used in the classification of the type of callee during a connect action.

Used by action connect

language wrappers and examples

It contains the following properties:

Property Required/Optional Default Description
enable optional true true or false. Whether to enable classification of the far end of the secondary call.
milliseconds timeout optional 5000 An integer. The timeout for classification in milliseconds.
hang up on answering machine optional true Hang up the secondary call if it is to an answering machine.
hang up on fax machine optional true Hang up the secondary call if it is to a fax machine.
answering machine ready to record optional - An answering machine ready to record object.

  • Examples:


    •     {
      		"enable" : true,
      		"milliseconds_timeout" : 10000,
      		"hang_up_on_answering_machine" : false,
      		"hang_up_on_fax_machine" : true,
      		"answering_machine_ready_to_record" :
      		{
      			"milliseconds_min_beep_duration" : 300,
      			"milliseconds_post_beep_silence" : 2000,
      			"milliseconds_no_beep_silence" : 10000,
      			"seconds_max_message_duration" : 30
      		}
      	}
      
  • ClassifyCallee Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing some parameters used in the classification of the type of callee on an outbound call.

    public class ClassifyCallee 
    {
        // Constructors
        public ClassifyCallee();
        public ClassifyCallee(int millisecondsTimeout);
        public ClassifyCallee(int millisecondsTimeout, bool hangUpOnAnsweringMachine);
        public ClassifyCallee(int millisecondsTimeout, bool hangUpOnAnsweringMachine, bool hangUpOnFaxMachine);
    
        // Members
        public int? MillisecondsTimeout;
        public bool? HangUpOnAnsweringMachine;
        public bool? HangUpOnFaxMachine;
        public AnsweringMachineReadyToRecord AnsweringMachineReadyToRecord;
        public void ConfigureAnsweringMachineReadyToRecord(AnsweringMachineReadyToRecord answeringMachineReadyToRecord);
    }
    

    Examples:

    • Configure classifying the callee. If it is an answering machine wait for the message to finish:

      var classify = new ClassifyCallee(10000, false, true);
      var answerMachineConfig = new AnsweringMachineReadyToRecord(300, 2000, 10000, 30);
      classify.ConfigureAnsweringMachineReadyToRecord(answerMachineConfig);
      
      var connectAction = new Connect("443069990123");
      connectAction.EnableCalleeClassification(classify);
      
  • ClassifyCallee Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing some parameters used in the classification of the type of callee on an outbound call.

    Public Class ClassifyCallee
        ' Constructors
        Public Sub New ()
        Public Sub New (millisecondsTimeout As Integer)
        Public Sub New (millisecondsTimeout As Integer, hangUpOnAnsweringMachine As Bool)
        Public Sub New (millisecondsTimeout As Integer, hangUpOnAnsweringMachine As Bool, hangUpOnFaxMachine As Bool)
    
        ' Members
        Public Property MillisecondsTimeout As Integer?
        Public Property HangUpOnAnsweringMachine As Bool?
        Public Property HangUpOnFaxMachine As Bool?
        Public Property AnsweringMachineReadyToRecord As Answeringmachinereadytorecord
        Public Function ConfigureAnsweringMachineReadyToRecord(answeringMachineReadyToRecord As Answeringmachinereadytorecord) As Void
    End Class
    

    Examples:

    • Configure classifying the callee. If it Is an answering machine wait for the message to finish:

      Dim classify = New ClassifyCallee(10000, False, True)
      Dim answerMachineConfig = New AnsweringMachineReadyToRecord(300, 2000, 10000, 30)
      classify.ConfigureAnsweringMachineReadyToRecord(answerMachineConfig)
      
      Dim connectAction = New Connect("443069990123")
      connectAction.EnableCalleeClassification(classify)
      
  • class ClassifyCallee extends JSONElement

    Represents the Classify Callee support class.

    Class synopsis:

    // Constructors:
    public ClassifyCallee()
    public ClassifyCallee(int millisecondsTimeout, boolean hangUpOnAnsweringMachine)
    public ClassifyCallee(int millisecondsTimeout, boolean hangUpOnAnsweringMachine, boolean hangUpOnFaxMachine)
    
    // Members:
    public void setEnable(boolean enable)
    public void setMillisecondsTimeout(int millisecondsTimeout)
    public void setHangUpOnAnsweringMachine(boolean enable)
    public void setHangUpOnFaxMachine(boolean enable)
    public void setAnsweringMachineReadyToRecord(AnsweringMachineReadyToRecord answeringMachineReadyToRecord)
    

    Examples:

    • Configure classifying the callee. If it is an answering machine wait for the message to finish:

      AnsweringMachineReadyToRecord answeringMachineOptions = new AnsweringMachineReadyToRecord();
      answeringMachineOptions.setMillisecondsMinBeepDuration(300);
      answeringMachineOptions.setMillisecondsPostBeepSilence(2000);
      answeringMachineOptions.setMillisecondsNoBeepSilence(10000);
      answeringMachineOptions.setSecondsMaxMessageDuration(30);
      
      ClassifyCallee classifyCalleeOptions = new ClassifyCallee();
      classifyCalleeOptions.setEnable(true);
      classifyCalleeOptions.setMillisecondsTimeout(10000);
      classifyCalleeOptions.setHangUpOnAnsweringMachine(false);
      classifyCalleeOptions.setHangUpOnFaxMachine(true);
      classifyCalleeOptions.setAnsweringMachineReadyToRecord(answeringMachineOptions);
      
  • class ClassifyCallee

    Represents the Classify Callee support class.

    Class synopsis:

    # ClassifyCallee object:
    ClassifyCallee(enable=True,
                   milliseconds_timeout=None,
                   hang_up_on_answering_machine=None,
                   hang_up_on_fax_machine=None,
                   answering_machine_ready_to_record=None)
    

    Examples:


    • answering_machine_options = AnsweringMachineReadyToRecord(milliseconds_min_beep_duration=300, 
                                                                milliseconds_post_beep_silence=2000, 
                                                                milliseconds_no_beep_silence=10000, 
                                                                seconds_max_message_duration=30)
      classify_callee = ClassifyCallee(enable=True,
                                       milliseconds_timeout=10000,
                                       hang_up_on_answering_machine=True,
                                       hang_up_on_fax_machine=True,
                                       answering_machine_ready_to_record=answering_machine_options)
      
  • The ClassifyCalleeConfiguration class

    Introduction

    Represents the callee classification configuration for a connect action.

    Class synopsis

    class ClassifyCalleeConfiguration {
    
        /* methods */
        public __construct($opts = array())
        public self setMillisecondsTimeout(int $msec)
        public self setHangUpOnFaxMachine(boolean $hang_up)
        public self setHangUpOnAnsweringMachine(boolean $hang_up)
        public self setAnsweringMachineReadyToRecordConfiguration(
            int $milliseconds_min_beep_duration,
            int $milliseconds_post_beep_silence,
            int $milliseconds_no_beep_silence,
            int $seconds_max_message_duration
        )
    }
    

    Examples:

    • Configure classifying the callee. If it is an answering machine wait for the message to finish:

      $classify_configuration = new \Aculab\TelephonyRestAPI\ClassifyCalleeConfiguration();
      $classify_configuration->setMillisecondsTimeout(10000)
          ->setHangupOnFaxMachine(true)
          ->setHangupOnAnsweringMachine(false)
          ->setAnsweringMachineReadyToRecordConfiguration(300, 2000, 10000, 30);
      $connect->setClassifyCallee($classify_configuration);