| Class Summary | |
|---|---|
| webphone | JVoIP SIP Stack public API |
| SIPNotificationListener | SIPNotificationListener interface to receive SIPNotification events You will need to extend this class to receive the SIPNotification events. Example: class MyNotificationListener extends SIPNotificationListener { void onStatus( SIPNotification.Status e) { System.out.println(e.toString()); } } new MyNotificationListener(); See the "Notifications" chapter in the documentation for more details. |
| SIPNotification | The SIPNotification object what you receive in your SIPNotificationListener event handlers or by using the GetNotification API. This is the Outer/Base class for all the other specific SIPNotification objects. See the "Notifications" chapter in the documentation for more details. |
| SIPNotification.Answer | ANSWER notification. Triggered by: API answers Event: SIPNotificationListener.onAnswer Fields: ANSWER,details |
| SIPNotification.BLF | BLF notification. Triggered by: Busy Lamp Field change Event: SIPNotificationListener.onBLF Fields: BLF,peerusername,direction,state,callid |
| SIPNotification.Block | BLOCK notification. Triggered by: message blocked/ignored Event: SIPNotificationListener.onBlock Fields: BLOCK,type,message |
| SIPNotification.CDR | CDR notification. Triggered by: call disconect Event: SIPNotificationListener.onCDR Fields: CDR,line, peername,caller,called,peeraddress,connecttime,duration,discparty,reasontext |
| SIPNotification.Chat | CHAT notification. Triggered by: incoming chat messages Event: SIPNotificationListener.onChat Fields: CHAT,line,peername,text |
| SIPNotification.ChatComposing | CHATCOMPOSING notification. Triggered by: "composing" notifications received from peers Event: SIPNotificationListener.onChatComposing Fields: CHATCOMPOSING,line,peername,status |
| SIPNotification.ChatReport | CHATREPORT notification. Triggered by: IM send state (so you can check if outgoing message sent with the API_SendChat was delivered successfully or failed) Event: SIPNotificationListener.onChatReport Fields: CHATREPORT,line,peername,status,statustext,group,md5,id |
| SIPNotification.Credit | CREDIT notification. Triggered by: balance info received Event: SIPNotificationListener.onCredit Fields: CREDIT,text |
| SIPNotification.DTMF | DTMF notification. Triggered by: incoming DTMF. Event: SIPNotificationListener.onDTMF Fields: DTMF,line,msg |
| SIPNotification.Event | EVENT notification. Triggered by: Important events which should be displayed for the user. Event: SIPNotificationListener.onEvent Fields: LOG,TYPE,txt |
| SIPNotification.Group | GROUP notification. Triggered by: conference calls Event: SIPNotificationListener.onGroup Fields: GROUP,line,peers |
| SIPNotification.INFO | INFO notification. Triggered by: incoming/outgoing INFO or DTMF messages Event: SIPNotificationListener.onINFO Fields: INFO,type,line,peername,text |
| SIPNotification.Line | LINE notification. Triggered by: active line change (the line parameter is the current active line). Event: SIPNotificationListener.onLine Fields: LINE,line |
| SIPNotification.Log | LOG notification. Triggered by: logs (only if you set the "events" parameter to 3 and also depends on the "loglevel") Event: SIPNotificationListener.onLog Fields: LOG,TYPE,txt |
| SIPNotification.MWI | MWI notification. Triggered by: Messages-Waiting indicator Event: SIPNotificationListener.onMWI Fields: MWI,hasvoicemail,voicemailnumber,to,count,message |
| SIPNotification.NewContact | NEWUSER notification. Triggered by: new contact request Event: SIPNotificationListener.onNewContact Fields: NEWUSER,usrname,displayname |
| SIPNotification.PlayReady | PLAYREADY notification. Triggered by: audio streaming finished Event: SIPNotificationListener.onPlayReady Fields: PLAYREADY,line,callid |
| SIPNotification.Popup | POPUP notification. Triggered by: announcements Event: SIPNotificationListener.onPopup Fields: POPUP,txt |
| SIPNotification.Presence | PRESENCE notification. Triggered by: presence changes (peers online status) Event: SIPNotificationListener.onPresence Fields: PRESENCE,peername,state,details,displayname,email |
| SIPNotification.Rating | RATING notification. Triggered by: rating info received on call setup Event: SIPNotificationListener.onRating Fields: RATING,text |
| SIPNotification.Register | REGISTER notification. Triggered by: register state changes from registrar endpoints Event: SIPNotificationListener.onRegister Fields: REGISTER,line,state,text,main,fcm,user,reason |
| SIPNotification.RTPE | RTPE notification. Triggered by: RTP extra header changes Event: SIPNotificationListener.onRTPE Fields: RTPE,line,profile,extension |
| SIPNotification.RTPStat | RTPSTAT notification. Triggered by: media quality reports Event: SIPNotificationListener.onRTPStat Fields: RTPSTAT,quality,sent,rec,issues,loss |
| SIPNotification.RTPT | RTPT notification. Triggered by: ED-137 RTP extra header changes Event: SIPNotificationListener.RTPT Fields: RTPT,line,PTT-Type,SQU,PTT-ID,SCT,VF,extensionwords |
| SIPNotification.ServerContacts | SERVERCONTACTS notification. Triggered by: contact found at voip server Event: SIPNotificationListener.onServerContacts Fields: SERVERCONTACTS,text |
| SIPNotification.ShouldReset | SHOULDRESET notification. Triggered by: reinit required Event: SIPNotificationListener.onShouldReset Fields: SHOULDRESET,reason text |
| SIPNotification.SIP | SIP notification. Triggered by: received/sent SIP signaling messages Event: SIPNotificationListener.onSIP Fields: SIP,direction,address,message |
| SIPNotification.Start | START notification. Triggered by: startup Event: SIPNotificationListener.onStart Fields: START,what |
| SIPNotification.Status | STATUS notification. Triggered by: SIP session state chang, such as Init, Register, CallSetup, CallConnect, CallDisconnect, etc You might receive multiple same or similar notifications for the same call state! Event: SIPNotificationListener.onStatus Fields: STATUS,line,statustext,peername,localname,endpointtype,peerdisplayname,[callid],online,registered,incall,mute,hold,encrypted,video,group, rtpsent,rtprec,rtploss,rtplosspercet,videohold,videosent,videorec,serverstats |
| SIPNotification.Stop | STOP notification. Triggered by: destroy Event: SIPNotificationListener.onStop Fields: STOP,api |
| SIPNotification.USSD | USSD notification. Triggered by: incoming USSD messages or report about success/failure about the outgoing USSD messages sent by API_SendUSSD. Event: SIPNotificationListener.onUSSD Fields: USSD,line,status,text |
| SIPNotification.VAD | VAD notification. Triggered by: voice activity Event: SIPNotificationListener.onVAD Fields: VAD,parameters (VAD,local_vad: ON local_avg: 0 local_max: 0 local_speaking: no remote_vad: ON remote_avg: 0 remote_max: 0 remote_speaking: no) |
| SIPNotification.Video | VIDEO notification. Triggered by: video start/stop events Event: SIPNotificationListener.onVideo Fields: VIDEO,startstop,type,line,reason,ip,port,codec,payload,quality,bw,max_bw,fps,max_fps,width,height,profilelevelid,profile,pixelfmt,level,pm,sprop,srtp_alg,srtp_key,srtp_remotekey,device,fmtp |
| SIPNotification.Vrec | VREC notification. Triggered by: call record state Event: SIPNotificationListener.onVrec Fields: NOTIF,line |