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

negotiated fax settings

Defines the settings of a negotiated fax session as it progresses.

Used by actions receive fax, send fax

language wrappers and examples

It contains the following properties:

PropertyAvailabilityDescription
data ratealwaysAn integer. The negotiated baud rate in bps, e.g., 9600 or 4800.
modemalwaysA string. The modem being used, e.g., V.17 or V.29.
remote subscriber idalwaysThe remote end ID string.

  • Examples:


    •     {
             "data_rate": 9600,
             "modem": "V17",
             "remote_subscriber_id": "12345"
          },
      
  • NegotiatedFaxSettings Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing the settings that have been negotiated during a fax session.

    public class NegotiatedFaxSettings 
    {
        // Members
        public int DataRate;
        public string Modem;
        public string RemoteSubscriberId;
    }
    

    Examples:

    • Get negotiated fax settings from a receive fax progress request:

      // Unpack the request
      var instanceInfo = new TelephonyRequest(Request).InstanceInfo;
      
      var receiveFaxProgress = (ReceiveFaxProgress)instanceInfo.ActionProgress;
      var negotiatedFaxSettings = receiveFaxProgress.NegotiatedSettings;
      var dataRate = negotiatedFaxSettings.DataRate;
      var modem = negotiatedFaxSettings.Modem;
      var remoteSubscriberId = negotiatedFaxSettings.RemoteSubscriberId;
      
  • NegotiatedFaxSettings Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing the settings that have been negotiated during a fax session.

    Public Class NegotiatedFaxSettings
        ' Members
        Public Property DataRate As Integer
        Public Property Modem As String
        Public Property RemoteSubscriberId As String
    End Class
    

    Examples:

    • Get negotiated fax settings from a receive fax progress request:

      ' Unpack the request
      Dim instanceInfo = New TelephonyRequest(Request).InstanceInfo
      
      Dim receiveFaxProgress As ReceiveFaxProgress = instanceInfo.ActionProgress
      Dim negotiatedFaxSettings = receiveFaxProgress.NegotiatedSettings
      Dim dataRate = negotiatedFaxSettings.DataRate
      Dim modem = negotiatedFaxSettings.Modem
      Dim remoteSubscriberId = negotiatedFaxSettings.RemoteSubscriberId
      
  • class NegotiatedFaxSettings

    A class representing the settings that have been negotiated during a fax session.

    Class synopsis:

    // Members:
    public int getDataRate()
    public String getModem()
    public String getRemoteSubscriberId()
    

    Examples:

    • Get negotiated fax settings from a receive fax progress request:

      TelephonyRequest myRequest = new TelephonyRequest(request);
      ReceiveFaxProgress faxProgress = (ReceiveFaxProgress)myRequest.getInstanceInfo().getActionProgress();
      NegotiatedFaxSettings settings = faxProgress.getNegotiatedSettings();
      
      int dataRate = settings.getDataRate();
      String modem = settings.getModem();
      String id = settings.getRemoteSubscriberId();
      
  • TelephonyRequest.get_action_progress()

    The Negotiated Fax Settings support class is represented by a dictionary found within the Action Progress.

    Examples:


    • my_request = TelephonyRequest(request)
      action_progress = my_request.get_action_progress()
      
      if action_progress.get("action") == "send_fax":
          progress = action_progress.get("progress")
          negotiated_settings = progress.get("negotiated_settings")
          
          data_rate = negotiated_settings.get("data_rate")
          modem = negotiated_settings.get("modem")
          remote_subscriber_id = negotiated_settings.get("remote_subscriber_id")
      
  • The NegotiatedFaxSettings class

    Introduction

    Represents the negotiated fax settings.

    Class synopsis

    class NegotiatedFaxSettings extends PropertyHolder {
    
        /* methods */
        public int getDataRate()
        public string getModem()
        public string getRemoteSubscriberId()
    }
    

    Examples:

    • Get negotiated fax settings from a receive fax progress request:

      $info = InstanceInfo::getInstanceInfo();
      $receiveFaxProgress = $info->getActionProgress();
      $negotiatedFaxSettings = $receiveFaxProgress->getNegotiatedFaxSettings();
      $dataRate = $negotiatedFaxSettings->getDataRate();
      $modem = $negotiatedFaxSettings->getModem();
      $remoteSubscriberId = $negotiatedFaxSettings->getRemoteSubscriberId();