EndpointDetail¶

Synopsis¶

Provide details about an endpoint section.

Since¶

12.0.0

Syntax¶

    Event: EndpointDetail
    ObjectType: <value>
    ObjectName: <value>
    Context: <value>
    Allow: <value>
    DtmfMode: <value>
    RtpIpv6: <value>
    RtpSymmetric: <value>
    IceSupport: <value>
    UsePtime: <value>
    ForceRport: <value>
    RewriteContact: <value>
    Transport: <value>
    OutboundProxy: <value>
    MohSuggest: <value>
    100rel: <value>
    Timers: <value>
    TimersMinSe: <value>
    TimersSessExpires: <value>
    Auth: <value>
    OutboundAuth: <value>
    Aors: <value>
    MediaAddress: <value>
    IdentifyBy: <value>
    DirectMedia: <value>
    DirectMediaMethod: <value>
    TrustConnectedLine: <value>
    SendConnectedLine: <value>
    ConnectedLineMethod: <value>
    DirectMediaGlareMitigation: <value>
    DisableDirectMediaOnNat: <value>
    Callerid: <value>
    CalleridPrivacy: <value>
    CalleridTag: <value>
    TrustIdInbound: <value>
    TrustIdOutbound: <value>
    SendPai: <value>
    SendRpid: <value>
    SendDiversion: <value>
    Mailboxes: <value>
    AggregateMwi: <value>
    MediaEncryption: <value>
    MediaEncryptionOptimistic: <value>
    UseAvpf: <value>
    ForceAvp: <value>
    MediaUseReceivedTransport: <value>
    OneTouchRecording: <value>
    InbandProgress: <value>
    CallGroup: <value>
    PickupGroup: <value>
    NamedCallGroup: <value>
    NamedPickupGroup: <value>
    DeviceStateBusyAt: <value>
    T38Udptl: <value>
    T38UdptlEc: <value>
    T38UdptlMaxdatagram: <value>
    FaxDetect: <value>
    T38UdptlNat: <value>
    T38UdptlIpv6: <value>
    T38BindUdptlToMediaAddress: <value>
    ToneZone: <value>
    Language: <value>
    RecordOnFeature: <value>
    RecordOffFeature: <value>
    AllowTransfer: <value>
    UserEqPhone: <value>
    MohPassthrough: <value>
    SdpOwner: <value>
    SdpSession: <value>
    TosAudio: <value>
    TosVideo: <value>
    CosAudio: <value>
    CosVideo: <value>
    AllowSubscribe: <value>
    SubMinExpiry: <value>
    FromUser: <value>
    FromDomain: <value>
    MwiFromUser: <value>
    RtpEngine: <value>
    DtlsVerify: <value>
    DtlsRekey: <value>
    DtlsCertFile: <value>
    DtlsPrivateKey: <value>
    DtlsCipher: <value>
    DtlsCaFile: <value>
    DtlsCaPath: <value>
    DtlsSetup: <value>
    SrtpTag32: <value>
    RedirectMethod: <value>
    SetVar: <value>
    MessageContext: <value>
    Accountcode: <value>
    PreferredCodecOnly: <value>
    DeviceState: <value>
    ActiveChannels: <value>
    SubscribeContext: <value>
    AllowOverlap: <value>
    OverlapContext: <value>
    AcceptMultipleSdpAnswers: <value>
    Acl: <value>
    AllowUnauthenticatedOptions: <value>
    AsymmetricRtpCodec: <value>
    BindRtpToMediaAddress: <value>
    Bundle: <value>
    CodecPrefsIncomingAnswer: <value>
    CodecPrefsIncomingOffer: <value>
    CodecPrefsOutgoingAnswer: <value>
    CodecPrefsOutgoingOffer: <value>
    ContactAcl: <value>
    DtlsAutoGenerateCert: <value>
    DtlsFingerprint: <value>
    FaxDetectTimeout: <value>
    FollowEarlyMediaFork: <value>
    G726NonStandard: <value>
    GeolocIncomingCallProfile: <value>
    GeolocOutgoingCallProfile: <value>
    Ignore183WithoutSdp: <value>
    IncomingCallOfferPref: <value>
    IncomingMwiMailbox: <value>
    MaxAudioStreams: <value>
    MaxVideoStreams: <value>
    MwiSubscribeReplacesUnsolicited: <value>
    NotifyEarlyInuseRinging: <value>
    OutgoingCallOfferPref: <value>
    ReferBlindProgress: <value>
    RpidImmediate: <value>
    RtcpMux: <value>
    RtpKeepalive: <value>
    RtpTimeout: <value>
    RtpTimeoutHold: <value>
    SecurityNegotiation: <value>
    SendAoc: <value>
    SendHistoryInfo: <value>
    StirShaken: <value>
    StirShakenProfile: <value>
    SuppressMohOnSendonly: <value>
    SuppressQ850ReasonHeaders: <value>
    Tenantid: <value>
    VoicemailExtension: <value>
    Webrtc: <value>

