PAMI\Message\Event\EndpointDetailEvent

Extends

• PAMI\Message\Event\EventMessage

public

• get100rel() — Returns key: '100rel'. Allow support for RFC3262 provisional ACK tags
• getAccountcode() — Returns key: 'Accountcode'. An accountcode to set automatically on any channels created for this endpoint.
• getActiveChannels() — Returns key: 'ActiveChannels'. The number of active channels associated with this endpoint.
• getAggregateMwi() — Returns key: 'AggregateMwi'. Condense MWI notifications into a single NOTIFY.
• getAllow() — Returns key: 'Allow'. Media Codec(s) to allow
• getAllowSubscribe() — Returns key: 'AllowSubscribe'. Determines if endpoint is allowed to initiate subscriptions with Asterisk.
• getAllowTransfer() — Returns key: 'AllowTransfer'. Determines whether SIP REFER transfers are allowed for this endpoint
• getAors() — Returns key: 'Aors'. AoR(s) to be used with the endpoint
• getAuth() — Returns key: 'Auth'. Authentication Object(s) associated with the endpoint
• getCallGroup() — Returns key: 'CallGroup'. The numeric pickup groups for a channel.
• getCallerid() — Returns key: 'Callerid'. CallerID information for the endpoint
• getCalleridPrivacy() — Returns key: 'CalleridPrivacy'. Default privacy level
• getCalleridTag() — Returns key: 'CalleridTag'. Internal id_tag for the endpoint
• getConnectedLineMethod() — Returns key: 'ConnectedLineMethod'. Connected line method type
• getContext() — Returns key: 'Context'. Dialplan context for inbound sessions
• getCosAudio() — Returns key: 'CosAudio'. Priority for audio streams
• getCosVideo() — Returns key: 'CosVideo'. Priority for video streams
• getDeviceState() — Returns key: 'DeviceState'. The aggregate device state for this endpoint.
• getDeviceStateBusyAt() — Returns key: 'DeviceStateBusyAt'. The number of in-use channels which will cause busy to be returned as device state
• getDirectMedia() — Returns key: 'DirectMedia'. Determines whether media may flow directly between endpoints.
• getDirectMediaGlareMitigation() — Returns key: 'DirectMediaGlareMitigation'. Mitigation of direct media (re)INVITE glare
• getDirectMediaMethod() — Returns key: 'DirectMediaMethod'. Direct Media method type
• getDisableDirectMediaOnNat() — Returns key: 'DisableDirectMediaOnNat'. Disable direct media session refreshes when NAT obstructs the media session
• getDisallow() — Returns key: 'Disallow'. Media Codec(s) to disallow
• getDtlsCaFile() — Returns key: 'DtlsCaFile'. Path to certificate authority certificate
• getDtlsCaPath() — Returns key: 'DtlsCaPath'. Path to a directory containing certificate authority certificates
• getDtlsCertFile() — Returns key: 'DtlsCertFile'. Path to certificate file to present to peer
• getDtlsCipher() — Returns key: 'DtlsCipher'. Cipher to use for DTLS negotiation
• getDtlsPrivateKey() — Returns key: 'DtlsPrivateKey'. Path to private key for certificate file
• getDtlsRekey() — Returns key: 'DtlsRekey'. Interval at which to renegotiate the TLS session and rekey the SRTP session
• getDtlsSetup() — Returns key: 'DtlsSetup'. Whether we are willing to accept connections, connect to the other party, or both.
• getDtlsVerify() — Returns key: 'DtlsVerify'. Verify that the provided peer certificate is valid
• getDtmfMode() — Returns key: 'DtmfMode'. DTMF mode
• getFaxDetect() — Returns key: 'FaxDetect'. Whether CNG tone detection is enabled
• getForceAvp() — Returns key: 'ForceAvp'. Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.
• getForceRport() — Returns key: 'ForceRport'. Force use of return port
• getFromDomain() — Returns key: 'FromDomain'. Domain to user in From header for requests to this endpoint.
• getFromUser() — Returns key: 'FromUser'. Username to use in From header for requests to this endpoint.
• getIceSupport() — Returns key: 'IceSupport'. Enable the ICE mechanism to help traverse NAT
• getIdentifyBy() — Returns key: 'IdentifyBy'. Way(s) for Endpoint to be identified
• getInbandProgress() — Returns key: 'InbandProgress'. Determines whether chan_pjsip will indicate ringing using inband progress.
• getLanguage() — Returns key: 'Language'. Set the default language to use for channels created for this endpoint.
• getMailboxes() — Returns key: 'Mailboxes'. NOTIFY the endpoint when state changes for any of the specified mailboxes
• getMediaAddress() — Returns key: 'MediaAddress'. IP address used in SDP for media handling
• getMediaEncryption() — Returns key: 'MediaEncryption'. Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.
• getMediaEncryptionOptimistic() — Returns key: 'MediaEncryptionOptimistic'. Determines whether encryption should be used if possible but does not terminate the session if not achieved.
• getMediaUseReceivedTransport() — Returns key: 'MediaUseReceivedTransport'. Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.
• getMessageContext() — Returns key: 'MessageContext'. Context to route incoming MESSAGE requests to.
• getMohSuggest() — Returns key: 'MohSuggest'. Default Music On Hold class
• getMwiFromUser() — Returns key: 'MwiFromUser'. Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.
• getNamedCallGroup() — Returns key: 'NamedCallGroup'. The named pickup groups for a channel.
• getNamedPickupGroup() — Returns key: 'NamedPickupGroup'. The named pickup groups that a channel can pickup.
• getObjectName() — Returns key: 'ObjectName'. The name of this object.
• getObjectType() — Returns key: 'ObjectType'. The object's type. This will always be 'endpoint'.
• getOneTouchRecording() — Returns key: 'OneTouchRecording'. Determines whether one-touch recording is allowed for this endpoint.
• getOutboundAuth() — Returns key: 'OutboundAuth'. Authentication object used for outbound requests
• getOutboundProxy() — Returns key: 'OutboundProxy'. Proxy through which to send requests, a full SIP URI must be provided
• getPickupGroup() — Returns key: 'PickupGroup'. The numeric pickup groups that a channel can pickup.
• getRecordOffFeature() — Returns key: 'RecordOffFeature'. The feature to enact when one-touch recording is turned off.
• getRecordOnFeature() — Returns key: 'RecordOnFeature'. The feature to enact when one-touch recording is turned on.
• getRedirectMethod() — Returns key: 'RedirectMethod'. How redirects received from an endpoint are handled
• getRewriteContact() — Returns key: 'RewriteContact'. Allow Contact header to be rewritten with the source IP address-port
• getRtpEngine() — Returns key: 'RtpEngine'. Name of the RTP engine to use for channels created for this endpoint
• getRtpIpv6() — Returns key: 'RtpIpv6'. Allow use of IPv6 for RTP traffic
• getRtpSymmetric() — Returns key: 'RtpSymmetric'. Enforce that RTP must be symmetric
• getSdpOwner() — Returns key: 'SdpOwner'. String placed as the username portion of an SDP origin (o=) line.
• getSdpSession() — Returns key: 'SdpSession'. String used for the SDP session (s=) line.
• getSendDiversion() — Returns key: 'SendDiversion'. Send the Diversion header, conveying the diversion information to the called user agent
• getSendPai() — Returns key: 'SendPai'. Send the P-Asserted-Identity header
• getSendRpid() — Returns key: 'SendRpid'. Send the Remote-Party-ID header
• getSetVar() — Returns key: 'SetVar'. Variable set on a channel involving the endpoint.
• getSrtpTag32() — Returns key: 'SrtpTag32'. Determines whether 32 byte tags should be used instead of 80 byte tags.
• getSubMinExpiry() — Returns key: 'SubMinExpiry'. The minimum allowed expiry time for subscriptions initiated by the endpoint.
• getT38Udptl() — Returns key: 'T38Udptl'. Whether T.38 UDPTL support is enabled or not
• getT38UdptlEc() — Returns key: 'T38UdptlEc'. T.38 UDPTL error correction method
• getT38UdptlIpv6() — Returns key: 'T38UdptlIpv6'. Whether IPv6 is used for UDPTL Sessions
• getT38UdptlMaxdatagram() — Returns key: 'T38UdptlMaxdatagram'. T.38 UDPTL maximum datagram size
• getT38UdptlNat() — Returns key: 'T38UdptlNat'. Whether NAT support is enabled on UDPTL sessions
• getTimers() — Returns key: 'Timers'. Session timers for SIP packets
• getTimersMinSe() — Returns key: 'TimersMinSe'. Minimum session timers expiration period
• getTimersSessExpires() — Returns key: 'TimersSessExpires'. Maximum session timer expiration period
• getToneZone() — Returns key: 'ToneZone'. Set which country's indications to use for channels created for this endpoint.
• getTosAudio() — Returns key: 'TosAudio'. DSCP TOS bits for audio streams
• getTosVideo() — Returns key: 'TosVideo'. DSCP TOS bits for video streams
• getTransport() — Returns key: 'Transport'. Desired transport configuration
• getTrustIdInbound() — Returns key: 'TrustIdInbound'. Accept identification information received from this endpoint
• getTrustIdOutbound() — Returns key: 'TrustIdOutbound'. Send private identification details to the endpoint.
• getUseAvpf() — Returns key: 'UseAvpf'. Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.
• getUsePtime() — Returns key: 'UsePtime'. Use Endpoint's requested packetisation interval
• getUserEqPhone() — Returns key: 'UserEqPhone'. Determines whether a user=phone parameter is placed into the request URI if the user is determined to be a phone number

Inherited from PAMI\Message\Event\EventMessage

public

• getName() — Returns key 'Event'.

Inherited from PAMI\Message\IncomingMessage

public

• __sleep() — Serialize function.
• getAllChannelVariables() — Returns the channel variables for all reported channels.
• getAllStatusVariables() — Returns the channel variables for all reported channels.
• getChannelVariables() — Returns the channel variables for the given channel.
• getEventList() — Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".
• getRawContent() — Returns the original message content without parsing.
• getStatusVariables() — Returns the channel variables for the given channel.

Inherited from PAMI\Message\Message

public

• getActionID() — Returns key: 'ActionID'.
• getBoolKey() — Returns a key by name.
• getCreatedDate() — Returns created date.
• getKey() — Returns a key by name.
• getKeys() — Returns all keys for this message.
• getVariable() — Returns a variable by name.
• getVariables() — Returns all variabels for this message.
• serialize() — Gives a string representation for this message, ready to be sent to ami.
• setVariable() — Adds a variable to this message.