INCONCERT OCC API INTEGRATION
Login to API OCC & API Definition ===========================================================================================================================
Login to API OCC
Dominio :
Usuario :
Password:
Result :
API Definition
API Type :
Result:
VCC (Current VCC Information)
Result:
REPORTS ===========================================================================================================================
Execute
ReportId:
Filter:
{ "utc_offset": 180, "executed_by_user": true, "resultSize": 20, "firstKey": "", "queryFields": { "startDate": "2021-08-01 00:00:00", "endDate": "2021-12-09 23:59:59", "Type": "CHAT" }, "last_handle": null, "pending_fields": [ "VCC" ] }
Result :
BATCHES ===========================================================================================================================
Get HSM for Whatsapp
Type :
Campaign :
Account:
Result :
Create Batch
Type :
Campaign :
Account:
Batch Id :
Address :
Message :
Send async :
Result :
Create Batch whith HSM
Type :
Campaign :
Account:
Batch Id :
Address :
Message :
Result :
Add Address To Batch
Type :
Campaign :
Account:
Batch Id :
Address :
Send async :
Result :
Search Batch
Sate :
Campaign :
Batch Type :
Result :
Get Batch
Campaign :
Account Name:
Batch Id :
Result :
Get Batch Address (Retorna un address especifica del lote NEW)
Campaign :
Account Name:
Batch Id :
Address :
Result :
Get Batch Addresses (Retorna todas o una lista de las address del lote)
Campaign :
Account Name:
Batch Id :
Addresses :
Result :
Search Batch Addresses (Busca el Status de address en el lote)
Campaign :
Account Name:
Batch Id :
Limite de Address :
Numero de Pagina :
Ordenar por :
desc? :
query :
Result :
CAMPAIGNS ===========================================================================================================================
Get Campaigns
Campaign :
Result :
Search Campaigns
Search Criteria :
Result :
Get Campaign Dispositions
Campaign :
Result :
Get Members Campaigns
Campaigns :
Result :
GROUPS ===========================================================================================================================
Get Groups
Permission :
Result :
USERS ===========================================================================================================================
Get User
User :
Result :
Search Users
Search Criteria
UserId:
Status (enable:1 - disable:0):
Application (interaction, supervisor) :
Row Per Page :
Page :
Result :
Get Available Telephony Peers
Result :
Save User
Id :
Pass :
Name :
FirstSurname :
UserGroup :
Campaigns :
DefaultCampaign :
TimeZoneId :
countryCode :
E-mail :
Peer :
Peer Service :
Peer Technology :
Result :
Activate User
Id :
Result :
DeActivate User
Id :
Result :
USERS 'REPORTS' ===========================================================================================================================
Execute
Filter Type:
Users Satates By Campaign
Users Satates By Agent
Users Logged In
Start Date:
End Date:
State:
Todas
Conectado
En Línea No ACD
Disponible
Almuerzo
Ausente
Toilette
Descanso
No disponible
asdfasdf
ttt
uuu
asdfasdf
ttt
uuu
Campaign:
Agent:
Rows Per Page:
(next page):
Return Info Type:
Default
Reports Only Rows
Reports Full Data
POSTED DATA:
Result :
REPOSITORY FILES ===========================================================================================================================
Upload File
Id :
section(default -1):
file :
Result :
Add Content To Repository
Id:
section(default -1):
Name:
content:
contentType:
format:
Result :
Get File
Id(Optional) :
section(default -1):
Result :
Delete File From Repository
Id :
section(default -1):
Result :
Delete Files From Repository
Ids :
Result :
INTERACTIONS ===========================================================================================================================
get Interaction Json
Id :
Result :
GetInteraction MediaList
Id :
Result :
GetInteraction MediaFile
Id :
Id :
Section :
Part :
Result :
Get Composite interaction
Interaction Id :
Result :
ACTIVE (REALTIME) INTERACTIONS DETAIL ===========================================================================================================================
Execute
Rows Per Page:
(next page):
Filter Type:
Call
Facebook
E-mail
Twitter
Chat
Instagram
Whatsapp
Webcontact
Voicemail
Start Date:
End Date:
Interaction State:
ALL
Queued
Waiting
Open
Taken
Wrapup
Campaign:
Return Info Type:
Interactions Ids
Full Interactions Data
Reports Full Data
Reports Only Rows
POSTED DATA:
Result :
ARCHIVE (HISTORY) INTERACTIONS DETAIL ===========================================================================================================================
Execute
Rows Per Page:
(next page):
Filter Type:
Call By Campaign
Call By Agent
Facebook By Campaign
Facebook By Agent
E-mail By Campaign
E-mail By Agent
Twitter By Campaign
Twitter By Agent
Chat By Campaign
Chat By Agent
Instagram By Campaign
Instagram By Agent
Whatsapp By Campaign
Whatsapp By Agent
Webcontact By Campaign
Webcontact By Agent
Voicemail By Campaign
Voicemail By Agent
Start Date:
End Date:
Initiative:
ALL
Inbound
Outbound
Campaign:
Agent:
Return Info Type:
Interactions Ids
Full Interactions Data
Reports Full Data
Reports Only Rows
POSTED DATA:
Result :
INTERACTIONS DETAIL ===========================================================================================================================
Execute
Rows Per Page:
From:
Conversation Type:
Igual
Distinto
ALL
E-mail
CALL
CHAT
FACEBOOK
INSTAGRAM
YOUTUBE
APPSTORE
GOOGLEPLAY
RCS
IM
SMS
WHATSAPP
TWITTER
WEBCONTACT
VOICEMAIL
Start Date:
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Conversation State:
Igual
Distinto
ALL
ABANDONED
FINISHED
QUEUED
LOCKED
TAKEN
TRANSFER QUEUED
WAITING
CANCELED
State Start Date:
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Last Event Start Date:
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Campaign(s):
Una de
Ninguna de
Contiene
No contiene
Agent(s):
Uno de
Ninguno de
Contiene
No contiene
Uno de
Initiative:
Igual
Distinto
ALL
Inbound
Outbound
Accounts:
Una de
Ninguna de
Contiene
No contiene
Una de
Contact ID:
Igual
Distinto
Contact Name:
Contiene
No contiene
Similar a
Contact Address:
Igual
Distinto
Contiene
No contiene
Ticket :
Uno de
Ninguno de
Contiene
No contiene
Attention Level:
Uno de
Ninguno de
Texto:
Contiene
No contiene
Similar a
Código de disposición:
Uno de
Ninguno de
Contiene
No contiene
Arbol de Códigos de disposición:
EQUAL
NOT EQUAL
BUSINESS DATA
Field Type 1:
Numeric
Date
Text
Boolean
Field Name 1:
Operator 1:
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Field Value 1:
Field Value 1 (TO):
Field Type 2:
Numeric
Date
Text
Boolean
Field Name 2:
Operator 1:
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Field Value 2:
Field Value 2 (TO):
Duracion(seg):
Igual
Distinto
Mayor
Menor
Mayor o Igual
Menor o Igual
Entre 2 valores
Id de interacción:
Uno de
Ninguno de
POSTED DATA:
Result :
START INTERACTION ===========================================================================================================================
Start WebContact
Campaign :
Account :
ContactName :
Result :
Start E-mail
Campaign:
Account:
From Email:
From Name:
CC:
Subject:
Body:
files:
#
Name
Result:
Start Whatsapp
Campaign:
Account:
Name:
Address:
Text:
This is a Whatsapp interaction started from inConcert API
files:
#
Name
Result:
Get Channels and States and Available Agents ===========================================================================================================================
Channels
Result :
States
Result :
Available Agents
Vcc:
Campaign:
Channel(Optional) :
Id Attention Level(Optional) :
Result :
Get Export Info (Users - Groups) ===========================================================================================================================
Export Info Users
Result :
Export Info Groups
Result :
OUTBOUND ENGINE PROCESS ===========================================================================================================================
Get Process
Process :
Result :
Start Process
Process :
Result :
Stop Process
Process :
Result :
OUTBOUND ENGINE BATCH ===========================================================================================================================
Batch Action Status
Process :
Action Id :
Result :
Create Batch
Process :
Batch Name :
Start Date :
End Date :
Batch Priority :
Priority :
Percentage :
Conditions Json :
Result :
Update Batch
Process :
Batch Id :
Start Date :
End Date :
Batch Priority :
Priority :
Percentage :
Result :
Destroy Batch
Process :
Batch Id :
Result :
Add Contacts
Process :
Batch Id :
Conditions Json :
Result :
Pause Contacts
Process :
Conditions Json :
Result :
Resume Contacts
Process :
Conditions Json :
Result :
Cancel Contacts
Process :
Conditions Json :
Result :
Finish Contacts
Process :
Conditions Json :
Result :
Remove Contacts
Process :
Conditions Json :
Result :
Recycle Contacts
Process :
Conditions Json :
Result :
Schedule Contacts
Process :
Date :
Conditions Json :
Result :
ChangePriority Contacts
Process :
Priority :
Conditions Json :
Result :
Set Progressive Contacts
Process :
Conditions Json :
Result :
Set Contacts Agent
Process :
Agent :
Conditions Json :
Result :
Get Action Status
Process :
Action Id :
Result :
OUTBOUND ENGINE CONTACT ===========================================================================================================================
Get Contact
Contact Id :
Result :
Get Contact by Name
Name :
Result :
Get Contact by Address
Type :
Address :
Result :
List Contacts
Contact Ids (comma separated) :
Result :
Search Contacts
Conditions Json :
Result :
Summary Contacts
Conditions Json :
Result :
Store Contact
Contact Json :
Result :
Set Contact Addresses
Contact Id :
Addresses :
Result :
Set Contact Values
Contact Id :
Values :
Result :
Set Contact Skills
Contact Id :
Skills :
Result :
Remove Contact Address
Contact Id :
Type :
Address :
Result :
Enable Contact Address
Contact Id :
Type :
Address :
Result :
Disable Contact Address
Contact Id :
Type :
Address :
Result :
Reschedule Contact
Process :
Process :
Contact :
Date :
Result :
Get Contact Results
Process :
Process :
Contact :
Result :
Validate Address
Type :
Number :
Country :
Area :
Result :