ContactList

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

Provide details about a contact section.

Last reviewed 2026-04-14

ContactList
Arguments
  • ObjectType - The object's type. This will always be 'contact'.
  • ObjectName - The name of this object.
  • ViaAddr - IP address of the last Via header in REGISTER request. Will only appear in the event if available.
  • ViaPort - Port number of the last Via header in REGISTER request. Will only appear in the event if available.
  • QualifyTimeout - The elapsed time in decimal seconds after which an OPTIONS message is sent before the contact is considered unavailable.
  • CallId - Content of the Call-ID header in REGISTER request. Will only appear in the event if available.
  • RegServer - Asterisk Server name.
  • PruneOnBoot - If true delete the contact on Asterisk restart/boot.
  • Path - The Path header received on the REGISTER.
  • Endpoint - The name of the endpoint associated with this information.
  • AuthenticateQualify - A boolean indicating whether a qualify should be authenticated.
  • Uri - This contact's URI.
  • QualifyFrequency - The interval in seconds at which the contact will be qualified.
  • UserAgent - Content of the User-Agent header in REGISTER request
  • ExpirationTime - Absolute time that this contact is no longer valid after
  • OutboundProxy - The contact's outbound proxy.
  • Status - This contact's status.
    • Reachable
    • Unreachable
    • NonQualified
    • Unknown
  • RoundtripUsec - The round trip time in microseconds.
  • Qualify2xxOnly - A boolean indicating whether to only consider a contact available if the OPTIONS response has a 2xx status code.

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