webphone
Class SIPNotification

java.lang.Object
  extended by webphone.SIPNotification
Direct Known Subclasses:
SIPNotification.Account, SIPNotification.AI, SIPNotification.Answer, SIPNotification.APIResult, SIPNotification.BLF, SIPNotification.Block, SIPNotification.CDR, SIPNotification.Chat, SIPNotification.ChatComposing, SIPNotification.ChatReport, SIPNotification.Credit, SIPNotification.DTMF, SIPNotification.Event, SIPNotification.Group, SIPNotification.INFO, SIPNotification.LicKey, SIPNotification.Line, SIPNotification.Log, SIPNotification.Media, SIPNotification.MWI, SIPNotification.NewContact, SIPNotification.PlayReady, SIPNotification.Popup, SIPNotification.Presence, SIPNotification.Rating, SIPNotification.Register, SIPNotification.RTPE, SIPNotification.RTPStat, SIPNotification.RTPT, SIPNotification.ServerContacts, SIPNotification.ShouldReset, SIPNotification.SIP, SIPNotification.SRS, SIPNotification.Start, SIPNotification.Status, SIPNotification.Stop, SIPNotification.USSD, SIPNotification.VAD, SIPNotification.Video, SIPNotification.Vrec
public class SIPNotification
extends java.lang.Object

The notification 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 notification objects.
See the "Notifications" chapter in the documentation for more details.

Nested Class Summary
static class SIPNotification.Account
          ACCOUNT notification.
Triggered by: account change
Event: SIPNotificationListener.onAccount
Fields: ACCOUNT,line,change,uri,display
static class SIPNotification.AI
          Notifications from AI integration.
Triggered by: AI connection state change
Event: SIPNotificationListener.onAI
Fields: AI,line,callid,status
static class SIPNotification.Answer
          ANSWER notification.
Triggered by: API answers
Event: SIPNotificationListener.onAnswer
Fields: ANSWER,details
static class SIPNotification.APIResult
          API return value notification.
Triggered by: API calls.
Event: SIPNotificationListener.onAPIResult
Fields: USSD,id,function,result
static class SIPNotification.BLF
          BLF notification.
Triggered by: Busy Lamp Field change
Event: SIPNotificationListener.onBLF
Fields: BLF,peerusername,direction,state,callid
static class SIPNotification.Block
          BLOCK notification.
Triggered by: message blocked/ignored
Event: SIPNotificationListener.onBlock
Fields: BLOCK,type,message
static class SIPNotification.CDR
          CDR notification.
Triggered by: call disconect
Event: SIPNotificationListener.onCDR
Fields: CDR,line, peername,caller,called,peeraddress,connecttime,duration,discparty,reasontext
static class SIPNotification.Chat
          CHAT notification.
Triggered by: incoming chat messages
Event: SIPNotificationListener.onChat
Fields: CHAT,line,peername,text
static class SIPNotification.ChatComposing
          CHATCOMPOSING notification.
Triggered by: "composing" notifications received from peers
Event: SIPNotificationListener.onChatComposing
Fields: CHATCOMPOSING,line,peername,status
static class 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
static class SIPNotification.Credit
          CREDIT notification.
Triggered by: balance info received
Event: SIPNotificationListener.onCredit
Fields: CREDIT,text
static class SIPNotification.DTMF
          DTMF notification.
Triggered by: incoming DTMF.
Event: SIPNotificationListener.onDTMF
Fields: DTMF,line,msg
static class SIPNotification.Event
          EVENT notification.
Triggered by: Important events which should be displayed for the user.
Event: SIPNotificationListener.onEvent
Fields: EVENT,EVENT,any text
static class SIPNotification.Group
          GROUP notification.
Triggered by: conference calls
Event: SIPNotificationListener.onGroup
Fields: GROUP,line,peers
static class SIPNotification.INFO
          INFO notification.
Triggered by: incoming/outgoing INFO or DTMF messages
Event: SIPNotificationListener.onINFO
Fields: INFO,type,line,peername,text
static class SIPNotification.LicKey
          LICKEY notification.
