FAXSession

Since 13.0.0 AMI Events Found this useful? Upvote it. ×

Raised in response to FAXSession manager command

Last reviewed 2026-04-14

FAXSession
Arguments
  • ActionID
  • SessionNumber - The numerical identifier for this particular session
  • Operation - FAX session operation type
    • gateway
    • V.21
    • send
    • receive
    • none
  • State - Current state of the FAX session
    • Uninitialized
    • Initialized
    • Open
    • Active
    • Complete
    • Reserved
    • Inactive
    • Unknown
  • ErrorCorrectionMode - Whether error correcting mode is enabled for the FAX session. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'
    • yes
    • no
  • DataRate - Bit rate of the FAX. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'.
  • ImageResolution - Resolution of each page of the FAX. Will be in the format of X_RESxY_RES. This field is not included if the operation is anything other than Receive/Transmit.
  • PageNumber - Current number of pages transferred during this FAX session. May change as the FAX progresses. This field is not included when operation is 'V.21 Detect' or if operation is 'gateway' and state is 'Uninitialized'.
  • FileName - Filename of the image being sent/received for this FAX session. This field is not included if Operation isn't 'send' or 'receive'.
  • PagesTransmitted - Total number of pages sent during this session. This field is not included if Operation isn't 'send' or 'receive'. Will always be 0 for 'receive'.
  • PagesReceived - Total number of pages received during this session. This field is not included if Operation is not 'send' or 'receive'. Will be 0 for 'send'.
  • TotalBadLines - Total number of bad lines sent/received during this session. This field is not included if Operation is not 'send' or 'received'.

User Notes

No notes yet. Be the first to contribute a tip or example.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Moderated before publishing. Email never shown.

Related

ResourceListDetail

Provides details about a resource list.

AMI Events ami events
OutboundSubscriptionDetail

Provides details about an outbound subscription - one in which Asterisk sends SUBSCRIBE requests and periodically receiv...

AMI Events ami events
OutboundRegistrationDetail

Provides configuration details and status information about an outbound registration.

AMI Events ami events
InboundSubscriptionDetail

Provides details about an inbound subscription - one in which Asterisk handles SUBSCRIBE requests and periodically sends...

AMI Events ami events
InboundRegistrationDetail

Provide details about the Address of Record (AoR) associated with a registration.

