AMI Command PJSIPShowEndpoint
cbPJSIPShowEndpoint(["Response: Success", "EventList: start",…])
[0 … 99]
0: "Response: Success"
1: "EventList: start"
2: "Message: Following are Events for each object associated with the Endpoint"
3: ""
4: "Event: EndpointDetail"
5: "ObjectType: endpoint"
6: "ObjectName: 224"
7: "RpidImmediate: false"
8: "Webrtc: no"
9: "DeviceStateBusyAt: 0"
10: "T38UdptlMaxdatagram: 0"
11: "DtlsRekey: 0"
12: "NamedPickupGroup: 1"
13: "DirectMediaMethod: invite"
14: "SendRpid: false"
15: "PickupGroup: "
16: "SdpSession: Asterisk"
17: "DtlsVerify: No"
18: "MessageContext: "
19: "Mailboxes: 224@device"
20: "RecordOnFeature: apprecord"
21: "DtlsPrivateKey: "
22: "DtlsFingerprint: SHA-256"
23: "FromDomain: "
24: "TimersSessExpires: 1800"
25: "NamedCallGroup: 1"
26: "DtlsCipher: "
27: "MediaEncryptionOptimistic: false"
28: "SuppressQ850ReasonHeaders: false"
29: "Aors: 224"
30: "IdentifyBy: username,ip"
31: "CalleridPrivacy: allowed_not_screened"
32: "MwiSubscribeReplacesUnsolicited: yes"
33: "CosAudio: 5"
34: "FollowEarlyMediaFork: true"
35: "Context: from-internal"
36: "RtpSymmetric: true"
37: "Transport: 0.0.0.0-udp"
38: "MohSuggest: default"
39: "T38Udptl: false"
40: "FaxDetect: false"
41: "TosVideo: 136"
42: "SrtpTag32: false"
43: "ReferBlindProgress: true"
44: "MaxAudioStreams: 1"
45: "Bundle: false"
46: "UseAvpf: false"
47: "CallGroup: "
48: "FaxDetectTimeout: 0"
49: "SdpOwner: -"
50: "ForceRport: false"
51: "CalleridTag: "
52: "RtpTimeoutHold: 0"
53: "UsePtime: false"
54: "MediaAddress: "
55: "VoicemailExtension: "
56: "RtpTimeout: 0"
57: "SetVar: "
58: "ContactAcl: "
59: "PreferredCodecOnly: false"
60: "ForceAvp: false"
61: "RecordOffFeature: apprecord"
62: "FromUser: "
63: "SendDiversion: true"
64: "T38UdptlIpv6: false"
65: "ToneZone: "
66: "Language: ru"
67: "AllowSubscribe: true"
68: "RtpIpv6: false"
69: "Callerid: "Оператор Call-центра" <224>"
70: "MohPassthrough: false"
71: "CosVideo: 4"
72: "DtlsAutoGenerateCert: No"
73: "AsymmetricRtpCodec: false"
74: "IceSupport: false"
75: "AggregateMwi: true"
76: "OneTouchRecording: true"
77: "MwiFromUser: "
78: "Accountcode: "
79: "Allow: (ulaw|alaw|gsm|g726|g722)"
80: "RewriteContact: true"
81: "UserEqPhone: false"
82: "RtpEngine: asterisk"
83: "SubscribeContext: "
84: "NotifyEarlyInuseRinging: false"
85: "IncomingMwiMailbox: "
86: "Auth: 224-auth"
87: "DirectMediaGlareMitigation: none"
88: "TrustIdInbound: true"
89: "BindRtpToMediaAddress: false"
90: "DisableDirectMediaOnNat: false"
91: "MediaEncryption: no"
92: "MediaUseReceivedTransport: false"
93: "AllowOverlap: true"
94: "DtmfMode: rfc4733"
95: "OutboundAuth: "
96: "TosAudio: 184"
97: "DtlsCertFile: "
98: "DtlsCaPath: "
99: "DtlsSetup: active"
[100 … 199]
100: "ConnectedLineMethod: invite"
101: "G726NonStandard: false"
102: "100rel: yes"
103: "Timers: yes"
104: "DirectMedia: true"
105: "Acl: "
106: "TimersMinSe: 90"
107: "TrustIdOutbound: false"
108: "SubMinExpiry: 0"
109: "RtcpMux: false"
110: "MaxVideoStreams: 1"
111: "AcceptMultipleSdpAnswers: false"
112: "SendPai: true"
113: "RtpKeepalive: 0"
114: "T38UdptlEc: none"
115: "T38UdptlNat: false"
116: "AllowTransfer: true"
117: "DtlsCaFile: "
118: "OutboundProxy: "
119: "InbandProgress: false"
120: "DeviceState: In use"
121: "ActiveChannels: "
122: ""
123: "Event: AuthDetail"
124: "ObjectType: auth"
125: "ObjectName: 224-auth"
126: "Username: 224"
127: "Md5Cred: "
128: "Realm: "
129: "AuthType: userpass"
130: "Password: pass"
131: "NonceLifetime: 32"
132: "EndpointName: 224"
133: ""
134: "Event: TransportDetail"
135: "ObjectType: transport"
136: "ObjectName: 0.0.0.0-udp"
137: "WebsocketWriteTimeout: 100"
138: "Cos: 3"
139: "Protocol: udp"
140: "SymmetricTransport: false"
141: "Domain: "
142: "VerifyServer: No"
143: "LocalNet: 192.168.7.0/255.255.255.0,192.168.6.0/255.255.255.0,192.168.0.0/255.255.255.0,10.0.60.0/255.255.255.0,192.168.0.0/255.255.0.0"
144: "Bind: 0.0.0.0:5060"
145: "AsyncOperations: 1"
146: "ExternalMediaAddress: 123.123.123.123"
147: "Method: unspecified"
148: "ExternalSignalingAddress: 123.123.123.123"
149: "RequireClientCert: No"
150: "Tos: 96"
151: "CaListPath: "
152: "Cipher: "
153: "CertFile: "
154: "ExternalSignalingPort: 0"
155: "Password: "
156: "AllowReload: true"
157: "VerifyClient: No"
158: "PrivKeyFile: "
159: "CaListFile: "
160: "EndpointName: 224"
161: ""
162: "Event: AorDetail"
163: "ObjectType: aor"
164: "ObjectName: 224"
165: "MinimumExpiration: 60"
166: "DefaultExpiration: 3600"
167: "QualifyTimeout: 3.000000"
168: "Mailboxes: 224@device"
169: "SupportPath: false"
170: "VoicemailExtension: "
171: "MaxContacts: 1"
172: "AuthenticateQualify: false"
173: "Contacts: 224/sip:224@192.168.7.247:5161"
174: "MaximumExpiration: 7200"
175: "QualifyFrequency: 60"
176: "RemoveExisting: true"
177: "OutboundProxy: "
178: "TotalContacts: 1"
179: "ContactsRegistered: 1"
180: "EndpointName: 224"
181: ""
182: "Event: ContactStatusDetail"
183: "AOR: 224"
184: "URI: sip:224@192.168.7.247:5161"
185: "UserAgent: Linksys/SPA8000-6.1.11"
186: "RegExpire: 1547627520"
187: "ViaAddress: 192.168.7.247:5161"
188: "CallID: a6795b82-5386cc07@192.168.8.2"
189: "Status: Reachable"
190: "RoundtripUsec: 11596"
191: "EndpointName: 224"
192: "ID: 224;@d34cd88dee66e24b0b96ee26a8d8f9d6"
193: "AuthenticateQualify: 0"
194: "OutboundProxy: "
195: "Path: "
196: "QualifyFrequency: 60"
197: "QualifyTimeout: 3.000"
198: ""
199: "Event: EndpointDetailComplete"
[200 … 203]
200: "EventList: Complete"
201: "ListItems: 5"
202: ""
203: ""
[Syntax]
Action: PJSIPShowEndpoint
[ActionID:] <value>
Endpoint: <value>
[Synopsis]
Detail listing of an endpoint and its objects.
[Description]
Provides a detailed listing of options for a given endpoint. Events are
issued showing the configuration and status of the endpoint and associated
objects. These events include 'EndpointDetail', 'AorDetail', 'AuthDetail',
'TransportDetail', and 'IdentifyDetail'. Some events may be listed multiple
times if multiple objects are associated (for instance AoRs). Once all detail
events have been raised a final 'EndpointDetailComplete' event is issued.
[Arguments]
ActionID
ActionID for this transaction. Will be returned.
Endpoint
The endpoint to list.
[See Also]
Not available
[Privilege]
system,all
[List Responses]
Event: EndpointDetail
[Synopsis]
Provide details about an endpoint section.
[Syntax]
Event: EndpointDetail
ObjectType: <value>
ObjectName: <value>
Context: <value>
Disallow: <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>
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>
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>
[Arguments]
ObjectType
The object's type. This will always be 'endpoint'.
ObjectName
The name of this object.
Context
Dialplan context for inbound sessions
Disallow
Media Codec(s) to disallow
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
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
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 user 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 rather than
advertising all joint codec capabilities. This limits the other side's
codec choice to exactly what we prefer.
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.
Event: IdentifyDetail
[Synopsis]
Provide details about an identify section.
[Syntax]
Event: IdentifyDetail
ObjectType: <value>
ObjectName: <value>
Endpoint: <value>
SrvLookups: <value>
Match: <value>
MatchHeader: <value>
EndpointName: <value>
[Arguments]
ObjectType
The object's type. This will always be 'identify'.
ObjectName
The name of this object.
Endpoint
Name of endpoint identified
SrvLookups
Perform SRV lookups for provided hostnames.
Match
IP addresses or networks to match against.
MatchHeader
Header/value pair to match against.
EndpointName
The name of the endpoint associated with this information.
Event: ContactStatusDetail
[Synopsis]
Provide details about a contact's status.
[Syntax]
Event: ContactStatusDetail
AOR: <value>
URI: <value>
Status: <value>
RoundtripUsec: <value>
EndpointName: <value>
UserAgent: <value>
RegExpire: <value>
ViaAddress: <value>
CallID: <value>
ID: <value>
AuthenticateQualify: <value>
OutboundProxy: <value>
Path: <value>
QualifyFrequency: <value>
QualifyTimeout: <value>
[Arguments]
AOR
The AoR that owns this contact.
URI
This contact's URI.
Status
This contact's status.
Reachable
Unreachable
RoundtripUsec
The round trip time in microseconds.
EndpointName
The name of the endpoint associated with this information.
UserAgent
Content of the User-Agent header in REGISTER request
RegExpire
Absolute time that this contact is no longer valid after
ViaAddress
IP address:port of the last Via header in REGISTER request. Will only
appear in the event if available.
CallID
Content of the Call-ID header in REGISTER request. Will only appear in the
event if available.
ID
The sorcery ID of the contact.
AuthenticateQualify
A boolean indicating whether a qualify should be authenticated.
OutboundProxy
The contact's outbound proxy.
Path
The Path header received on the REGISTER.
QualifyFrequency
The interval in seconds at which the contact will be qualified.
QualifyTimeout
The elapsed time in decimal seconds after which an OPTIONS message is sent
before the contact is considered unavailable.
Event: AuthDetail
[Synopsis]
Provide details about an authentication section.
[Syntax]
Event: AuthDetail
ObjectType: <value>
ObjectName: <value>
Username: <value>
Password: <value>
Md5Cred: <value>
Realm: <value>
NonceLifetime: <value>
AuthType: <value>
EndpointName: <value>
[Arguments]
ObjectType
The object's type. This will always be 'auth'.
ObjectName
The name of this object.
Username
Username to use for account
Password
Username to use for account
Md5Cred
MD5 Hash used for authentication.
Realm
SIP realm for endpoint
NonceLifetime
Lifetime of a nonce associated with this authentication config.
AuthType
Authentication type
EndpointName
The name of the endpoint associated with this information.
Event: TransportDetail
[Synopsis]
Provide details about an authentication section.
[Syntax]
Event: TransportDetail
ObjectType: <value>
ObjectName: <value>
Protocol: <value>
Bind: <value>
AsycOperations: <value>
CaListFile: <value>
CaListPath: <value>
CertFile: <value>
PrivKeyFile: <value>
Password: <value>
ExternalSignalingAddress: <value>
ExternalSignalingPort: <value>
ExternalMediaAddress: <value>
Domain: <value>
VerifyServer: <value>
VerifyClient: <value>
RequireClientCert: <value>
Method: <value>
Cipher: <value>
LocalNet: <value>
Tos: <value>
Cos: <value>
WebsocketWriteTimeout: <value>
EndpointName: <value>
[Arguments]
ObjectType
The object's type. This will always be 'transport'.
ObjectName
The name of this object.
Protocol
Protocol to use for SIP traffic
Bind
IP Address and optional port to bind to for this transport
AsycOperations
Number of simultaneous Asynchronous Operations
CaListFile
File containing a list of certificates to read (TLS ONLY, not WSS)
CaListPath
Path to directory containing a list of certificates to read (TLS ONLY, not
WSS)
CertFile
Certificate file for endpoint (TLS ONLY, not WSS)
PrivKeyFile
Private key file (TLS ONLY, not WSS)
Password
Password required for transport
ExternalSignalingAddress
External address for SIP signalling
ExternalSignalingPort
External port for SIP signalling
ExternalMediaAddress
External IP address to use in RTP handling
Domain
Domain the transport comes from
VerifyServer
Require verification of server certificate (TLS ONLY, not WSS)
VerifyClient
Require verification of client certificate (TLS ONLY, not WSS)
RequireClientCert
Require client certificate (TLS ONLY, not WSS)
Method
Method of SSL transport (TLS ONLY, not WSS)
Cipher
Preferred cryptography cipher names (TLS ONLY, not WSS)
LocalNet
Network to consider local (used for NAT purposes).
Tos
Enable TOS for the signalling sent over this transport
Cos
Enable COS for the signalling sent over this transport
WebsocketWriteTimeout
The timeout (in milliseconds) to set on WebSocket connections.
EndpointName
The name of the endpoint associated with this information.
Event: AorDetail
[Synopsis]
Provide details about an Address of Record (AoR) section.
[Syntax]
Event: AorDetail
ObjectType: <value>
ObjectName: <value>
MinimumExpiration: <value>
MaximumExpiration: <value>
DefaultExpiration: <value>
QualifyFrequency: <value>
AuthenticateQualify: <value>
MaxContacts: <value>
RemoveExisting: <value>
Mailboxes: <value>
OutboundProxy: <value>
SupportPath: <value>
TotalContacts: <value>
ContactsRegistered: <value>
EndpointName: <value>
[Arguments]
ObjectType
The object's type. This will always be 'aor'.
ObjectName
The name of this object.
MinimumExpiration
Minimum keep alive time for an AoR
MaximumExpiration
Maximum time to keep an AoR
DefaultExpiration
Default expiration time in seconds for contacts that are dynamically bound
to an AoR.
QualifyFrequency
Interval at which to qualify an AoR
AuthenticateQualify
Authenticates a qualify challenge response if needed
MaxContacts
Maximum number of contacts that can bind to an AoR
RemoveExisting
Determines whether new contacts replace existing ones.
Mailboxes
Allow subscriptions for the specified mailbox(es)
OutboundProxy
Outbound proxy used when sending OPTIONS request
SupportPath
Enables Path support for REGISTER requests and Route support for other
requests.
TotalContacts
The total number of contacts associated with this AoR.
ContactsRegistered
The number of non-permanent contacts associated with this AoR.
EndpointName
The name of the endpoint associated with this information.
[Final Response]
Event: EndpointDetailComplete
[Synopsis]
Provide final information about endpoint details.
[Syntax]
Event: EndpointDetailComplete
EventList: <value>
ListItems: <value>