Arguments¶

• ObjectType - The object's type. This will always be 'endpoint'.
  

• ObjectName - The name of this object.
  

• Context - Dialplan context for inbound sessions
  

• Allow - Media Codec(s) to allow
  

• DtmfMode - DTMF mode
  

• RtpIpv6 - Allow use of IPv6 for RTP traffic
  

• RtpSymmetric - Enforce that RTP must be symmetric
  

• IceSupport - Enable the ICE mechanism to help traverse NAT
  

• UsePtime - Use Endpoint's requested packetization interval
  

• ForceRport - Force use of return port
  

• RewriteContact - Allow Contact header to be rewritten with the source IP address-port
  

• Transport - Explicit transport configuration to use
  

• OutboundProxy - Full SIP URI of the outbound proxy used to send requests
  

• MohSuggest - Default Music On Hold class
  

• 100rel - Allow support for RFC3262 provisional ACK tags
  

• Timers - Session timers for SIP packets
  

• TimersMinSe - Minimum session timers expiration period
  

• TimersSessExpires - Maximum session timer expiration period
  

• Auth - Authentication Object(s) associated with the endpoint
  

• OutboundAuth - Authentication object(s) used for outbound requests
  

• Aors - AoR(s) to be used with the endpoint
  

• MediaAddress - IP address used in SDP for media handling
  

• IdentifyBy - Way(s) for the endpoint to be identified
  

• DirectMedia - Determines whether media may flow directly between endpoints.
  

• DirectMediaMethod - Direct Media method type
  

• TrustConnectedLine - Accept Connected Line updates from this endpoint
  

• SendConnectedLine - Send Connected Line updates to this endpoint
  

• ConnectedLineMethod - Connected line method type
  

• DirectMediaGlareMitigation - Mitigation of direct media (re)INVITE glare
  

• DisableDirectMediaOnNat - Disable direct media session refreshes when NAT obstructs the media session
  

• Callerid - CallerID information for the endpoint
  

• CalleridPrivacy - Default privacy level
  

• CalleridTag - Internal id_tag for the endpoint
  

• TrustIdInbound - Accept identification information received from this endpoint
  

• TrustIdOutbound - Send private identification details to the endpoint.
  

• SendPai - Send the P-Asserted-Identity header
  

• SendRpid - Send the Remote-Party-ID header
  

• SendDiversion - Send the Diversion header, conveying the diversion information to the called user agent
  

• Mailboxes - NOTIFY the endpoint when state changes for any of the specified mailboxes
  

• AggregateMwi - Condense MWI notifications into a single NOTIFY.
  

• MediaEncryption - Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.
  

• MediaEncryptionOptimistic - Determines whether encryption should be used if possible but does not terminate the session if not achieved.
  

• UseAvpf - Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.
  

• ForceAvp - Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.
  

• MediaUseReceivedTransport - Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.
  

