INCONCERT OCC AGENT 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 :
Enable Automatic Poller
Result :
Disabled Automatic Poller
Result :
Fire Poller
Sync :
Force :
return Data :
Result :
Fire Chat Poller
Sync :
Force :
return Data :
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 :
INTERACTION EVENTS ======================================================================================================================================================
Disable Events
Event Id :
Result :
Set interaction Id
Id :
Result :
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 :
On New Interaction Messages (NewInteractionMessages)
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 :
INTERACTION ACTIONS ======================================================================================================================================================
Take Next Queued
Type :
Campaign :
Result :
Take Queued
Id :
Result :
Requeue
Id :
Result :
Archive
Id :
Overwrite Contact Name:
Contact ID :
Disposition :
Disposition Tree Path (an array) :
Date (ISO):
Same agent :
Alternate phone :
Comment :
Result :
Reopen
Id :
Result :
Cancel
Id :
Result :
Comment
Id :
Comment :
Result :
SearchTicket
Ticket :
Result :
Emit Interaction Ticket
Id :
Result :
Update Interaction Labels
Id :
Added labels (array) :
Removed labels (array) :
Result :
Read events
Id :
Events (array) :
Result :
Unread events
Id :
Events (array) :
Result :
Get members to transfer
Id :
Result :
Get campaigns to transfer
Id :
Result :
Get attention levels to transfer
Id :
Result :
Transfer Interaction To Member
Id :
Member :
Result :
Transfer Interaction To Campaign
Id :
Campaign :
Account :
Result :
Transfer Interaction To Attention Level
Id :
Attention Level :
Result :
INTERACTION MESSAGES ======================================================================================================================================================
Create Outgoing Interaction
Type :
Campaign :
Account :
Address :
Address Type :
Empty
Phone
Mail
Facebook
Twitter
ContactId :
Is external or system id :
Message Text :
Autosend :
Result :
Create Outgoing Interaction MAIL
Type :
Campaign :
Account :
Address :
Address Type :
Empty
Phone
Mail
Facebook
Twitter
ContactId :
Is external or system id :
Subject Text :
Body Text :
Autosend :
Result :
Open Client
Id :
Result :
Send Text Message
Id :
Message Text :
Autosend :
Reopen if closed :
Result :
Send Attachment Message
Id :
Type :
image
video
audio
file
Attachment :
Message Text :
Autosend :
Result :
Send Shared File Message
Id :
Type :
image
video
audio
file
File Name :
Message Text :
Autosend :
Result :
Search Shared Files
Type :
Name :
Extension :
Max Size (bytes) :
Result :
Send Message To Address
Type :
Campaign :
Account :
Address :
Address Type :
Empty
Phone
Mail
Facebook
Twitter
Create if not found :
ContactId (if not found interaction) :
Is external or system id (if not found interaction) :
Message Text :
Autosend :
Result :
Send Message To Contact
Type :
Campaign :
Account :
ContactId :
Is external or system id :
Create if not found :
Address (if not found interaction) :
Address Type (if not found interaction) :
Empty
Phone
Mail
Facebook
Twitter
Message Text :
Autosend :
Result :
CHAT METHODS ======================================================================================================================================================
Hangup Chat
Id :
Result :
Get Chat Interaction Messages
Id :
Result :
Get Chat Browsing History
Id :
Result :
Set Interaction Finalization Message
Id :
Address :
Send :
Result :
TWITTER METHODS ======================================================================================================================================================
Send Twitter Private Message To Interaction
Id :
Message :
Autosend :
Reopen if closed :
Event index :
Result :
Send Twitter Tweet Reply Message To Interaction
Id :
Message :
Autosend :
Reopen if closed :
Event index :
Result :
Retweet Twitter Message
Id :
Message :
Autosend :
Reopen if closed :
Event index :
Result :
Like Twitter Message
Id :
Reopen if closed :
Event index :
Result :
Unlike Twitter Message
Id :
Reopen if closed :
Event index :
Result :
FACEBOOK METHODS ======================================================================================================================================================
Send Facebook Comment Reply Message To Interaction
Id :
Message :
Autosend :
Reopen if closed :
Event index :
Result :
Send Facebook Private Reply Message To Interaction
Id :
Message :
Autosend :
Reopen if closed :
Event index :
Result :
Like Facebook Message
Id :
Reopen if closed :
Event index :
Result :
Unlike Facebook Message
Id :
Reopen if closed :
Event index :
Result :
MAIL METHODS ======================================================================================================================================================
Reply Mail
Id :
Body :
To :
CC :
BCC :
Autosend :
Reopen if closed :
Event index :
Result :
Attachment :
Reply Mail With Attachment
Id :
Body :
To :
CC :
BCC :
Autosend :
Reopen if closed :
Event index :
Result :
Reply All Mail
Id :
Body :
To :
CC :
BCC :
Autosend :
Reopen if closed :
Event index :
Result :
Forward Mail
Id :
Body :
To :
CC :
BCC :
Autosend :
Reopen if closed :
Event index :
Result :
Print E-mail
Id :
Reopen if closed :
Event index :
Result :
WHATSAPP INTERACTION ACTIONS =====================================================================================================================================================
Forward Interaction Messages
Id :
Address :
Events (array) :
Result :
Get HSM for Campaign (GetAccountTemplateMessageOptions)
Campaign :
Account :
Result :
Get HSM for Interaction (GetInteractionTemplateMessageOptions)
Id :
Result :
Send Message from HSM
Type :
Campaign :
Account :
Address :
Address Type :
ContactId :
Autosend :
Request.group :
Request.Id :
Request.Language :
Request.HeaderParameter :
Request.Parameter :
Request.Buttons_Quick_Reply :
Result :
PHONE EVENTS ======================================================================================================================================================
Call Taken
Result :
Call On Recording
Result :
Call On Hold
Result :
Call On Mute
Result :
Call On Switch
Result :
Call On Preview
Result :
Call Redialing
Result :
Call Redial Accepted
Result :
Call Redial Canceled
Result :
Call Transferring
Result :
Call Transfer Connected
Result :
Call On Conference
Result :
Call Conference Consultation Trying
Result :
Call Conference Consultation Connected
Result :
PHONE ======================================================================================================================================================
Get Phone State
Result :
Answer Phone Call
Id :
Result :
Hangup Phone Call
Id :
Result :
Hold Phone Call
Id :
Result :
Unhold Phone Call
Id :
Result :
Mute Phone Call
Id :
Result :
Unmute Phone Call
Id :
Result :
Switch Phone Call
Id :
Result :
Unswitch Phone Call
Id :
Result :
Record Phone Call
Id :
Result :
Stop Record Phone Call
Id :
Result :
Accept Preview Phone Call
Id :
Result :
Cancel Preview 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 :
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 :
Redial Phone Call
Id :
Result :
Send Digits Phone Call
Id :
Digits :
Result :
Schedule Interaction
Id :
Date :
Number :
Override Number :
Result :
OUTBOUND ENGINE =====================================================================================================================================================
Get Contact
Interaction Id :
Contact Id :
Result :
Get Contact By Name
Name :
Result :
Get Contact By Address
Address Type :
Address :
Result :
Search Contacts
Conditions Json :
Result :
Store Contact
Interaction Id :
Contact Id :
Contact Json :
Result :
Set Contact Addresses
Interaction Id :
Contact Id :
Addresses Json :
Result :
Set Contact Values
Interaction Id :
Contact Id :
Text Values Json :
Result :
Set Contact Skills
Interaction Id :
Contact Id :
Skills Json :
Result :
Remove Contact Address
Interaction Id :
Contact Id :
Address Type :
Address :
Result :
Enable Contact Address
Interaction Id :
Contact Id :
Address Type :
Address :
Result :
Disable Contact Address
Interaction Id :
Contact Id :
Address Type :
Address :
Result :
Reschedule Contact
Id :
Contact Id :
Process :
Batch :
Date :
Result :
Add Contact to Batch
Id :
Contact Id :
Process :
Batch :
Contact Data :
Result :
Pause Contact
Id :
Contact Id :
Process :
Result :
Resume Contact
Id :
Contact Id :
Process :
Result :
Cancel Contact
Id :
Contact Id :
Process :
Result :
Finish Contact
Id :
Contact Id :
Process :
Result :
Remove Contact
Id :
Contact Id :
Process :
Result :
Recycle Contact
Id :
Contact Id :
Process :
Result :
Change Priority Contact
Id :
Contact Id :
Process :
Priority :
Result :
Set Progressive Contact
Id :
Contact Id :
Process :
Result :
Set Contact Agent
Id :
Contact Id :
Process :
Agent :
Result :
Get Action Status
Action Id :
Process :
Result :
Validate Address
Type :
Number :
Country :
Area :
Result :
CONTACTS ADDRESSES BOOK =====================================================================================================================================================
Get Addresses book
Result :
=====================================================================================================================================================
HELPDESK
=====================================================================================================================================================
Helpdesk - Reload
Ejemplo:
icApi.HelpDeskReloadApps({}, function(result) { console.debug(JSON.stringify(result, null, 2)); });
Result: