INCONCERT OCC API INTEGRATION
AGENT API ======================================================================================================================================================
Initialize Agent API
Domain :
Result :
USER EVENTS ======================================================================================================================================================
On User Logged In
Result :
On User Logged Out
Result :
On User State Change
Result :
USER METHODS ======================================================================================================================================================
Login User
Username :
Vcc :
Password :
Iframe :
data :
Result :
Logout User
Result :
Get Logged User
Result :
Get Logged User State
Result :
List User States
Result :
Change User State
State :
Result :
Get Logged User Default Campaign
Result :
INTERACTION EVENTS ======================================================================================================================================================
On New Interaction Assigned (InteractionAssigned)
Result :
On Interaction Removed From Agent (InteractionRemovedFromAgent)
Result :
On Interaction Requeued (InteractionRequeued)
Result :
On Interaction Transferred (InteractionTransferred)
Result :
On Interaction Archived (InteractionArchived)
Result :
On Interaction Canceled (InteractionCanceled)
Result :
On Interaction In Wrapup (InteractionInWrapup)
Result :
PHONE EVENTS ======================================================================================================================================================
Call Taken
Result :
Call On Recording
Result :
Call On Hold
Result :
Call On Mute
Result :
Call On Preview
Result :
Call Redialing
Result :
Call Redial Accepted
Result :
Call Redial Canceled
Result :
Call Transferring (CallTransferring)
Result :
Call Transfer Connected (CallTransferConnected)
Result :
Call On Conference (CallOnConference)
Result :
Call Conference Consultation Trying (CallConferenceConsultationTrying)
Result :
Call Conference Consultation Connected(CallConferenceConsultationConnected)
Result :
Call On Switch
Result :
PHONE ======================================================================================================================================================
Get Phone State
Result :
Answer Phone Call
Id :
Result :
Hangup Phone Call
Id :
Result :
Archive
Id :
Disposition :
Disposition Tree Path (an array) :
Date (ISO):
Same agent :
Alternate phone :
Comment :
Result :
Hold Phone Call
Id :
Result :
Unhold Phone Call
Id :
Result :
Mute Phone Call
Id :
Result :
Unmute Phone Call
Id :
Result :
Record Phone Call
Id :
Result :
Stop Record Phone Call
Id :
Result :
Requeue
Id :
Result :
Create Outgoing Interaction
Type :
Campaign :
Account :
Address :
Address Type :
Empty
Phone
E-mail
Facebook
Twitter
ContactId :
Is external or system id :
Message Text :
Autosend :
Result :
Redial Phone Call
Id :
Result :
Cancel Redial Phone Call
Id :
Result :
Transfer Interaction To Member
Id :
Member :
Result :
Confirm Transfer Phone Call
Id :
Result :
Cancel Transfer Phone Call
Id :
Result :
Transfer Interaction To Number
Id :
Number :
Result :
Confirm Transfer Phone Call
Id :
Result :
Cancel Transfer Phone Call
Id :
Result :
Switch Phone Call
Id :
Result :
Unswitch Phone Call
Id :
Result :
Conference Interaction To Member
Id :
Member :
Result :
Confirm Conference Phone Call
Id :
Result :
Cancel Conferece Phone Call
Id :
Result :
Conference Interaction To Number
Id :
Number :
Result :
Confirm Conference Phone Call
Id :
Result :
Cancel Conference Phone Call
Id :
Result :
Send Digits Phone Call
Id :
Digits :
Result :
Schedule Interaction
Id :
Date :
Number :
Result :
Transfer Interaction To Campaign
Id :
Campaign :
Account :
Result :
Transfer Interaction To Attention Level
Id :
Attention Level :
Result :
INTERACTION ACTIONS ======================================================================================================================================================
Get members to transfer
Id :
Result :
Get campaigns to transfer
Id :
Result :
Get attention levels to transfer
Id :
Result :
CAMPAIGN ======================================================================================================================================================
Get Campaigns
Result :
Get Campaign
Campaign :
Result :
Get Campaign Account
Campaign :
Account :
Result :
Get Campaign Dispositions
Campaign :
Result :
Get Campaign Labels
Campaign :
Result :
CONTACT METHODS ======================================================================================================================================================
Get Contact
Id :
Result :
Get Contact by External Id
Id :
Result :
Get Contact by Address
Address :
Address Type :
Result :
Get Contact Interaction
Id :
Result :
Get Contact Interactions History
Contact Id :
Result :
Get Interaction Contact Interactions History
Interaction Id :
Result :
SEARCH INTERACTIONS ======================================================================================================================================================
Get Top Queued Interactions
Result :
Get Top Queued Interactions in Memory
Result :
Search Assigned Interactions
Type :
Campaign :
Campaign :
Result :
Search Appointment Interactions
Type :
Campaign :
Result :
Search Waiting Interactions
Type :
Campaign :
Account :
Address :
Contact System Id :
Contact External Id :
Contact Name :
Text :
Ticket :
Date From (yyyy-mm-dd) :
Date To (yyyy-mm-dd) :
Exact :
Rows :
Last row number :
Result :
Search Queued Interactions
Type :
Campaign :
Account :
Address :
Contact System Id :
Contact External Id :
Contact Name :
Text :
Ticket :
Date From (yyyy-mm-dd) :
Date To (yyyy-mm-dd) :
Exact :
Rows :
Last row number :
Result :
Search Archived Interactions
Type :
Campaign :
Account :
Address :
Contact System Id :
Contact External Id :
Contact Name :
Text :
Ticket :
Date From (yyyy-mm-dd) :
Date To (yyyy-mm-dd) :
Disposition Code :
Exact :
Rows :
Last row number :
Result :
Search Abandoned Interactions
Type :
Campaign :
Account :
Address :
Contact System Id :
Contact External Id :
Contact Name :
Text :
Ticket :
Date From (yyyy-mm-dd) :
Date To (yyyy-mm-dd) :
Disposition Code :
Exact :
Rows :
Last row number :
Result :
Global Search Interactions
Agent :
State :
Type :
Campaign :
Account :
Address :
Contact System Id :
Contact External Id :
Contact Name :
Text :
Ticket :
Date From (yyyy-mm-dd) :
Date To (yyyy-mm-dd) :
Disposition Code :
Exact :
Rows :
Last row number :
Result :
GET INTERACTION DATA ======================================================================================================================================================
Get Interaction
Id :
Result :
Get Assigned Interaction By Address
Type :
Campaign :
Account :
Address :
Result :
Get Assigned Interaction By Contact
Type :
Campaign :
Account :
Contact Id :
Is external or system id :
Result :
Get Interaction Dispositions
Id :
Result :
Get Interaction Reporting Data Fields
Id :
Scope :
Result :
Get Interaction Reporting Data Field
Id :
Scope :
Field :
Result :
Get Interaction Events
Id :
Result :
Get Interaction Unread Events
Id :
Result :
Get Interaction Records
Id :
Result :