AMI Events ami events
AMI Events
AGIExecEnd AGIExecStart AOC-D AOC-E AOC-S AgentCalled AgentComplete AgentConnect AgentDump AgentLogin AgentLogoff AgentRingNoAnswer Agents AgentsComplete Alarm AlarmClear AorDetail AorList AorListComplete AsyncAGIEnd AsyncAGIExec AsyncAGIStart AttendedTransfer AuthDetail AuthList AuthListComplete AuthMethodNotAllowed BlindTransfer BridgeCreate BridgeDestroy BridgeEnter BridgeInfoChannel BridgeInfoComplete BridgeLeave BridgeMerge BridgeVideoSourceUpdate CEL Cdr ChallengeResponseFailed ChallengeSent ChanSpyStart ChanSpyStop ChannelTalkingStart ChannelTalkingStop ConfbridgeEnd ConfbridgeJoin ConfbridgeLeave ConfbridgeList ConfbridgeListRooms ConfbridgeMute ConfbridgeRecord ConfbridgeStart ConfbridgeStopRecord ConfbridgeTalking ConfbridgeUnmute ContactList ContactListComplete ContactStatus ContactStatusDetail CoreShowChannel CoreShowChannelMapComplete CoreShowChannelsComplete DAHDIChannel DNDState DTMFBegin DTMFEnd DeadlockStart DeviceStateChange DeviceStateListComplete DialBegin DialEnd DialState EndpointDetail EndpointDetailComplete EndpointList EndpointListComplete ExtensionStateListComplete ExtensionStatus FAXSession FAXSessionsComplete FAXSessionsEntry FAXStats FAXStatus FailedACL Flash FullyBooted Hangup HangupHandlerPop HangupHandlerPush HangupHandlerRun HangupRequest Hold IdentifyDetail InboundRegistrationDetail InboundSubscriptionDetail InvalidAccountID InvalidPassword InvalidTransport Load LoadAverageLimit LocalBridge LocalOptimizationBegin LocalOptimizationEnd LogChannel MCID MWIGet MWIGetComplete MeetmeEnd MeetmeJoin MeetmeLeave MeetmeList MeetmeListRooms MeetmeMute MeetmeTalkRequest MeetmeTalking MemoryLimit MessageWaiting MiniVoiceMail MixMonitorMute MixMonitorStart MixMonitorStop MonitorStart MonitorStop MusicOnHoldStart MusicOnHoldStop NewAccountCode NewCallerid NewConnectedLine NewExten Newchannel Newstate OriginateResponse OutboundRegistrationDetail OutboundSubscriptionDetail ParkedCall ParkedCallGiveUp ParkedCallSwap ParkedCallTimeOut PeerStatus Pickup PresenceStateChange PresenceStateListComplete PresenceStatus QueueCallerAbandon QueueCallerJoin QueueCallerLeave QueueEntry QueueMemberAdded QueueMemberPause QueueMemberPenalty QueueMemberRemoved QueueMemberRinginuse QueueMemberStatus QueueParams RTCPReceived RTCPSent ReceiveFAX Registry Reload Rename RequestBadFormat RequestNotAllowed RequestNotSupported ResourceListDetail SIPQualifyPeerDone SendFAX SessionLimit SessionTimeout Shutdown SoftHangupRequest SpanAlarm SpanAlarmClear Status StatusComplete SuccessfulAuth TransportDetail UnParkedCall UnexpectedAddress Unhold Unload UserEvent VarSet VoicemailPasswordChange Wink
AMI Events
AGIExecEnd AGIExecStart AOC-D AOC-E AOC-S AgentCalled AgentComplete AgentConnect AgentDump AgentLogin AgentLogoff AgentRingNoAnswer Agents AgentsComplete Alarm AlarmClear AorDetail AorList AorListComplete AsyncAGIEnd AsyncAGIExec AsyncAGIStart AttendedTransfer AuthDetail AuthList AuthListComplete AuthMethodNotAllowed BlindTransfer BridgeCreate BridgeDestroy BridgeEnter BridgeInfoChannel BridgeInfoComplete BridgeLeave BridgeMerge BridgeVideoSourceUpdate CEL Cdr ChallengeResponseFailed ChallengeSent ChanSpyStart ChanSpyStop ChannelTalkingStart ChannelTalkingStop ConfbridgeEnd ConfbridgeJoin ConfbridgeLeave ConfbridgeList ConfbridgeListRooms ConfbridgeMute ConfbridgeRecord ConfbridgeStart ConfbridgeStopRecord ConfbridgeTalking ConfbridgeUnmute ContactList ContactListComplete ContactStatus ContactStatusDetail CoreShowChannel CoreShowChannelMapComplete CoreShowChannelsComplete DAHDIChannel DNDState DTMFBegin DTMFEnd DeadlockStart DeviceStateChange DeviceStateListComplete DialBegin DialEnd DialState EndpointDetail EndpointDetailComplete EndpointList EndpointListComplete ExtensionStateListComplete ExtensionStatus FAXSession FAXSessionsComplete FAXSessionsEntry FAXStats FAXStatus FailedACL Flash FullyBooted Hangup HangupHandlerPop HangupHandlerPush HangupHandlerRun HangupRequest Hold IdentifyDetail InboundRegistrationDetail InboundSubscriptionDetail InvalidAccountID InvalidPassword InvalidTransport Load LoadAverageLimit LocalBridge LocalOptimizationBegin LocalOptimizationEnd LogChannel MCID MWIGet MWIGetComplete MeetmeEnd MeetmeJoin MeetmeLeave MeetmeList MeetmeListRooms MeetmeMute MeetmeTalkRequest MeetmeTalking MemoryLimit MessageWaiting MiniVoiceMail MixMonitorMute MixMonitorStart MixMonitorStop MonitorStart MonitorStop MusicOnHoldStart MusicOnHoldStop NewAccountCode NewCallerid NewConnectedLine NewExten Newchannel Newstate OriginateResponse OutboundRegistrationDetail OutboundSubscriptionDetail ParkedCall ParkedCallGiveUp ParkedCallSwap ParkedCallTimeOut PeerStatus Pickup PresenceStateChange PresenceStateListComplete PresenceStatus QueueCallerAbandon QueueCallerJoin QueueCallerLeave QueueEntry QueueMemberAdded QueueMemberPause QueueMemberPenalty QueueMemberRemoved QueueMemberRinginuse QueueMemberStatus QueueParams RTCPReceived RTCPSent ReceiveFAX Registry Reload Rename RequestBadFormat RequestNotAllowed RequestNotSupported ResourceListDetail SIPQualifyPeerDone SendFAX SessionLimit SessionTimeout Shutdown SoftHangupRequest SpanAlarm SpanAlarmClear Status StatusComplete SuccessfulAuth TransportDetail UnParkedCall UnexpectedAddress Unhold Unload UserEvent VarSet VoicemailPasswordChange Wink