Triggered by: licene key request (only if licene key is needed for activation)
Event: SIPNotificationListener.onLicKey
Fields: LICKEY,status
static class SIPNotification.Line
          LINE notification.
Triggered by: active line change (the line parameter is the current active line).
Event: SIPNotificationListener.onLine
Fields: LINE,line
static class 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
static class SIPNotification.Media
          Media notification.
Triggered by: audio/video media packets.
Event: SIPNotificationListener.onMedia
Fields: MEDIA,line,status,text
static class SIPNotification.MWI
          MWI notification.
Triggered by: Messages-Waiting indicator
Event: SIPNotificationListener.onMWI
Fields: MWI,hasvoicemail,voicemailnumber,to,count,message
static class SIPNotification.NewContact
          NEWUSER notification.
Triggered by: new contact request
Event: SIPNotificationListener.onNewContact
Fields: NEWUSER,usrname,displayname
static class SIPNotification.PlayReady
          PLAYREADY notification.
Triggered by: audio streaming finished
Event: SIPNotificationListener.onPlayReady
Fields: PLAYREADY,line,callid
static class SIPNotification.Popup
          POPUP notification.
Triggered by: announcements
Event: SIPNotificationListener.onPopup
Fields: POPUP,txt
static class SIPNotification.Presence
          PRESENCE notification.
Triggered by: presence changes (peers online status)
Event: SIPNotificationListener.onPresence
Fields: PRESENCE,peername,state,details,displayname,email
static class SIPNotification.Rating
          RATING notification.
Triggered by: rating info received on call setup
Event: SIPNotificationListener.onRating
Fields: RATING,text
static class SIPNotification.Register
          REGISTER notification.
Triggered by: register state changes from registrar endpoints
Event: SIPNotificationListener.onRegister
Fields: REGISTER,line,state,text,main,fcm,user,reason
static class SIPNotification.RTPE
          RTPE notification.
Triggered by: RTP extra header changes
Event: SIPNotificationListener.onRTPE
Fields: RTPE,line,profile,extension
static class SIPNotification.RTPStat
          RTPSTAT notification.
Triggered by: media quality reports
Event: SIPNotificationListener.onRTPStat
Fields: RTPSTAT,quality,sent,rec,issues,loss
static class 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
static class SIPNotification.ServerContacts
          SERVERCONTACTS notification.
Triggered by: contact found at voip server
Event: SIPNotificationListener.onServerContacts
Fields: SERVERCONTACTS,text
static class SIPNotification.ShouldReset
          SHOULDRESET notification.
Triggered by: reinit required
Event: SIPNotificationListener.onShouldReset
Fields: SHOULDRESET,reason text
static class SIPNotification.SIP
          SIP notification.
Triggered by: received/sent SIP signaling messages
Event: SIPNotificationListener.onSIP
Fields: SIP,direction,address,message
static class SIPNotification.SRS
          SRS notification.
static class SIPNotification.Start
          START notification.
Triggered by: startup
Event: SIPNotificationListener.onStart
Fields: START,what
static class 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
static class SIPNotification.Stop
          STOP notification.
Triggered by: destroy
Event: SIPNotificationListener.onStop
Fields: STOP,api
static class 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
static class 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)
static class 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
static class SIPNotification.Vrec
          VREC notification.
Triggered by: call record state
Event: SIPNotificationListener.onVrec
Fields: VREC,line,stage,type,path,reason,source
 
Field Summary
static int NOTIFICATION_ACCOUNT
          account change
static int NOTIFICATION_AI
          AI events
static int NOTIFICATION_ALL
          all notifications
static int NOTIFICATION_ANSWER
          answer for previous request
static int NOTIFICATION_APIRESULT
          API call return value
static int NOTIFICATION_BLF
          BLF state changes
static int NOTIFICATION_BLOCK
          message blocked/ignored
static int NOTIFICATION_CDR
          call detail record
static int NOTIFICATION_CHAT
          incoming chat messages
static int NOTIFICATION_CHATCOMPOSING
          is composing notifications
