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
- Description
- Login and Authentication
- Generic CTI Events
- Directory And Favorites
- Cti Events
- Sheet
- User Statuses
- User Status Update
- User Config Update
- Phone Status Update
- Phone Events
- Phone Hint Status Events
- Voice Mail Status Update
- Link Status Update
- User Right Profile
- Queue Statistics
- Queue Calls
- Queue Configuration
- Queue List
- Queue Member
- Queue Member List
- Agent State Event
- Agent Error
- Agent Directory
- Agent Configuration
- Agent List
- Agent Listen
- Agent Group List
- Agent Statistics
- Call History
- Callback Events
- Membership Events
- Agent Methods
- Cti Methods
- Phone Methods
- Cti.setData(variables)
- Cti.dial(destination, variables)
- Cti.dialFromMobile(destination, variables)
- Cti.dialFromQueue(destination, queueId, callerId, variables)
- Cti.originate(destination)
- Cti.hangup()
- Cti.answer()
- Cti.hold()
- Cti.directTransfer(destination)
- Cti.attendedTransfer(destination)
- Cti.completeTransfer()
- Cti.cancelTransfer()
- Cti.monitorPause(agentId)
- Cti.monitorUnpause(agentId)
- Cti.getList(objectType)
- Cti.getConferenceRooms()
- Cti.getCurrentCallsPhoneEvents()
- Cti.subscribeToPhoneHints(phoneNumbers)
- Cti.unsubscribeFromAllPhoneHints()
- Cti.setAgentQueue(agentId, queueId, penalty)
- Cti.removeAgentFromQueue(agentId, queueId)
- Cti.subscribeToAgentStats()
- Cti.subscribeToQueueStats()
- Cti.naFwd(destination,state)
- Cti.uncFwd(destination,state)
- Cti.busyFwd(destination,state)
- Callback Commands
- Membership Commands
- Security considerations
- Conferences API
- Conference Events
- Conference Methods
- Cti.conference()
- Cti.conferenceMuteMe(conferenceNumber)
- Cti.conferenceUnmuteMe(conferenceNumber)
- Cti.conferenceMuteAll(conferenceNumber)
- Cti.conferenceUnmuteAll(conferenceNumber)
- Cti.conferenceMute(conferenceNumber, index)
- Cti.conferenceUnmute(conferenceNumber, index)
- Cti.conferenceKick(conferenceNumber, index)
- FlashText API
- WebRTC API
- WebRTC features
- WebRTC on sample page
- xc_webrtc.init(name, ssl, websocketPort, 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.setIceUrls(urls)