CONNECTION_INFO NSSOAP Classes

The CONNECTION_INFO class contains connection information about a message that is on the fax server.

class CONNECTION_INFO {
  CONNECTION_STATUS connection_status; // Connection status for the message
  int               completion_code; // Numeric completion code
  string            completion_string; // Completion string
  int               extended_error; // Extended hardware error
  int               connection_seconds; // On-line and connected time
  int               connection_bps; // Highest connection rate
  int               page_count; // Total message pages
  int               pages_transferred; // Total pages transferred
  int               retry_count; // Number of retry attempts
  int               error_count; // Error count during transmission
  DateTime          start_time_utc; // Start time for processing
  string            protocol_state; // Protocol status string
  string            remote_ani; // Caller ID for received faxes
  string            receiver_info; // DID for received faxes
  string            remote_csid; // Remote CSID
  string            port_used; // Port that sent/recieved fax
  RECIPIENT         recipient; // Recipient for sent message
}

Members:
connection_status Specifies the connection status for the message.  Must be a member of the CONNECTION_STATUS enumeration.
 
enum CONNECTION_STATUS {
  Pending, // Queued for send
  Dialing, // Off hook and dialing
  Connecting, // Interpage handshaking
  Sending, // Data is being sent
  Receiving, // Data is being received
  Disconnecting, // Hanging up the line
  Completed, // Completed
  Aborting, // In process of aborting
  Generated, // Conversion completed
  Preprocessing // Currently being converted
}

completion_code Specifies a numeric completion code for a sent or received message.  The completion_code value is only meaningful once connection_status is set to Completed.

See the completion_code field in the Q_MESSAGE class for how to lookup a text error message based on the value of the completion_code field.
 
completion_string Specifies a completion string for a sent or received message that corresponds to the numeric completion_code value.
 
extended_error Contains an extended error code, useful for diagnosing fax transmission and hardware problems.
 
connection_seconds Specifies the number of seconds that a fax device was on-line and connected to a remote fax device, while sending or receiving a fax message
 
connection_bps Specifies the highest connection rate used while sending or receiving a fax.
 
page_count Specifies the page count of the message.
 
pages_transferred Specifies the number of pages transferred.
 
retry_count Specifies the number of times the message was retried due to a previous transmission failure.
 
error_count Specifies the number of fax errors that occurred during the transmission of fax pages.
 
start_time_utc Specifies the time in Coordinated Universal Time (UTC) when processing began on the message.
 
protocol_state A string that specifies the current activity on a fax port.  Can be one of the following values:

Value Meaning
Idle Queued for send
Dialing Off-hook and dialing
Answering Off-hook and answering the line
Transmitting Sending fax image data
Receiving Receiving fax image data
Pre Message Negotiating the connection prior to sending a fax page
Post Message Negotiating the connection after sending a fax page
Disconnecting Disconnecting

remote_ani Specifies the ANI (caller ID) for received messages.
 
receiver_info Specifies the DID for received messages.
 
remote_csid Specifies the CSID of the remote fax connection.
 
port_used Specifies the local fax port that was used to send or receive the fax.
 
recipient Contains a RECIPIENT object that includes the original recipient information that was provided when send_message was called.  This object is only set for messages in the send, sending and sent queue.

Remarks:
A CONNECTION_INFO object can be obtained by calling get_message, get_message_q or get_ports.

See Also:
Q_MESSAGE, PORT_INFO