static int NOTIFICATION_CHATREPORT
          Chat transmission status
static int NOTIFICATION_CREDIT
          balance state
static int NOTIFICATION_DTMF
          incoming DTMF
static int NOTIFICATION_EVENT
          important events
static int NOTIFICATION_GROUP
          conference calls people
static int NOTIFICATION_INFO
          incoming/outgoing INFO or DTMF messages
static int NOTIFICATION_INVALID
          invalid notification type
static int NOTIFICATION_LICKEY
          license key messages
static int NOTIFICATION_LINE
          line change
static int NOTIFICATION_LOG
          log or event
static int NOTIFICATION_MEDIA
          local media streaming
static int NOTIFICATION_MWI
          voicemail
static int NOTIFICATION_NEWUSER
          new contact request
static int NOTIFICATION_PLAYREADY
          streaming finished
static int NOTIFICATION_POPUP
          popup message
static int NOTIFICATION_PRESENCE
          presence changes
static int NOTIFICATION_RATING
          call cost
static int NOTIFICATION_REGISTER
          registration state change
static int NOTIFICATION_RTPE
          RTP extra header changes
static int NOTIFICATION_RTPSTAT
          media quality reports
static int NOTIFICATION_RTPT
          ED-137 RTP extra header changes
static int NOTIFICATION_SERVERCONTACTS
          server contacts
static int NOTIFICATION_SHOULDRESET
          restart request
static int NOTIFICATION_SIP
          received/sent SIP signaling messages
static int NOTIFICATION_SRS
          new call on SIPREC Session Recording Server
static int NOTIFICATION_START
          api or sip stack start
static int NOTIFICATION_STATUS
          state change
static int NOTIFICATION_STOP
          api destroy
static int NOTIFICATION_USSD
          USSD messages
static int NOTIFICATION_VAD
          voice activity
static int NOTIFICATION_VIDEO
          video start/stop
static int NOTIFICATION_VREC
          voice record state
 