• OneTouchRecording - Determines whether one-touch recording is allowed for this endpoint.
  

• InbandProgress - Determines whether chan_pjsip will indicate ringing using inband progress.
  

• CallGroup - The numeric pickup groups for a channel.
  

• PickupGroup - The numeric pickup groups that a channel can pickup.
  

• NamedCallGroup - The named pickup groups for a channel.
  

• NamedPickupGroup - The named pickup groups that a channel can pickup.
  

• DeviceStateBusyAt - The number of in-use channels which will cause busy to be returned as device state
  

• T38Udptl - Whether T.38 UDPTL support is enabled or not
  

• T38UdptlEc - T.38 UDPTL error correction method
  

• T38UdptlMaxdatagram - T.38 UDPTL maximum datagram size
  

• FaxDetect - Whether CNG tone detection is enabled
  

• T38UdptlNat - Whether NAT support is enabled on UDPTL sessions
  

• T38UdptlIpv6 - Whether IPv6 is used for UDPTL Sessions
  

• T38BindUdptlToMediaAddress - Bind the UDPTL instance to the media_adress
  

• ToneZone - Set which country's indications to use for channels created for this endpoint.
  

• Language - Set the default language to use for channels created for this endpoint.
  

• RecordOnFeature - The feature to enact when one-touch recording is turned on.
  

• RecordOffFeature - The feature to enact when one-touch recording is turned off.
  

• AllowTransfer - Determines whether SIP REFER transfers are allowed for this endpoint
  

• UserEqPhone - Determines whether a user=phone parameter is placed into the request URI if the user is determined to be a phone number
  

• MohPassthrough - Determines whether hold and unhold will be passed through using re-INVITEs with recvonly and sendrecv to the remote side
  

• SdpOwner - String placed as the username portion of an SDP origin (o=) line.
  

• SdpSession - String used for the SDP session (s=) line.
  

• TosAudio - DSCP TOS bits for audio streams
  

• TosVideo - DSCP TOS bits for video streams
  

• CosAudio - Priority for audio streams
  

• CosVideo - Priority for video streams
  

• AllowSubscribe - Determines if endpoint is allowed to initiate subscriptions with Asterisk.
  

• SubMinExpiry - The minimum allowed expiry time for subscriptions initiated by the endpoint.
  

• FromUser - Username to use in From header for requests to this endpoint.
  

• FromDomain - Domain to use in From header for requests to this endpoint.
  

• MwiFromUser - Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.
  

• RtpEngine - Name of the RTP engine to use for channels created for this endpoint
  

• DtlsVerify - Verify that the provided peer certificate is valid
  

• DtlsRekey - Interval at which to renegotiate the TLS session and rekey the SRTP session
  

• DtlsCertFile - Path to certificate file to present to peer
  

• DtlsPrivateKey - Path to private key for certificate file
  

• DtlsCipher - Cipher to use for DTLS negotiation
  

• DtlsCaFile - Path to certificate authority certificate
  

• DtlsCaPath - Path to a directory containing certificate authority certificates
  

• DtlsSetup - Whether we are willing to accept connections, connect to the other party, or both.
  

• SrtpTag32 - Determines whether 32 byte tags should be used instead of 80 byte tags.
  

• RedirectMethod - How redirects received from an endpoint are handled
  

• SetVar - Variable set on a channel involving the endpoint.
  

• MessageContext - Context to route incoming MESSAGE requests to.
  

• Accountcode - An accountcode to set automatically on any channels created for this endpoint.
  

• PreferredCodecOnly - Respond to a SIP invite with the single most preferred codec (DEPRECATED)
  

• DeviceState - The aggregate device state for this endpoint.
  

• ActiveChannels - The number of active channels associated with this endpoint.
  

• SubscribeContext - Context for incoming MESSAGE requests.
  

• AllowOverlap - Enable RFC3578 overlap dialing support.
  

