Skip to end of metadata
Go to start of metadata

ContactList

Synopsis

Provide details about a contact section.

Description

Syntax

Event: ContactList
ObjectType: <value>
ObjectName: <value>
ViaAddr: <value>
ViaPort: <value>
QualifyTimeout: <value>
CallId: <value>
RegServer: <value>
PruneOnBoot: <value>
Path: <value>
Endpoint: <value>
AuthenticateQualify: <value>
Uri: <value>
QualifyFrequency: <value>
UserAgent: <value>
ExpirationTime: <value>
OutboundProxy: <value>
Status: <value>
RoundtripUsec: <value>
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.

Class

COMMAND

See Also

Import Version

This documentation was imported from Asterisk Version GIT-16-b8bf57dc38

  • No labels