Method Summary
 int getNotificationType()
          Type of the notification (NOTIFICATION_...
 java.lang.String getNotificationTypeText()
          notification type as string
 java.lang.String toString()
          The whole notification as string (one line with the fields separated by comma)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOTIFICATION_ALL

public static final int NOTIFICATION_ALL
all notifications

See Also:
Constant Field Values

NOTIFICATION_INVALID

public static final int NOTIFICATION_INVALID
invalid notification type

See Also:
Constant Field Values

NOTIFICATION_STATUS

public static final int NOTIFICATION_STATUS
state change

See Also:
Constant Field Values

NOTIFICATION_CDR

public static final int NOTIFICATION_CDR
call detail record

See Also:
Constant Field Values

NOTIFICATION_LOG

public static final int NOTIFICATION_LOG
log or event

See Also:
Constant Field Values

NOTIFICATION_EVENT

public static final int NOTIFICATION_EVENT
important events

See Also:
Constant Field Values

NOTIFICATION_POPUP

public static final int NOTIFICATION_POPUP
popup message

See Also:
Constant Field Values

NOTIFICATION_LINE

public static final int NOTIFICATION_LINE
line change

See Also:
Constant Field Values

NOTIFICATION_REGISTER

public static final int NOTIFICATION_REGISTER
registration state change

See Also:
Constant Field Values

NOTIFICATION_PRESENCE

public static final int NOTIFICATION_PRESENCE
presence changes

See Also:
Constant Field Values

NOTIFICATION_BLF

public static final int NOTIFICATION_BLF
BLF state changes

See Also:
Constant Field Values

NOTIFICATION_DTMF

public static final int NOTIFICATION_DTMF
incoming DTMF

See Also:
Constant Field Values

NOTIFICATION_INFO

public static final int NOTIFICATION_INFO
incoming/outgoing INFO or DTMF messages

See Also:
Constant Field Values

NOTIFICATION_USSD

public static final int NOTIFICATION_USSD
USSD messages

See Also:
Constant Field Values

NOTIFICATION_CHAT

public static final int NOTIFICATION_CHAT
incoming chat messages

See Also:
Constant Field Values

NOTIFICATION_CHATREPORT

public static final int NOTIFICATION_CHATREPORT
Chat transmission status

See Also:
Constant Field Values

NOTIFICATION_CHATCOMPOSING

public static final int NOTIFICATION_CHATCOMPOSING
is composing notifications

See Also:
Constant Field Values

NOTIFICATION_START

public static final int NOTIFICATION_START
api or sip stack start

See Also:
Constant Field Values

NOTIFICATION_STOP

public static final int NOTIFICATION_STOP
api destroy

See Also:
Constant Field Values

NOTIFICATION_SHOULDRESET

public static final int NOTIFICATION_SHOULDRESET
restart request

See Also:
Constant Field Values

NOTIFICATION_GROUP

public static final int NOTIFICATION_GROUP
conference calls people

See Also:
Constant Field Values

NOTIFICATION_VREC

public static final int NOTIFICATION_VREC
voice record state

See Also:
Constant Field Values

NOTIFICATION_PLAYREADY

public static final int NOTIFICATION_PLAYREADY
streaming finished

See Also:
Constant Field Values

NOTIFICATION_SIP

public static final int NOTIFICATION_SIP
received/sent SIP signaling messages

See Also:
Constant Field Values

NOTIFICATION_BLOCK

public static final int NOTIFICATION_BLOCK
message blocked/ignored

See Also:
Constant Field Values

NOTIFICATION_VAD

public static final int NOTIFICATION_VAD
voice activity

See Also:
Constant Field Values

NOTIFICATION_RTPE

public static final int NOTIFICATION_RTPE
RTP extra header changes

See Also:
Constant Field Values

NOTIFICATION_RTPT

public static final int NOTIFICATION_RTPT
ED-137 RTP extra header changes

See Also:
Constant Field Values

NOTIFICATION_RTPSTAT

public static final int NOTIFICATION_RTPSTAT
media quality reports

See Also:
Constant Field Values

NOTIFICATION_CREDIT

public static final int NOTIFICATION_CREDIT
balance state

See Also:
Constant Field Values

NOTIFICATION_RATING

public static final int NOTIFICATION_RATING
call cost

See Also:
Constant Field Values

NOTIFICATION_MWI

public static final int NOTIFICATION_MWI
voicemail

See Also:
Constant Field Values

NOTIFICATION_SERVERCONTACTS

public static final int NOTIFICATION_SERVERCONTACTS
server contacts

See Also:
Constant Field Values

NOTIFICATION_NEWUSER

public static final int NOTIFICATION_NEWUSER
new contact request

See Also:
Constant Field Values

NOTIFICATION_ANSWER

public static final int NOTIFICATION_ANSWER
answer for previous request

See Also:
Constant Field Values

NOTIFICATION_VIDEO

public static final int NOTIFICATION_VIDEO
video start/stop

See Also:
Constant Field Values

NOTIFICATION_SRS

public static final int NOTIFICATION_SRS
new call on SIPREC Session Recording Server

See Also:
Constant Field Values

NOTIFICATION_LICKEY

public static final int NOTIFICATION_LICKEY
license key messages

See Also:
Constant Field Values

NOTIFICATION_APIRESULT

public static final int NOTIFICATION_APIRESULT
API call return value

See Also:
Constant Field Values

NOTIFICATION_ACCOUNT

public static final int NOTIFICATION_ACCOUNT
account change

See Also:
Constant Field Values

NOTIFICATION_MEDIA

public static final int NOTIFICATION_MEDIA
local media streaming

See Also:
Constant Field Values

NOTIFICATION_AI

public static final int NOTIFICATION_AI
AI events

See Also:
Constant Field Values
Method Detail

toString

public java.lang.String toString()
The whole notification as string (one line with the fields separated by comma)

Overrides:
toString in class java.lang.Object

getNotificationType

public int getNotificationType()
Type of the notification (NOTIFICATION_... constant)

getNotificationTypeText

public java.lang.String getNotificationTypeText()
notification type as string