This shows you the differences between two versions of the page.
— |
pom-ng:analyzer:sip [2015/07/09 20:14] (current) 2001:1610:47:2b40:ce3d:82ff:fe1e:6130 created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Analyzer sip ====== | ||
+ | This analyzer listens to SIP packets and reconstruct calls and dialogs from them. | ||
+ | |||
+ | ===== Events ===== | ||
+ | |||
+ | ^ Name ^ Payload associated ^ Description ^ | ||
+ | |sip_call|yes|Begins when a call starts and ends when the call hangs up.| | ||
+ | |sip_call_dial|no|A SIP call is being dialed and not yet ringing.| | ||
+ | |sip_call_ringing|no|A SIP call is ringing.| | ||
+ | |sip_call_connect|no|A SIP call connected (got picked up).| | ||
+ | |sip_call_hangup|no|A SIP call was hanged up.| | ||
+ | |sip_call_dtmf|no|Occurs on DTMF signal (from SIP INFO method).| | ||
+ | |||
+ | |||
+ | ==== Common parameters ==== | ||
+ | |||
+ | Most SIP events have the following common parameters : | ||
+ | |||
+ | ^ Field ^ Type ^ Description ^ | ||
+ | |from_display|string|Display name of the caller.| | ||
+ | |from_uri|string|URI of the caller.| | ||
+ | |to_display|string|Display name of the callee.| | ||
+ | |to_uri|string|URI of the callee.| | ||
+ | |call_id|string|Call-ID of the call.| | ||
+ | |||
+ | |||
+ | ==== sip_call ==== | ||
+ | This event is generated for each call. It begins when an INVITE is sent and ends when a timeout or a BYE is seen. | ||
+ | |||
+ | ^ Field ^ Type ^ Description ^ | ||
+ | |trying_duration|uint32|Duration of the trying state in seconds.| | ||
+ | |ringing_duration|uint32|Duration of the ringing state in seconds.| | ||
+ | |connected_duration|uint32|Duration of the connected state in seconds.| | ||
+ | |||
+ | Additionally the sip_call event has all the common parameters described above. | ||
+ | |||
+ | ==== sip_call_dial ==== | ||
+ | |||
+ | This event is generated when an INVITE is sent. It only has the common parameters described above. | ||
+ | |||
+ | ==== sip_call_ringing ==== | ||
+ | |||
+ | This event is generated when a 180 Ringing event is received. It only has the common parameters described above. | ||
+ | |||
+ | ==== sip_call_connect ===== | ||
+ | |||
+ | This event is generated when a 200 OK event is received. It only has the common parameters described above. | ||
+ | |||
+ | ==== sip_call_hangup ===== | ||
+ | |||
+ | This event is generated when a BYE event is received or when the call timeout occurs. It only has the common parameters described above. | ||
+ | |||
+ | ==== sip_call_dtmf ==== | ||
+ | |||
+ | This event is generated when a INFO packet with content type application/dtmf-relay is received. It has the following parameters : | ||
+ | |||
+ | ^ Field ^ Type ^ Description ^ | ||
+ | |signal|string|The key being pressed.| | ||
+ | |duration|uint16|Duration of the key press in milliseconds.| | ||
+ | |||
+ | ===== Parameters ===== | ||
+ | |||
+ | ^ Name ^ Type ^ Default value ^ Description ^ | ||
+ | |dialog_timeout|uint32|300|Timeout for SIP dialogs.| | ||
+ | |dialog_connected_timeout|uint32|10800|Timeout for dialogs which established a call (UDP only).| |