• OverlapContext - Dialplan context to use for RFC3578 overlap dialing.
  

• AcceptMultipleSdpAnswers - Accept multiple SDP answers on non-100rel responses
  

• Acl - List of IP ACL section names in acl.conf
  

• AllowUnauthenticatedOptions - Skip authentication when receiving OPTIONS requests
  

• AsymmetricRtpCodec - Allow the sending and receiving RTP codec to differ
  

• BindRtpToMediaAddress - Bind the RTP instance to the media_address
  

• Bundle - Enable RTP bundling
  

• CodecPrefsIncomingAnswer - Codec negotiation prefs for incoming answers.
  

• CodecPrefsIncomingOffer - Codec negotiation prefs for incoming offers.
  

• CodecPrefsOutgoingAnswer - Codec negotiation prefs for outgoing answers.
  

• CodecPrefsOutgoingOffer - Codec negotiation prefs for outgoing offers.
  

• ContactAcl - List of Contact ACL section names in acl.conf
  

• DtlsAutoGenerateCert - Whether or not to automatically generate an ephemeral X.509 certificate
  

• DtlsFingerprint - Type of hash to use for the DTLS fingerprint in the SDP.
  

• FaxDetectTimeout - How long into a call before fax_detect is disabled for the call
  

• FollowEarlyMediaFork - Follow SDP forked media when To tag is different
  

• G726NonStandard - Force g.726 to use AAL2 packing order when negotiating g.726 audio
  

• GeolocIncomingCallProfile - Geolocation profile to apply to incoming calls
  

• GeolocOutgoingCallProfile - Geolocation profile to apply to outgoing calls
  

• Ignore183WithoutSdp - Do not forward 183 when it doesn't contain SDP
  

• IncomingCallOfferPref - Preferences for selecting codecs for an incoming call.
  

• IncomingMwiMailbox - Mailbox name to use when incoming MWI NOTIFYs are received
  

• MaxAudioStreams - The maximum number of allowed audio streams for the endpoint
  

• MaxVideoStreams - The maximum number of allowed video streams for the endpoint
  

• MwiSubscribeReplacesUnsolicited - An MWI subscribe will replace sending unsolicited NOTIFYs
  

• NotifyEarlyInuseRinging - Whether to notifies dialog-info 'early' on InUse&Ringing state
  

• OutgoingCallOfferPref - Preferences for selecting codecs for an outgoing call.
  

• ReferBlindProgress - Whether to notifies all the progress details on blind transfer
  

• RpidImmediate - Immediately send connected line updates on unanswered incoming calls.
  

• RtcpMux - Enable RFC 5761 RTCP multiplexing on the RTP port
  

• RtpKeepalive - Number of seconds between RTP comfort noise keepalive packets.
  

• RtpTimeout - Maximum number of seconds without receiving RTP (while off hold) before terminating call.
  

• RtpTimeoutHold - Maximum number of seconds without receiving RTP (while on hold) before terminating call.
  

• SecurityNegotiation - The kind of security agreement negotiation to use. Currently, only mediasec is supported.
  

• SendAoc - Send Advice-of-Charge messages
  

• SendHistoryInfo - Send the History-Info header, conveying the diversion information to the called and calling user agents
  

• StirShaken - Enable STIR/SHAKEN support on this endpoint
  

• StirShakenProfile - STIR/SHAKEN profile containing additional configuration options
  

• SuppressMohOnSendonly - Suppress playing MOH to party A if party B sends "sendonly" or "inactive" in an SDP
  

• SuppressQ850ReasonHeaders - Suppress Q.850 Reason headers for this endpoint
  

• Tenantid - The tenant ID for this endpoint.
  

• VoicemailExtension - The voicemail extension to send in the NOTIFY Message-Account header
  

• Webrtc - Defaults and enables some options that are relevant to WebRTC
  

Class¶

COMMAND

Generated Version¶

This documentation was generated from Asterisk branch 22 using version GIT