Web Socket API¶
The xivo solutions web socket API enables you to integrate enterprise communication functions to your business application. It exposes Cti functions using javascript methods calls and web socket events.
You may add your own handlers for your application to react to telephony / contact center events.
This API is using websockets, and therefore needs a modern browser supporting them (firefox, chrome …)
- Developers Guide
- Generic API
- User API
- Phone API
- Phone Methods
- Cti.setData(variables)
- Cti.dial(destination, variables)
- Cti.dialFromMobile(destination, variables)
- Cti.dialByUsername(username, variables)
- Cti.originate(destination)
- Cti.hangup(uniqueId)
- Cti.answer()
- Cti.hold()
- Cti.directTransfer(destination)
- Cti.attendedTransfer(destination)
- Cti.completeTransfer()
- Cti.cancelTransfer()
- Cti.getCurrentCallsPhoneEvents()
- Cti.naFwd(destination,state)
- Cti.uncFwd(destination,state)
- Cti.busyFwd(destination,state)
- Cti.dnd(state)
- Phone Events
- Phone Hint Status Methods
- Phone Hint Status Events
- Voice Mail Status Events
- Phone Methods
- Agent API
- Login and Authentication
- Security considerations
- Agent Methods
- Cti.loginAgent(agentPhoneNumber, agentId)
- Cti.logoutAgent(agentId)
- Cti.pauseAgent(agentId, reason)
- Cti.unpauseAgent(agentId)
- Cti.listenAgent(agentId)
- Cti.setAgentQueue(agentId, queueId, penalty)
- Cti.removeAgentFromQueue(agentId, queueId)
- Cti.dialFromQueue(destination, queueId, callerId, variables)
- Cti.monitorPause(agentId)
- Cti.monitorUnpause(agentId)
- Cti.subscribeToAgentStats()
- Agent Events
- Callback Methods
- Callback Events
- Queue API
- History API
- Conferences API
- Conference Methods
- Cti.getConferenceRooms()
- Cti.conference()
- Cti.conferenceMuteMe(conferenceNumber)
- Cti.conferenceUnmuteMe(conferenceNumber)
- Cti.conferenceMuteAll(conferenceNumber)
- Cti.conferenceUnmuteAll(conferenceNumber)
- Cti.conferenceMute(conferenceNumber, index)
- Cti.conferenceUnmute(conferenceNumber, index)
- Cti.conferenceDeafen(conferenceNumber, index)
- Cti.conferenceUndeafen(conferenceNumber, index)
- Cti.conferenceKick(conferenceNumber, index)
- Cti.conferenceClose(conferenceNumber)
- Cti.conferenceInvite(conferenceNumber, exten, role, earlyJoin)
- Conference Events
- Conference Methods
- FlashText API
- WebRTC API
- WebRTC features
- WebRTC on sample page
- xc_webrtc.init(name, ssl, websocketPort, token, remoteAudio, ip)
- xc_webrtc.initByLineConfig(lineCfg, name, ssl, websocketPort, token, remoteAudio, ip)
- xc_webrtc.dial(destination, video)
- xc_webrtc.answer()
- xc_webrtc.conference()
- xc_webrtc.hold()
- xc_webrtc.dtmf(key)
- xc_webrt.attendedTransfer(destination)
- xc_webrtc.compeleteTransfer()
- xc_webrtc.setHandler(eventName, handler)
- xc_webrtc.disableICE()
- xc_webrtc.getIceUrls()
- Get sip configuration
- xc_webrtc.setIceUrls(urls)